relay

Documentation

Index

• Constants
• func CanHop(ctx context.Context, host host.Host, id peer.ID) (bool, error)
• type ACLFilter
• type Option
  • func WithACL(acl ACLFilter) Option
  • func WithResources(rc Resources) Option
• type Relay
  • func NewRelay(h host.Host, opts ...Option) (*Relay, error)
  • func (r *Relay) Close() error
• type Resources
  • func DefaultResources() Resources

Constants

const (
	ProtoID = "/libp2p/circuit/relay/0.1.0"

	ServiceName = "libp2p.relay/v1"

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

Functions

func CanHop

func CanHop(ctx context.Context, host host.Host, id peer.ID) (bool, error)

Queries a peer for support of hop relay

Types

type ACLFilter

type ACLFilter interface {
	AllowHop(src, dest peer.ID) bool
}

type Option

type Option func(r *Relay) error

func WithACL

func WithACL(acl ACLFilter) Option

WithACL specifies an ACLFilter for access control

func WithResources

func WithResources(rc Resources) Option

WithResources specifies resource limits for the relay

type Relay

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

func NewRelay

func NewRelay(h host.Host, opts ...Option) (*Relay, error)

func (*Relay) Close

func (r *Relay) Close() error

type Resources

type Resources struct {
	// MaxCircuits is the maximum number of active relay connections
	MaxCircuits int

	// MaxCircuitsPerPeer is the maximum number of active relay connections per peer
	MaxCircuitsPerPeer int

	// BufferSize is the buffer size for relaying in each direction
	BufferSize int
}

func DefaultResources

func DefaultResources() Resources