relay

Documentation

Index

• Constants
• type ACLFilter
• type Option
  • func WithACL(acl ACLFilter) Option
  • func WithLimit(limit *RelayLimit) Option
  • func WithResources(rc Resources) Option
• type Relay
  • func New(h host.Host, opts ...Option) (*Relay, error)
  • func (r *Relay) Close() error
• type RelayLimit
  • func DefaultLimit() *RelayLimit
• type Resources
  • func DefaultResources() Resources

Constants

const (
	ServiceName = "libp2p.relay/v2"

	ReservationTagWeight = 10

	StreamTimeout    = time.Minute
	ConnectTimeout   = 30 * time.Second
	HandshakeTimeout = time.Minute
)

Types

type ACLFilter

type ACLFilter interface {
	// AllowReserve returns true if a reservation from a peer with the given peer ID and multiaddr
	// is allowed.
	AllowReserve(p peer.ID, a ma.Multiaddr) bool
	// AllowConnect returns true if a source peer, with a given multiaddr is allowed to connect
	// to a destination peer.
	AllowConnect(src peer.ID, srcAddr ma.Multiaddr, dest peer.ID) bool
}

ACLFilter is an Access Control mechanism for relayed connect.

type Option

type Option func(*Relay) error

func WithACL

func WithACL(acl ACLFilter) Option

WithACL is a Relay option that supplies an ACLFilter for access control.

func WithLimit

func WithLimit(limit *RelayLimit) Option

WithLimit is a Relay option that sets only the relayed connection limits for the relay.

func WithResources

func WithResources(rc Resources) Option

WithResources is a Relay option that sets specific relay resources for the relay.

type Relay

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

Relay is the (limited) relay service object.

func New

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 (*Relay) Close

func (r *Relay) Close() error

type RelayLimit

type RelayLimit struct {
	// Duration is the time limit before resetting a relayed connection; defaults to 2min.
	Duration time.Duration
	// Data is the limit of data relayed (on each direction) before resetting the connection.
	// Defaults to 128KB
	Data int64
}

RelayLimit are the per relayed connection resource limits.

func DefaultLimit

func DefaultLimit() *RelayLimit

DefaultLimit returns a RelayLimit object with the defaults filled in.

type Resources

type Resources struct {
	// Limit is the (optional) relayed connection limits.
	Limit *RelayLimit

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

	// MaxReservations is the maximum number of active relay slots; defaults to 128.
	MaxReservations int
	// MaxCircuits is the maximum number of open relay connections for each peer; defaults to 16.
	MaxCircuits int
	// BufferSize is the size of the relayed connection buffers; defaults to 2048.
	BufferSize int

	// MaxReservationsPerPeer is the maximum number of reservations originating from the same
	// peer; default is 4.
	MaxReservationsPerPeer int
	// MaxReservationsPerIP is the maximum number of reservations originating from the same
	// IP address; default is 8.
	MaxReservationsPerIP int
	// MaxReservationsPerASN is the maximum number of reservations origination from the same
	// ASN; default is 32
	MaxReservationsPerASN int
}

Resources are the resource limits associated with the relay service.

func DefaultResources

func DefaultResources() Resources

DefaultResources returns a Resources object with the default filled in.