package relay

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

Dependency Relation
	imports 23 packages, and imported by 4 packages

Involved Source Files

	    acl.go
	    constraints.go
	    metrics.go
	    options.go
	    relay.go
	    resources.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type ACLFilter (interface)
		ACLFilter is an Access Control mechanism for relayed connect.

		Methods (total 2)
			( ACLFilter) AllowConnect(src peer.ID, srcAddr ma.Multiaddr, dest peer.ID) bool
				AllowConnect returns true if a source peer, with a given multiaddr is allowed to connect
				to a destination peer.

			( ACLFilter) AllowReserve(p peer.ID, a ma.Multiaddr) bool
				AllowReserve returns true if a reservation from a peer with the given peer ID and multiaddr
				is allowed.

		As Inputs Of (at least one exported)
			func WithACL(acl ACLFilter) Option

	 type MetricsTracer (interface)
		MetricsTracer is the interface for tracking metrics for relay service

		Methods (total 8)
			( MetricsTracer) BytesTransferred(cnt int)
				BytesTransferred tracks the total bytes transferred by the relay service

			( MetricsTracer) ConnectionClosed(d time.Duration)
				ConnectionClosed tracks metrics on closing a relay connection

			( MetricsTracer) ConnectionOpened()
				ConnectionOpened tracks metrics on opening a relay connection

			( MetricsTracer) ConnectionRequestHandled(status pbv2.Status)
				ConnectionRequestHandled tracks metrics on handling a relay connection request

			( MetricsTracer) RelayStatus(enabled bool)
				RelayStatus tracks whether the service is currently active

			( MetricsTracer) ReservationAllowed(isRenewal bool)
				ReservationAllowed tracks metrics on opening or renewing a relay reservation

			( MetricsTracer) ReservationClosed(cnt int)
				ReservationRequestClosed tracks metrics on closing a relay reservation

			( MetricsTracer) ReservationRequestHandled(status pbv2.Status)
				ReservationRequestHandled tracks metrics on handling a relay reservation request

		As Outputs Of (at least one exported)
			func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
		As Inputs Of (at least one exported)
			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 WithACL(acl ACLFilter) Option
			func WithInfiniteLimits() Option
			func WithLimit(limit *RelayLimit) Option
			func WithMetricsTracer(mt MetricsTracer) Option
			func WithResources(rc Resources) Option
		As Inputs Of (at least 3)
			func New(h host.Host, opts ...Option) (*Relay, error)
			func github.com/libp2p/go-libp2p/p2p/host/relaysvc.NewRelayManager(host host.Host, opts ...Option) *relaysvc.RelayManager
			func github.com/libp2p/go-libp2p.EnableRelayService(opts ...Option) libp2p.Option

	 type Relay (struct)
		Relay is the (limited) relay service object.

		Methods (only one)
			(*Relay) Close() error
		Implements (at least 2)
			*Relay : github.com/prometheus/common/expfmt.Closer
			*Relay : io.Closer
		As Outputs Of (at least one exported)
			func New(h host.Host, opts ...Option) (*Relay, error)

	 type RelayLimit (struct)
		RelayLimit are the per relayed connection resource limits.

		Fields (total 2)
			Data int64
				Data is the limit of data relayed (on each direction) before resetting the connection.
				Defaults to 128KB

			Duration time.Duration
				Duration is the time limit before resetting a relayed connection; defaults to 2min.

		As Outputs Of (at least one exported)
			func DefaultLimit() *RelayLimit
		As Inputs Of (at least one exported)
			func WithLimit(limit *RelayLimit) Option

	 type Resources (struct)
		Resources are the resource limits associated with the relay service.

		Fields (total 8)
			BufferSize int
				BufferSize is the size of the relayed connection buffers; defaults to 2048.

			Limit *RelayLimit
				Limit is the (optional) relayed connection limits.

			MaxCircuits int
				MaxCircuits is the maximum number of open relay connections for each peer; defaults to 16.

			MaxReservations int
				MaxReservations is the maximum number of active relay slots; defaults to 128.

			MaxReservationsPerASN int
				MaxReservationsPerASN is the maximum number of reservations origination from the same
				ASN; default is 32

			MaxReservationsPerIP int
				MaxReservationsPerIP is the maximum number of reservations originating from the same
				IP address; default is 8.

			MaxReservationsPerPeer int
				MaxReservationsPerPeer is the maximum number of reservations originating from the same
				peer; default is 4.
				
				Deprecated: We only need 1 reservation per peer.

			ReservationTTL time.Duration
				ReservationTTL is the duration of a new (or refreshed reservation).
				Defaults to 1hr.

		As Outputs Of (at least one exported)
			func DefaultResources() Resources
		As Inputs Of (at least one exported)
			func WithResources(rc Resources) Option


Package-Level Functions (total 10)

	 func DefaultLimit() *RelayLimit
		DefaultLimit returns a RelayLimit object with the defaults filled in.

	 func DefaultResources() Resources
		DefaultResources returns a Resources object with the default filled in.

	 func New(h host.Host, opts ...Option) (*Relay, error)
		New constructs a new limited relay that can provide relay services in the given host.

	 func NewMetricsTracer(opts ...MetricsTracerOption) MetricsTracer
	 func WithACL(acl ACLFilter) Option
		WithACL is a Relay option that supplies an ACLFilter for access control.

	 func WithInfiniteLimits() Option
		WithInfiniteLimits is a Relay option that disables limits.

	 func WithLimit(limit *RelayLimit) Option
		WithLimit is a Relay option that sets only the relayed connection limits for the relay.

	 func WithMetricsTracer(mt MetricsTracer) Option
		WithMetricsTracer is a Relay option that supplies a MetricsTracer for metrics

	 func WithRegisterer(reg prometheus.Registerer) MetricsTracerOption
	 func WithResources(rc Resources) Option
		WithResources is a Relay option that sets specific relay resources for the relay.


Package-Level Constants (total 5)

	const ConnectTimeout time.Duration = 30000000000
	const HandshakeTimeout time.Duration = 60000000000
	const ReservationTagWeight = 10
	const ServiceName = "libp2p.relay/v2"
	const StreamTimeout time.Duration = 60000000000

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.