libp2p_uds

Documentation

Overview

Package uds was auto-translated from rust-libp2p. https://github.com/libp2p/rust-libp2p/blob/master/transports/uds/src/lib.rs

Index

• type UdsTransport
  • func NewUDSTransport(upgrader transport.Upgrader, rcmgr network.ResourceManager, ...) (*UdsTransport, error)
  • func (t *UdsTransport) CanDial(addr ma.Multiaddr) bool
  • func (t *UdsTransport) Dial(ctx context.Context, raddr ma.Multiaddr, p peer.ID) (transport.CapableConn, error)
  • func (t *UdsTransport) DialWithUpdates(ctx context.Context, raddr ma.Multiaddr, p peer.ID, ...) (transport.CapableConn, error)
  • func (t *UdsTransport) Listen(laddr ma.Multiaddr) (transport.Listener, error)
  • func (t *UdsTransport) Protocols() []int
  • func (t *UdsTransport) Proxy() bool
  • func (t *UdsTransport) String() string

Types

type UdsTransport

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

UdsTransport is the Unix Domain Socket transport.

func NewUDSTransport

func NewUDSTransport(
	upgrader transport.Upgrader, rcmgr network.ResourceManager,
	opts ...func(*UdsTransport) error,
) (*UdsTransport, error)

NewUDSTransport creates a UDS transport object.

func (*UdsTransport) CanDial

func (t *UdsTransport) CanDial(addr ma.Multiaddr) bool

CanDial returns true if this transport believes it can dial the given multiaddr.

func (*UdsTransport) Dial

func (t *UdsTransport) Dial(
	ctx context.Context, raddr ma.Multiaddr, p peer.ID,
) (transport.CapableConn, error)

Dial dials the peer at the remote address.

func (*UdsTransport) DialWithUpdates

func (t *UdsTransport) DialWithUpdates(
	ctx context.Context, raddr ma.Multiaddr, p peer.ID,
	updateChan chan<- transport.DialUpdate,
) (transport.CapableConn, error)

func (*UdsTransport) Listen

func (t *UdsTransport) Listen(laddr ma.Multiaddr) (transport.Listener, error)

Listen listens on the given multiaddr.

func (*UdsTransport) Protocols

func (t *UdsTransport) Protocols() []int

Protocols returns the list of terminal protocols this transport can dial.

func (*UdsTransport) Proxy

func (t *UdsTransport) Proxy() bool

Proxy always returns false for the UDS transport.

func (*UdsTransport) String

func (t *UdsTransport) String() string