pong

Documentation

Overview

Package pong contains the implementation of the PingPong service.

The file ping_stub_gen.go is generated with:

$ qiloop stub --idl ping.qi.idl --output ping_stub_gen.go

Index

• func PingPongObject(impl PingPongImplementor) bus.Actor
• type PingPongImplementor
  • func PingPongImpl() PingPongImplementor
• type PingPongProxy
  • func CreatePingPong(session bus.Session, service bus.Service, impl PingPongImplementor) (PingPongProxy, error)
  • func MakePingPong(sess bus.Session, proxy bus.Proxy) PingPongProxy
  • func PingPong(session bus.Session) (PingPongProxy, error)
• type PingPongSignalHelper

Functions

func PingPongObject

func PingPongObject(impl PingPongImplementor) bus.Actor

PingPongObject returns an object using PingPongImplementor

Types

type PingPongImplementor

type PingPongImplementor interface {
	// Activate is called before any other method.
	// It shall be used to initialize the interface.
	// activation provides runtime informations.
	// activation.Terminate() unregisters the object.
	// activation.Session can access other services.
	// helper enables signals and properties updates.
	// Properties must be initialized using helper,
	// during the Activate call.
	Activate(activation bus.Activation, helper PingPongSignalHelper) error
	OnTerminate()
	Hello(a string) (string, error)
	Ping(a string) error
}

PingPongImplementor interface of the service implementation

func PingPongImpl

func PingPongImpl() PingPongImplementor

PingPongImpl returns an implementation of ping pong.

type PingPongProxy

type PingPongProxy interface {
	Hello(a string) (string, error)
	Ping(a string) error
	SubscribePong() (unsubscribe func(), updates chan string, err error)
	// Generic methods shared by all objectsProxy
	bus.ObjectProxy
	// WithContext can be used cancellation and timeout
	WithContext(ctx context.Context) PingPongProxy
}

PingPongProxy represents a proxy object to the service

func CreatePingPong

func CreatePingPong(session bus.Session, service bus.Service, impl PingPongImplementor) (PingPongProxy, error)

CreatePingPong registers a new object to a service and returns a proxy to the newly created object

func MakePingPong

func MakePingPong(sess bus.Session, proxy bus.Proxy) PingPongProxy

MakePingPong returns a specialized proxy.

func PingPong

func PingPong(session bus.Session) (PingPongProxy, error)

PingPong returns a proxy to a remote service

type PingPongSignalHelper

type PingPongSignalHelper interface {
	SignalPong(a string) error
}

PingPongSignalHelper provided to PingPong a companion object