peer

Documentation

Index

• Constants
• Variables
• func CtxIdentity(ctx context.Context) ([]byte, error)
• func CtxPeerAddr(ctx context.Context) string
• func CtxPeerClientVersion(ctx context.Context) string
• func CtxPeerId(ctx context.Context) (string, error)
• func CtxPubKey(ctx context.Context) (crypto.PubKey, error)
• func CtxWithClientVersion(ctx context.Context, addr string) context.Context
• func CtxWithIdentity(ctx context.Context, identity []byte) context.Context
• func CtxWithPeerAddr(ctx context.Context, addr string) context.Context
• func CtxWithPeerId(ctx context.Context, peerId string) context.Context
• type Peer
  • func NewPeer(mc transport.MultiConn, ctrl connCtrl) (p Peer, err error)

Constants

const CtxResponsiblePeers = "*"

Variables

var (
	ErrPeerIdNotFoundInContext   = errors.New("peer id not found in context")
	ErrIdentityNotFoundInContext = errors.New("identity not found in context")
)

Functions

func CtxIdentity

func CtxIdentity(ctx context.Context) ([]byte, error)

CtxIdentity returns identity from context

func CtxPeerAddr

func CtxPeerAddr(ctx context.Context) string

CtxPeerAddr returns peer address

func CtxPeerClientVersion

func CtxPeerClientVersion(ctx context.Context) string

CtxPeerClientVersion returns peer client version

func CtxPeerId

func CtxPeerId(ctx context.Context) (string, error)

CtxPeerId first tries to get peer id under our own key, but if it is not found tries to get through DRPC key

func CtxPubKey

func CtxPubKey(ctx context.Context) (crypto.PubKey, error)

CtxPubKey returns identity unmarshalled from proto in crypto.PubKey model

func CtxWithClientVersion

func CtxWithClientVersion(ctx context.Context, addr string) context.Context

CtxWithClientVersion sets peer clientVersion to the context

func CtxWithIdentity

func CtxWithIdentity(ctx context.Context, identity []byte) context.Context

CtxWithIdentity sets identity in the context

func CtxWithPeerAddr

func CtxWithPeerAddr(ctx context.Context, addr string) context.Context

CtxWithPeerAddr sets peer address to the context

func CtxWithPeerId

func CtxWithPeerId(ctx context.Context, peerId string) context.Context

CtxWithPeerId sets peer id in the context

Types

type Peer

type Peer interface {
	Id() string
	Context() context.Context

	AcquireDrpcConn(ctx context.Context) (drpc.Conn, error)
	ReleaseDrpcConn(conn drpc.Conn)
	DoDrpc(ctx context.Context, do func(conn drpc.Conn) error) error

	IsClosed() bool
	CloseChan() <-chan struct{}

	// SetTTL overrides the default pool ttl
	SetTTL(ttl time.Duration)

	TryClose(objectTTL time.Duration) (res bool, err error)

	ocache.Object
}

func NewPeer

func NewPeer(mc transport.MultiConn, ctrl connCtrl) (p Peer, err error)