route

Documentation

Index

• Constants
• type Command
  • func New(ctx provider) (*Command, error)
  • func (o *Command) Connection(rw io.Writer, req io.Reader) command.Error
  • func (o *Command) GetHandlers() []command.Handler
  • func (o *Command) Register(rw io.Writer, req io.Reader) command.Error
  • func (o *Command) Unregister(rw io.Writer, req io.Reader) command.Error
• type RegisterRoute

Constants

const (
	// InvalidRequestErrorCode for invalid requests
	InvalidRequestErrorCode = command.Code(iota + command.ROUTE)

	// ResponseWriteErrorCode for response write error
	RegisterMissingConnIDCode

	// RegisterRouterErrorCode for register router error
	RegisterRouterErrorCode

	// UnregisterRouterErrorCode for unregister router error
	UnregisterRouterErrorCode

	// Connection for get connection id error
	GetConnectionIDErrorCode
)

Error codes

Types

type Command

type Command struct {
	// contains filtered or unexported fields
}

Command contains command operations provided by route controller.

func New

func New(ctx provider) (*Command, error)

New returns new route controller command instance.

func (*Command) Connection

func (o *Command) Connection(rw io.Writer, req io.Reader) command.Error

Connection returns the connectionID of the router.

func (*Command) GetHandlers

func (o *Command) GetHandlers() []command.Handler

GetHandlers returns list of all commands supported by this controller command

func (*Command) Register

func (o *Command) Register(rw io.Writer, req io.Reader) command.Error

Register registers the agent with the router.

func (*Command) Unregister

func (o *Command) Unregister(rw io.Writer, req io.Reader) command.Error

Unregister unregisters the agent with the router.

type RegisterRoute

type RegisterRoute struct {
	ConnectionID string `json:"connectionID"`
}

RegisterRoute contains parameters for registering router.