peer

Documentation

Index

• Constants
• type Keepalive
  • func (ka *Keepalive) MarshalBinary() []byte
  • func (ka *Keepalive) UnmarshalBinary(b []byte) error
• type KeepaliveStats
• type Monitor
  • func SetupMonitorForRemotePeer(la string, port int, rPeers ...string) (Monitor, error)
• type MonitorMessage
• type Peer
  • func NewPeer(la string, port int, ra string, state chan *SessionState) (Peer, error)
• type PeerState
  • func (ps PeerState) String() string
• type SessionState

Constants

const (
	KeepaliveMessageLen = 9
)

Types

type Keepalive

type Keepalive struct {
	Priority     uint8
	Interval     uint32
	DeadInterval uint32
}

Keepalive defines a message which gets exchanged between two peers

func (*Keepalive) MarshalBinary

func (ka *Keepalive) MarshalBinary() []byte

func (*Keepalive) UnmarshalBinary

func (ka *Keepalive) UnmarshalBinary(b []byte) error

type KeepaliveStats

type KeepaliveStats struct {
	TotalMmisses   int
	LastChangeUp   int64
	LastChangeDown int64
}

type Monitor

type Monitor interface {
	// GetPeerState(string) PeerState
	GetMonitorCh() chan *MonitorMessage
	Stop()
}

func SetupMonitorForRemotePeer

func SetupMonitorForRemotePeer(la string, port int, rPeers ...string) (Monitor, error)

SetupMonitorForRemotePeer sets up a keep alive mechanism between a local and remote peers, returned Monitor interface allows get a state of a particular peer by specifying its id, or get a notification channel for changes of a remote peer states.

type MonitorMessage

type MonitorMessage struct {
	RemotePeer string
	PeerState  PeerState
}

type Peer

type Peer interface {
	Start()
	Stop()
	GetSessionStateChangeCh() chan *SessionState
	GetRemoteAddr() string
	Alive() bool
}

Manager defines methods to control and query a keepalive process

func NewPeer

func NewPeer(la string, port int, ra string, state chan *SessionState) (Peer, error)

type PeerState

type PeerState uint8

const (
	PeerUp PeerState = iota + 1
	PeerDown
)

func (PeerState) String

func (ps PeerState) String() string

type SessionState

type SessionState struct {
	RemotePeer string
	PeerState  PeerState
}