manualpeering

Documentation

Index

• type ConnectionDirection
• type ConnectionStatus
• type GetPeersConfig
  • func BuildGetPeersConfig(opts []GetPeersOption) *GetPeersConfig
  • func (c *GetPeersConfig) ToOptions() (opts []GetPeersOption)
• type GetPeersOption
  • func WithOnlyConnectedPeers() GetPeersOption
• type KnownPeer
• type KnownPeerToAdd
• type Manager
  • func NewManager(p2pm *p2p.Manager, local *peer.Local, log *logger.Logger) *Manager
  • func (m *Manager) AddPeer(peers ...*KnownPeerToAdd) error
  • func (m *Manager) GetPeers(opts ...GetPeersOption) []*KnownPeer
  • func (m *Manager) RemovePeer(keys ...ed25519.PublicKey) error
  • func (m *Manager) Start()
  • func (m *Manager) Stop() (err error)

Types

type ConnectionDirection

type ConnectionDirection string

ConnectionDirection is an enum for the type of connection between local peer and the other peer in the gossip layer.

const (
	// ConnDirectionOutbound means that the local peer dials for the connection in the gossip layer.
	ConnDirectionOutbound ConnectionDirection = "outbound"
	// ConnDirectionInbound means that the local peer accepts for the connection in the gossip layer.
	ConnDirectionInbound ConnectionDirection = "inbound"
)

type ConnectionStatus

type ConnectionStatus string

ConnectionStatus is an enum for the peer connection status in the gossip layer.

const (
	// ConnStatusDisconnected means that there is no real connection established in the gossip layer for that peer.
	ConnStatusDisconnected ConnectionStatus = "disconnected"
	// ConnStatusConnected means that there is a real connection established in the gossip layer for that peer.
	ConnStatusConnected ConnectionStatus = "connected"
)

type GetPeersConfig

type GetPeersConfig struct {
	// If true, GetPeers returns peers that have actual connection established in the gossip layer.
	OnlyConnected bool `json:"onlyConnected"`
}

GetPeersConfig holds optional parameters for the GetPeers method.

func BuildGetPeersConfig

func BuildGetPeersConfig(opts []GetPeersOption) *GetPeersConfig

BuildGetPeersConfig builds GetPeersConfig struct from a list of options.

func (*GetPeersConfig) ToOptions

func (c *GetPeersConfig) ToOptions() (opts []GetPeersOption)

ToOptions translates config struct to a list of corresponding options.

type GetPeersOption

type GetPeersOption func(conf *GetPeersConfig)

GetPeersOption defines a single option for GetPeers method.

func WithOnlyConnectedPeers

func WithOnlyConnectedPeers() GetPeersOption

WithOnlyConnectedPeers returns a GetPeersOption that sets OnlyConnected field to true.

type KnownPeer

type KnownPeer struct {
	PublicKey     ed25519.PublicKey   `json:"publicKey"`
	Address       string              `json:"address"`
	ConnDirection ConnectionDirection `json:"connectionDirection"`
	ConnStatus    ConnectionStatus    `json:"connectionStatus"`
}

KnownPeer defines a peer record in the manual peering layer.

type KnownPeerToAdd

type KnownPeerToAdd struct {
	PublicKey ed25519.PublicKey `json:"publicKey"`
	Address   string            `json:"address"`
}

KnownPeerToAdd defines a type that is used in .AddPeer() method.

type Manager

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

Manager is the core entity in the manual peering package. It holds a list of known peers and constantly provisions it to the gossip layer. Its job is to keep in sync the list of known peers and the list of current manual neighbors connected in the gossip layer. If a new peer is added to known peers, manager will forward it to gossip and make sure it establishes a connection. And vice versa, if a peer is being removed from the list of known peers, manager will make sure gossip drops that connection. Manager also subscribes to the gossip events and in case the connection with a manual peer fails it will reconnect.

func NewManager

func NewManager(p2pm *p2p.Manager, local *peer.Local, log *logger.Logger) *Manager

NewManager initializes a new Manager instance.

func (*Manager) AddPeer

func (m *Manager) AddPeer(peers ...*KnownPeerToAdd) error

AddPeer adds multiple peers to the list of known peers.

func (*Manager) GetPeers

func (m *Manager) GetPeers(opts ...GetPeersOption) []*KnownPeer

GetPeers returns the list of known peers.

func (*Manager) RemovePeer

func (m *Manager) RemovePeer(keys ...ed25519.PublicKey) error

RemovePeer removes multiple peers from the list of known peers.

func (*Manager) Start

func (m *Manager) Start()

Start subscribes to the gossip layer events and starts internal background workers. Calling multiple times has no effect.

func (*Manager) Stop

func (m *Manager) Stop() (err error)

Stop terminates internal background workers. Calling multiple times has no effect.