peering

Documentation

Index

• type PeeringService
  • func NewPeeringService(host host.Host) *PeeringService
  • func (ps *PeeringService) AddPeer(info peer.AddrInfo)
  • func (ps *PeeringService) GetState() State
  • func (ps *PeeringService) ListPeers() []peer.AddrInfo
  • func (ps *PeeringService) RemovePeer(id peer.ID)
  • func (ps *PeeringService) Start() error
  • func (ps *PeeringService) Stop()
• type State
  • func (s State) String() string

Types

type PeeringService

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

PeeringService maintains connections to specified peers, reconnecting on disconnect with a back-off.

func NewPeeringService

func NewPeeringService(host host.Host) *PeeringService

NewPeeringService constructs a new peering service. Peers can be added and removed immediately, but connections won't be formed until `Start` is called.

func (*PeeringService) AddPeer

func (ps *PeeringService) AddPeer(info peer.AddrInfo)

AddPeer adds a peer to the peering service. This function may be safely called at any time: before the service is started, while running, or after it stops.

Add peer may also be called multiple times for the same peer. The new addresses will replace the old.

func (*PeeringService) GetState

func (ps *PeeringService) GetState() State

GetState get the State of the PeeringService.

func (*PeeringService) ListPeers

func (ps *PeeringService) ListPeers() []peer.AddrInfo

ListPeers lists peers in the peering service.

func (*PeeringService) RemovePeer

func (ps *PeeringService) RemovePeer(id peer.ID)

RemovePeer removes a peer from the peering service. This function may be safely called at any time: before the service is started, while running, or after it stops.

func (*PeeringService) Start

func (ps *PeeringService) Start() error

Start starts the peering service, connecting and maintaining connections to all registered peers. It returns an error if the service has already been stopped.

func (*PeeringService) Stop

func (ps *PeeringService) Stop()

Stop stops the peering service.

type State

type State uint

const (
	StateInit State = iota
	StateRunning
	StateStopped
)

func (State) String

func (s State) String() string