client

Documentation

Overview

Package client

Index

• func NewConfig(name string) (interface{}, error)
• func Register(name string, newConfig ConfigFactoryFunc, newClient FactoryFunc)
• type ConfigFactoryFunc
• type FactoryFunc
• type Interface
  • func NewClient(ctx context.Context, name string, handleCmd types.AgentCmdHandleFunc, ...) (Interface, error)

Functions

func NewConfig

func NewConfig(name string) (interface{}, error)

func Register

func Register(name string, newConfig ConfigFactoryFunc, newClient FactoryFunc)

Types

type ConfigFactoryFunc

type ConfigFactoryFunc func() interface{}

type FactoryFunc

type FactoryFunc func(
	ctx context.Context,
	handleCmd types.AgentCmdHandleFunc,
	cfg interface{},
) (Interface, error)

type Interface

type Interface interface {
	// Context of this client
	Context() context.Context

	// Connect to server/broker
	Connect(dialCtx context.Context) error

	// Start internal logic to get prepared for communicating with aranya
	// usually send online state message
	Start(appCtx context.Context) error

	// PostMsg to aranya
	PostMsg(msg *aranyagopb.Msg) error

	// Close this client
	Close() error

	// MaxPayloadSize of a single message for this client
	MaxPayloadSize() int
}

func NewClient

func NewClient(
	ctx context.Context,
	name string,
	handleCmd types.AgentCmdHandleFunc,
	config interface{},
) (Interface, error)