package holepunch

Import Path
	github.com/libp2p/go-libp2p/p2p/protocol/holepunch (on go.dev)

Dependency Relation
	imports 18 packages, and imported by 3 packages

Involved Source Files

	    filter.go
	    holepuncher.go
	    metrics.go
	    svc.go
	    tracer.go
	    util.go
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type AddrFilter (interface)
		AddrFilter defines the interface for the multi address filtering.

		Methods (total 2)
			( AddrFilter) FilterLocal(remoteID peer.ID, maddrs []ma.Multiaddr) []ma.Multiaddr
				FilterLocal filters the multi addresses that are sent to the remote peer.

			( AddrFilter) FilterRemote(remoteID peer.ID, maddrs []ma.Multiaddr) []ma.Multiaddr
				FilterRemote filters the multi addresses received from the remote peer.

		As Inputs Of (at least one exported)
			func WithAddrFilter(f AddrFilter) Option

	 type DirectDialEvt (struct)
		Event Objects

		Fields (total 3)
			EllapsedTime time.Duration
			Error string
			Success bool

	 type EndHolePunchEvt (struct)

		Fields (total 3)
			EllapsedTime time.Duration
			Error string
			Success bool

	 type Event (struct)

		Fields (total 5)
			Evt interface{}
				// the actual event

			Peer peer.ID
				// local peer ID

			Remote peer.ID
				// remote peer ID

			Timestamp int64
				// UNIX nanos

			Type string
				// event type

		As Inputs Of (at least one exported)
			func EventTracer.Trace(evt *Event)

	 type EventTracer (interface)

		Methods (only one)
			( EventTracer) Trace(evt *Event)
		As Inputs Of (at least 2)
			func WithMetricsAndEventTracer(mt MetricsTracer, et EventTracer) Option
			func WithTracer(et EventTracer) Option

	 type HolePunchAttemptEvt (struct)

		Fields (only one)
			Attempt int

	 type MetricsTracer (interface)

		Methods (total 2)
			( MetricsTracer) DirectDialFinished(success bool)
			( MetricsTracer) HolePunchFinished(side string, attemptNum int, theirAddrs []ma.Multiaddr, ourAddr []ma.Multiaddr, directConn network.ConnMultiaddrs)
		As Outputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
		As Inputs Of (at least 2)
			func WithMetricsAndEventTracer(mt MetricsTracer, et EventTracer) Option
			func WithMetricsTracer(mt MetricsTracer) Option

	 type MetricsTracerOption (func)

		As Outputs Of (at least one exported)
			func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption
		As Inputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer

	 type Option (func)

		As Outputs Of (at least 5)
			func DirectDialTimeout(timeout time.Duration) Option
			func WithAddrFilter(f AddrFilter) Option
			func WithMetricsAndEventTracer(mt MetricsTracer, et EventTracer) Option
			func WithMetricsTracer(mt MetricsTracer) Option
			func WithTracer(et EventTracer) Option
		As Inputs Of (at least 2)
			func NewService(h host.Host, ids identify.IDService, listenAddrs func() []ma.Multiaddr, opts ...Option) (*Service, error)
			func github.com/libp2p/go-libp2p.EnableHolePunching(opts ...Option) libp2p.Option

	 type ProtocolErrorEvt (struct)

		Fields (only one)
			Error string

	 type Service (struct)
		The Service runs on every node that supports the DCUtR protocol.

		Methods (total 3)
			(*Service) Close() error
				Close closes the Hole Punch Service.

			(*Service) DirectConnect(p peer.ID) error
				DirectConnect is only exposed for testing purposes.
				TODO: find a solution for this.

			(*Service) SetLegacyBehavior(legacyBehavior bool)
				SetLegacyBehavior is only exposed for testing purposes.
				Do not set this unless you know what you are doing.

		Implements (at least 2)
			*Service : github.com/prometheus/common/expfmt.Closer
			*Service : io.Closer
		As Outputs Of (at least one exported)
			func NewService(h host.Host, ids identify.IDService, listenAddrs func() []ma.Multiaddr, opts ...Option) (*Service, error)

	 type StartHolePunchEvt (struct)

		Fields (total 2)
			RTT time.Duration
			RemoteAddrs []string


Package-Level Functions (total 8)

	 func DirectDialTimeout(timeout time.Duration) Option
	 func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
	 func NewService(h host.Host, ids identify.IDService, listenAddrs func() []ma.Multiaddr, opts ...Option) (*Service, error)
		NewService creates a new service that can be used for hole punching
		The Service runs on all hosts that support the DCUtR protocol,
		no matter if they are behind a NAT / firewall or not.
		The Service handles DCUtR streams (which are initiated from the node behind
		a NAT / Firewall once we establish a connection to them through a relay.
		
		listenAddrs MUST only return public addresses.

	 func WithAddrFilter(f AddrFilter) Option
		WithAddrFilter is a Service option that enables multiaddress filtering.
		It allows to only send a subset of observed addresses to the remote
		peer. E.g., only announce TCP or QUIC multi addresses instead of both.
		It also allows to only consider a subset of received multi addresses
		that remote peers announced to us.
		Theoretically, this API also allows to add multi addresses in both cases.

	 func WithMetricsAndEventTracer(mt MetricsTracer, et EventTracer) Option
		WithMetricsAndEventTracer enables holepunch tracking with MetricsTracer and EventTracer

	 func WithMetricsTracer(mt MetricsTracer) Option
		WithMetricsTracer enables holepunch Tracing with MetricsTracer mt

	 func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption
	 func WithTracer(et EventTracer) Option
		WithTracer enables holepunch tracing with EventTracer et


Package-Level Variables (total 3)

	  var ErrClosed error
		ErrClosed is returned when the hole punching is closed

	  var ErrHolePunchActive error
		ErrHolePunchActive is returned from DirectConnect when another hole punching attempt is currently running

	  var StreamTimeout time.Duration
		StreamTimeout is the timeout for the hole punch protocol stream.


Package-Level Constants (total 7)

	const DirectDialEvtT = "DirectDial"
		Event Types

	const EndHolePunchEvtT = "EndHolePunch"
		Event Types

	const HolePunchAttemptEvtT = "HolePunchAttempt"
		Event Types

	const Protocol protocol.ID = "/libp2p/dcutr"
		Protocol is the libp2p protocol for Hole Punching.

	const ProtocolErrorEvtT = "ProtocolError"
		Event Types

	const ServiceName = "libp2p.holepunch"
	const StartHolePunchEvtT = "StartHolePunch"
		Event Types

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.