peer

Documentation

Overview

Package peer contains components for managing peers.

The `go.uber.org/yarpc/api/peer` package provides the corresponding interfaces that these components implement.

The HTTP and TChannel `NewOutbound` methods accept a `peer.Chooser`. To bind an outbound to a single peer, pass a `peer.NewSingle(id)`.

To bind an outbound to multiple peers, you will need a peer list, like `roundrobin` (to pick the least recently chosen peer) or `peerheap` (to choose the peer with the fewest pending requests). Assuming you choose `peerheap`, to bind multiple peers you would pass `peer.Bind(peerheap.New(transport), peer.BindPeers(ids))`.

Each transport can define its own domain of peer identifiers, but most will use a host:port address for the remote listening socket. The `"go.uber.org/yarpc/peer/hostport"` package implements the common `hostport.PeerIdentifier` and `hostport.Peer`.

Index

• func BindPeers(ids []peer.Identifier) peer.Binder
• type BoundChooser
  • func Bind(chooserList peer.ChooserList, bind peer.Binder) *BoundChooser
  • func (c *BoundChooser) Choose(ctx context.Context, treq *transport.Request) (peer peer.Peer, onFinish func(error), err error)
  • func (c *BoundChooser) ChooserList() peer.ChooserList
  • func (c *BoundChooser) Introspect() introspection.ChooserStatus
  • func (c *BoundChooser) IsRunning() bool
  • func (c *BoundChooser) Start() error
  • func (c *BoundChooser) Stop() error
  • func (c *BoundChooser) Updater() transport.Lifecycle
• type PeersUpdater
  • func (s *PeersUpdater) IsRunning() bool
  • func (s *PeersUpdater) Start() error
  • func (s *PeersUpdater) Stop() error
• type Single
  • func NewSingle(pid peer.Identifier, transport peer.Transport) *Single
  • func (s *Single) Choose(ctx context.Context, _ *transport.Request) (peer.Peer, func(error), error)
  • func (s *Single) Introspect() introspection.ChooserStatus
  • func (s *Single) IsRunning() bool
  • func (s *Single) NotifyStatusChanged(_ peer.Identifier)
  • func (s *Single) Start() error
  • func (s *Single) Stop() error
  • func (s *Single) Transport() peer.Transport

Functions

func BindPeers

func BindPeers(ids []peer.Identifier) peer.Binder

BindPeers returns a binder (suitable as an argument to peer.Bind) that binds a peer list to a static list of peers for the duration of its lifecycle.

Types

type BoundChooser

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

BoundChooser is a peer chooser that couples a peer list and a peer list updater for the duration of its lifecycle.

func Bind

func Bind(chooserList peer.ChooserList, bind peer.Binder) *BoundChooser

Bind couples a peer list with a peer list updater. Bind accepts a peer list and passes that peer list to a binder. The binder must return a peer list updater bound to the peer list. The peer list updater must implement Lifecycle so the bound peer list can start and stop updates.

func (*BoundChooser) Choose

func (c *BoundChooser) Choose(ctx context.Context, treq *transport.Request) (peer peer.Peer, onFinish func(error), err error)

Choose returns a peer from the bound peer list.

func (*BoundChooser) ChooserList

func (c *BoundChooser) ChooserList() peer.ChooserList

ChooserList returns the bound peer list.

func (*BoundChooser) Introspect

func (c *BoundChooser) Introspect() introspection.ChooserStatus

Introspect introspects the bound chooser.

func (*BoundChooser) IsRunning

func (c *BoundChooser) IsRunning() bool

IsRunning returns whether the peer list and its peer list updater are both running, regardless of whether they should be running according to the bound chooser's lifecycle.

func (*BoundChooser) Start

func (c *BoundChooser) Start() error

Start starts the peer list and the peer list updater.

func (*BoundChooser) Stop

func (c *BoundChooser) Stop() error

Stop stops the peer list and the peer list updater.

func (*BoundChooser) Updater

func (c *BoundChooser) Updater() transport.Lifecycle

Updater returns the bound peer list updater.

type PeersUpdater

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

PeersUpdater binds a fixed list of peers to a peer list.

func (*PeersUpdater) IsRunning

func (s *PeersUpdater) IsRunning() bool

IsRunning returns whether the peers have been added and not removed.

func (*PeersUpdater) Start

func (s *PeersUpdater) Start() error

Start adds a list of fixed peers to a peer list.

func (*PeersUpdater) Stop

func (s *PeersUpdater) Stop() error

Stop removes a list of fixed peers from a peer list.

type Single

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

Single implements the Chooser interface for a single peer

func NewSingle

func NewSingle(pid peer.Identifier, transport peer.Transport) *Single

NewSingle creates a static Chooser with a single Peer

func (*Single) Choose

func (s *Single) Choose(ctx context.Context, _ *transport.Request) (peer.Peer, func(error), error)

Choose returns the single peer

func (*Single) Introspect

func (s *Single) Introspect() introspection.ChooserStatus

Introspect returns a ChooserStatus with a single PeerStatus.

func (*Single) IsRunning

func (s *Single) IsRunning() bool

IsRunning is a noop

func (*Single) NotifyStatusChanged

func (s *Single) NotifyStatusChanged(_ peer.Identifier)

NotifyStatusChanged receives notifications from the transport when the peer connects, disconnects, accepts a request, and so on.

func (*Single) Start

func (s *Single) Start() error

Start is a noop

func (*Single) Stop

func (s *Single) Stop() error

Stop is a noop

func (*Single) Transport

func (s *Single) Transport() peer.Transport

Transport returns the transport to which this peer is attached.