peering

type EventPeering struct {
	Peer  netip.Addr
	State EventState
}

type EventState string

type Link interface {
	String() string

	// Peer returns the ID of the connected peer.
	Peer() netip.Addr

	// SwitchLabel returns the switch label of the link.
	SwitchLabel() m.SwitchLabel

	// GeoMark returns geo location of the peer, based on the router address.
	GeoMark() string

	// PeeringURL returns the used peering URL.
	PeeringURL() *m.PeeringURL

	// Outgoing returns whether the connection was initiated by this router.
	Outgoing() bool

	// Lite returns whether the connected router is in lite mode.
	Lite() bool

	// SendPriority sends a priority frame to the peer.
	SendPriority(f frame.Frame) error

	// Send sends a frame to the peer.
	Send(f frame.Frame) error

	// LocalAddr returns the underlying local net.Addr of the connection.
	LocalAddr() net.Addr

	// RemoteAddr returns the underlying remote net.Addr of the connection.
	RemoteAddr() net.Addr

	// Started returns when the link was created.
	Started() time.Time

	// Uptime returns how long the link has been up.
	Uptime() time.Duration

	// Latency returns the latency of the link in milliseconds.
	Latency() uint16

	// AddMeasuredLatency adds the given latency to the measured latencies and
	// calculates and sets the new average.
	AddMeasuredLatency(latency time.Duration)

	// BytesIn returns the total amount of bytes received via the link.
	BytesIn() uint64

	// BytesOut returns the total amount of bytes sent via the link.
	BytesOut() uint64

	// FlowControlIndicator returns a flow control flag that indicates the
	// pressure on the sending queue of this link.
	FlowControlIndicator() frame.FlowControlFlag

	// IsClosing returns whether the link is closing or has closed.
	IsClosing() bool

	// Close closes the link.
	Close(log func())
}

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

type LinkFrame []byte

type Listener interface {
	// ID returns the listener ID.
	ID() string

	// PeeringURL returns the used peering URL.
	PeeringURL() *m.PeeringURL

	// ListenAddress returns the used listen address.
	ListenAddress() net.Addr

	// Close closes the underlying listener and cleans up any related resources.
	Close(log func())
}

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

type Peering struct {
	PeeringEvents *mgr.EventMgr[*EventPeering]
	// contains filtered or unexported fields
}

type Protocol interface {
	// Name returns the protocol name/scheme.
	Name() string
	// PeerWith connects to the given router.
	PeerWith(peering *Peering, peeringURL *m.PeeringURL, ip netip.Addr) (Link, error)
	// StartListener starts a listener for peering requests.
	StartListener(peering *Peering, peeringURL *m.PeeringURL, ip netip.Addr) (Listener, error)
}

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