Package: github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/client

package client Import Path github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/client (on go.dev) Dependency Relation imports 18 packages, and imported by 2 packages

Involved Source Files client.go conn.go dial.go handlers.go listen.go reservation.go transport.go

Package-Level Type Names (total 6)

/* sort by: alphabet | popularity */

type Client (struct) Client implements the client-side of the p2p-circuit/v2 protocol: - it implements dialing through v2 relays - it listens for incoming connections through v2 relays. For backwards compatibility with v1 relays and older nodes, the client will also accept relay connections through v1 relays and fallback dial peers using p2p-circuit/v1. This allows us to use the v2 code as drop in replacement for v1 in a host without breaking existing code and interoperability with older nodes. Methods (total 9) (*Client) CanDial(addr ma.Multiaddr) bool (*Client) Close() error (*Client) Dial(ctx context.Context, a ma.Multiaddr, p peer.ID) (transport.CapableConn, error) (*Client) Listen(addr ma.Multiaddr) (transport.Listener, error) (*Client) Listener() *Listener (*Client) Protocols() []int (*Client) Proxy() bool (*Client) SkipResolve(_ context.Context, _ ma.Multiaddr) bool SkipResolve returns true since we always defer to the inner transport for the actual connection. By skipping resolution here, we let the inner transport decide how to resolve the multiaddr (*Client) Start() Start registers the circuit (client) protocol stream handlers Implements (at least 4) *Client : github.com/libp2p/go-libp2p/core/transport.SkipResolver *Client : github.com/libp2p/go-libp2p/core/transport.Transport *Client : github.com/prometheus/common/expfmt.Closer *Client : io.Closer As Outputs Of (at least one exported) func New(h host.Host, upgrader transport.Upgrader) (*Client, error)

type Conn (struct) Methods (total 11) (*Conn) Close() error (*Conn) LocalAddr() net.Addr (*Conn) LocalMultiaddr() ma.Multiaddr (*Conn) Read(buf []byte) (int, error) (*Conn) RemoteAddr() net.Addr (*Conn) RemoteMultiaddr() ma.Multiaddr TODO: is it okay to cast c.Conn().RemotePeer() into a multiaddr? might be "user input" (*Conn) SetDeadline(t time.Time) error (*Conn) SetReadDeadline(t time.Time) error (*Conn) SetWriteDeadline(t time.Time) error (*Conn) Stat() network.ConnStats (*Conn) Write(buf []byte) (int, error) Implements (at least 18) *Conn : github.com/libp2p/go-libp2p/core/network.ConnMultiaddrs *Conn : github.com/libp2p/go-libp2p/core/network.ConnStat *Conn : github.com/miekg/dns.Writer *Conn : github.com/multiformats/go-multiaddr/net.Conn *Conn : github.com/pion/datachannel.ReadDeadliner *Conn : github.com/pion/datachannel.WriteDeadliner *Conn : github.com/pion/stun.Connection *Conn : github.com/pion/stun/v3.Connection *Conn : github.com/prometheus/common/expfmt.Closer *Conn : internal/bisect.Writer *Conn : io.Closer *Conn : io.ReadCloser *Conn : io.Reader *Conn : io.ReadWriteCloser *Conn : io.ReadWriter *Conn : io.WriteCloser *Conn : io.Writer *Conn : net.Conn

type Listener Client (struct) Methods (total 4) (*Listener) Accept() (manet.Conn, error) (*Listener) Addr() net.Addr (*Listener) Close() error (*Listener) Multiaddr() ma.Multiaddr Implements (at least 4) *Listener : github.com/multiformats/go-multiaddr.Multiaddrer *Listener : github.com/multiformats/go-multiaddr/net.Listener *Listener : github.com/prometheus/common/expfmt.Closer *Listener : io.Closer As Outputs Of (at least one exported) func (*Client).Listener() *Listener

type NetAddr (struct) Fields (total 2) Relay string Remote string Methods (total 2) (*NetAddr) Network() string (*NetAddr) String() string Implements (at least 3) *NetAddr : expvar.Var *NetAddr : fmt.Stringer *NetAddr : net.Addr

type Reservation (struct) Reservation is a struct carrying information about a relay/v2 slot reservation. Fields (total 5) Addrs []ma.Multiaddr Addrs contains the vouched public addresses of the reserving peer, which can be announced to the network Expiration time.Time Expiration is the expiration time of the reservation LimitData uint64 LimitData is the number of bytes that the relay will relay in each direction before resetting a relayed connection. LimitDuration time.Duration LimitDuration is the time limit for which the relay will keep a relayed connection open. If 0, there is no limit. Voucher *proto.ReservationVoucher Voucher is a signed reservation voucher provided by the relay As Outputs Of (at least one exported) func Reserve(ctx context.Context, h host.Host, ai peer.AddrInfo) (*Reservation, error)

type ReservationError (struct) ReservationError is the error returned on failure to reserve a slot in the relay Fields (total 2) Reason string Reason is the reason for reservation failure Status pbv2.Status Status is the status returned by the relay for rejecting the reservation request. It is set to pbv2.Status_CONNECTION_FAILED on other failures Methods (total 2) ( ReservationError) Error() string ( ReservationError) Unwrap() error Implements (at least 2) ReservationError : error ReservationError : golang.org/x/xerrors.Wrapper

Package-Level Functions (total 3)

func AddTransport(h host.Host, upgrader transport.Upgrader) error AddTransport constructs a new p2p-circuit/v2 client and adds it as a transport to the host network

func New(h host.Host, upgrader transport.Upgrader) (*Client, error) New constructs a new p2p-circuit/v2 client, attached to the given host and using the given upgrader to perform connection upgrades.

func Reserve(ctx context.Context, h host.Host, ai peer.AddrInfo) (*Reservation, error) Reserve reserves a slot in a relay and returns the reservation information. Clients must reserve slots in order for the relay to relay connections to them.

Package-Level Variables (total 8)

var AcceptTimeout time.Duration

var DialRelayTimeout time.Duration

var DialTimeout time.Duration

var HopTagWeight int HopTagWeight is the connection manager weight for connections carrying relay hop streams

var ReserveTimeout time.Duration

var StatLimitData statLimitData

var StatLimitDuration statLimitDuration

var StreamTimeout time.Duration