controlprotocol

Documentation

Index

• Constants
• type AsyncHandlerFunc
• type ServerHandler
  • func NewServerHandler(ctx context.Context, port int) (ServerHandler, error)

Constants

const (
	// ServerPort is the port used when initializing the control-protocol server
	ServerPort = 8085
)

Types

type AsyncHandlerFunc

type AsyncHandlerFunc = func(ctx context.Context, commandMessage ctrlservice.AsyncCommandMessage)

AsyncHandlerFunc is an alias that matches the type used in the control-protocol's NewAsyncCommandHandler function

type ServerHandler

type ServerHandler interface {
	Shutdown(timeout time.Duration)
	AddAsyncHandler(opcode ctrl.OpCode, resultOpcode ctrl.OpCode, payloadType message.AsyncCommand, handler AsyncHandlerFunc)
	AddSyncHandler(opcode ctrl.OpCode, handler ctrl.MessageHandlerFunc)
	RemoveHandler(opcode ctrl.OpCode)
}

ServerHandler defines the interface for adding and removing sync or async handlers from a control-protocol server

func NewServerHandler

func NewServerHandler(ctx context.Context, port int) (ServerHandler, error)

NewServerHandler starts a control-protocol server on the specified port and returns the serverHandlerImpl as a ServerHandler interface