keepalive

Documentation

Index

• Constants
• Variables
• func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)
• type DoneFunc
• type KeepAlive
  • func New(options protocol.ProtocolOptions, callbackConfig *KeepAliveCallbackConfig) *KeepAlive
  • func (k *KeepAlive) KeepAlive(cookie uint16) error
  • func (k *KeepAlive) Start()
  • func (k *KeepAlive) Stop()
• type KeepAliveCallbackConfig
• type KeepAliveFunc
• type KeepAliveResponseFunc
• type MsgDone
• type MsgKeepAlive
  • func NewMsgKeepAlive(cookie uint16) *MsgKeepAlive
• type MsgKeepAliveResponse
  • func NewMsgKeepAliveResponse(cookie uint16) *MsgKeepAliveResponse

Constants

const (
	PROTOCOL_NAME        = "keep-alive"
	PROTOCOL_ID   uint16 = 8

	// Time between keep-alive probes, in seconds
	KEEP_ALIVE_PERIOD = 60
)

const (
	MESSAGE_TYPE_KEEP_ALIVE          = 0
	MESSAGE_TYPE_KEEP_ALIVE_RESPONSE = 1
	MESSAGE_TYPE_DONE                = 2
)

Variables

var (
	STATE_CLIENT = protocol.NewState(1, "Client")
	STATE_SERVER = protocol.NewState(2, "Server")
	STATE_DONE   = protocol.NewState(3, "Done")
)

var StateMap = protocol.StateMap{
	STATE_CLIENT: protocol.StateMapEntry{
		Agency: protocol.AGENCY_CLIENT,
		Transitions: []protocol.StateTransition{
			{
				MsgType:  MESSAGE_TYPE_KEEP_ALIVE,
				NewState: STATE_SERVER,
			},
			{
				MsgType:  MESSAGE_TYPE_DONE,
				NewState: STATE_DONE,
			},
		},
	},
	STATE_SERVER: protocol.StateMapEntry{
		Agency: protocol.AGENCY_SERVER,
		Transitions: []protocol.StateTransition{
			{
				MsgType:  MESSAGE_TYPE_KEEP_ALIVE_RESPONSE,
				NewState: STATE_CLIENT,
			},
		},
	},
	STATE_DONE: protocol.StateMapEntry{
		Agency: protocol.AGENCY_NONE,
	},
}

Functions

func NewMsgFromCbor

func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)

Types

type DoneFunc

type DoneFunc func() error

type KeepAlive

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

func New

func New(options protocol.ProtocolOptions, callbackConfig *KeepAliveCallbackConfig) *KeepAlive

func (*KeepAlive) KeepAlive

func (k *KeepAlive) KeepAlive(cookie uint16) error

func (*KeepAlive) Start

func (k *KeepAlive) Start()

func (*KeepAlive) Stop

func (k *KeepAlive) Stop()

type KeepAliveCallbackConfig

type KeepAliveCallbackConfig struct {
	KeepAliveFunc         KeepAliveFunc
	KeepAliveResponseFunc KeepAliveResponseFunc
	DoneFunc              DoneFunc
}

type KeepAliveFunc

type KeepAliveFunc func(uint16) error

Callback function types

type KeepAliveResponseFunc

type KeepAliveResponseFunc func(uint16) error

type MsgDone

type MsgDone struct {
	protocol.MessageBase
}

type MsgKeepAlive

type MsgKeepAlive struct {
	protocol.MessageBase
	Cookie uint16
}

func NewMsgKeepAlive

func NewMsgKeepAlive(cookie uint16) *MsgKeepAlive

type MsgKeepAliveResponse

type MsgKeepAliveResponse struct {
	protocol.MessageBase
	Cookie uint16
}

func NewMsgKeepAliveResponse

func NewMsgKeepAliveResponse(cookie uint16) *MsgKeepAliveResponse