relaymgr

Documentation

Index

• type RelayManager
  • func New(ctx context.Context, h host.Host, relayMultiaddress string) (*RelayManager, error)
  • func (rm *RelayManager) Close() error

Types

type RelayManager

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

RelayManager connects a libp2p host to an external relay and do a best-effort in keeping the connection healthy.

func New

func New(ctx context.Context, h host.Host, relayMultiaddress string) (*RelayManager, error)

New connects the provided host to the remote relay, doing a best-effort in keeping the connection healthy. The provided context is only used for the initial connection to the relay. To shutdown call Close().

func (*RelayManager) Close

func (rm *RelayManager) Close() error

Close stops relay manager work to keep a healthy connection with the relay.