Source File
	options.go

Belonging Package
	github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/relay

package relay

import (
	"github.com/multiformats/go-multiaddr"
)

type Option func(*Relay) error

// WithResources is a Relay option that sets specific relay resources for the relay.
func WithResources(rc Resources) Option {
	return func(r *Relay) error {
		r.rc = rc
		return nil
	}
}

// WithLimit is a Relay option that sets only the relayed connection limits for the relay.
func WithLimit(limit *RelayLimit) Option {
	return func(r *Relay) error {
		r.rc.Limit = limit
		return nil
	}
}

// Reservation address function used to promote addresses to connected nodes
type ReservationAddressFilterFunc func(addr multiaddr.Multiaddr) (include bool)

// Overrides the default reservation address filter.
// This will permit the relay let the client know it have access to non public addresses too.
func WithReservationAddressFilter(filter ReservationAddressFilterFunc) (option Option) {
	return func(r *Relay) (err error) {
		r.reservationAddrFilter = filter
		return nil
	}
}

// WithInfiniteLimits is a Relay option that disables limits.
func WithInfiniteLimits() Option {
	return func(r *Relay) error {
		r.rc.Limit = nil
		return nil
	}
}

// WithACL is a Relay option that supplies an ACLFilter for access control.
func WithACL(acl ACLFilter) Option {
	return func(r *Relay) error {
		r.acl = acl
		return nil
	}
}

// WithMetricsTracer is a Relay option that supplies a MetricsTracer for metrics
func WithMetricsTracer(mt MetricsTracer) Option {
	return func(r *Relay) error {
		r.metricsTracer = mt
		return nil
	}
}

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.