wakeup

Documentation

Overview

Package wakeup defines interfaces for waking up remote services, likely running on mobile devices (e.g., Android, iOS).

Index

• Variables
• type WakeUpClientMethods
• type WakeUpClientStub
  • func WakeUpClient(name string) WakeUpClientStub
• type WakeUpServerMethods
• type WakeUpServerStub
  • func WakeUpServer(impl WakeUpServerMethods) WakeUpServerStub
• type WakeUpServerStubMethods

Variables

var WakeUpDesc rpc.InterfaceDesc = descWakeUp

WakeUpDesc describes the WakeUp interface.

Types

type WakeUpClientMethods

type WakeUpClientMethods interface {
	// Register returns a rooted name where the service should mount itself
	// in order to be woken up using the provided wakeup token.
	Register(_ *context.T, token string, _ ...rpc.CallOpt) (string, error)
}

WakeUpClientMethods is the client interface containing WakeUp methods.

WakeUp interface defines methods for services that wish to be woken up remotely.

type WakeUpClientStub

type WakeUpClientStub interface {
	WakeUpClientMethods
	rpc.UniversalServiceMethods
}

WakeUpClientStub adds universal methods to WakeUpClientMethods.

func WakeUpClient

func WakeUpClient(name string) WakeUpClientStub

WakeUpClient returns a client stub for WakeUp.

type WakeUpServerMethods

type WakeUpServerMethods interface {
	// Register returns a rooted name where the service should mount itself
	// in order to be woken up using the provided wakeup token.
	Register(_ *context.T, _ rpc.ServerCall, token string) (string, error)
}

WakeUpServerMethods is the interface a server writer implements for WakeUp.

WakeUp interface defines methods for services that wish to be woken up remotely.

type WakeUpServerStub

type WakeUpServerStub interface {
	WakeUpServerStubMethods
	// Describe the WakeUp interfaces.
	Describe__() []rpc.InterfaceDesc
}

WakeUpServerStub adds universal methods to WakeUpServerStubMethods.

func WakeUpServer

func WakeUpServer(impl WakeUpServerMethods) WakeUpServerStub

WakeUpServer returns a server stub for WakeUp. It converts an implementation of WakeUpServerMethods into an object that may be used by rpc.Server.

type WakeUpServerStubMethods

type WakeUpServerStubMethods WakeUpServerMethods

WakeUpServerStubMethods is the server interface containing WakeUp methods, as expected by rpc.Server. There is no difference between this interface and WakeUpServerMethods since there are no streaming methods.