keepalive

Documentation

Index

• Constants
• Variables
• func NewMsgFromCbor(msgType uint, data []byte) (protocol.Message, error)
• type Client
  • func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client
  • func (c *Client) Start()
• type Config
  • func NewConfig(options ...KeepAliveOptionFunc) Config
• type DoneFunc
• type KeepAlive
  • func New(protoOptions protocol.ProtocolOptions, cfg *Config) *KeepAlive
• type KeepAliveFunc
• type KeepAliveOptionFunc
  • func WithDoneFunc(doneFunc DoneFunc) KeepAliveOptionFunc
  • func WithKeepAliveFunc(keepAliveFunc KeepAliveFunc) KeepAliveOptionFunc
  • func WithKeepAliveResponseFunc(keepAliveResponseFunc KeepAliveResponseFunc) KeepAliveOptionFunc
  • func WithPeriod(period time.Duration) KeepAliveOptionFunc
  • func WithTimeout(timeout time.Duration) KeepAliveOptionFunc
• type KeepAliveResponseFunc
• type MsgDone
  • func NewMsgDone() *MsgDone
• type MsgKeepAlive
  • func NewMsgKeepAlive(cookie uint16) *MsgKeepAlive
• type MsgKeepAliveResponse
  • func NewMsgKeepAliveResponse(cookie uint16) *MsgKeepAliveResponse
• type Server
  • func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server

Constants

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

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

	// Timeout for keep-alive responses, in seconds
	DEFAULT_KEEP_ALIVE_TIMEOUT = 10
)

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.AgencyClient,
		Transitions: []protocol.StateTransition{
			{
				MsgType:  MESSAGE_TYPE_KEEP_ALIVE,
				NewState: STATE_SERVER,
			},
			{
				MsgType:  MESSAGE_TYPE_DONE,
				NewState: STATE_DONE,
			},
		},
	},
	STATE_SERVER: protocol.StateMapEntry{
		Agency: protocol.AgencyServer,
		Transitions: []protocol.StateTransition{
			{
				MsgType:  MESSAGE_TYPE_KEEP_ALIVE_RESPONSE,
				NewState: STATE_CLIENT,
			},
		},
	},
	STATE_DONE: protocol.StateMapEntry{
		Agency: protocol.AgencyNone,
	},
}

Functions

func NewMsgFromCbor

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

Types

type Client

type Client struct {
	*protocol.Protocol
	// contains filtered or unexported fields
}

func NewClient

func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client

func (*Client) Start

func (c *Client) Start()

type Config

type Config struct {
	KeepAliveFunc         KeepAliveFunc
	KeepAliveResponseFunc KeepAliveResponseFunc
	DoneFunc              DoneFunc
	Timeout               time.Duration
	Period                time.Duration
}

func NewConfig

func NewConfig(options ...KeepAliveOptionFunc) Config

type DoneFunc

type DoneFunc func() error

type KeepAlive

type KeepAlive struct {
	Client *Client
	Server *Server
}

func New

func New(protoOptions protocol.ProtocolOptions, cfg *Config) *KeepAlive

type KeepAliveFunc

type KeepAliveFunc func(uint16) error

Callback function types

type KeepAliveOptionFunc

type KeepAliveOptionFunc func(*Config)

func WithDoneFunc

func WithDoneFunc(doneFunc DoneFunc) KeepAliveOptionFunc

func WithKeepAliveFunc

func WithKeepAliveFunc(keepAliveFunc KeepAliveFunc) KeepAliveOptionFunc

func WithKeepAliveResponseFunc

func WithKeepAliveResponseFunc(keepAliveResponseFunc KeepAliveResponseFunc) KeepAliveOptionFunc

func WithPeriod

func WithPeriod(period time.Duration) KeepAliveOptionFunc

func WithTimeout

func WithTimeout(timeout time.Duration) KeepAliveOptionFunc

type KeepAliveResponseFunc

type KeepAliveResponseFunc func(uint16) error

type MsgDone

type MsgDone struct {
	protocol.MessageBase
}

func NewMsgDone

func NewMsgDone() *MsgDone

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

type Server

type Server struct {
	*protocol.Protocol
	// contains filtered or unexported fields
}

func NewServer

func NewServer(protoOptions protocol.ProtocolOptions, cfg *Config) *Server