net

Documentation

Index

• type BasicHost
  • func New(ctx context.Context, cfg *config.AppConfig) (*BasicHost, error)
  • func NewWithHost(host core.Host) *BasicHost
  • func (h *BasicHost) Addrs() []multiaddr.Multiaddr
  • func (h *BasicHost) FullAddr() string
  • func (h *BasicHost) Get() core.Host
  • func (h *BasicHost) ID() peer.ID
• type Host

Types

type BasicHost

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

BasicHost wraps core.Host for use by the DHT and PubSub

func New

func New(ctx context.Context, cfg *config.AppConfig) (*BasicHost, error)

New creates a new host

func NewWithHost

func NewWithHost(host core.Host) *BasicHost

NewWithHost creates an instance of BasicHost with a pre-existing host

func (*BasicHost) Addrs

func (h *BasicHost) Addrs() []multiaddr.Multiaddr

Addrs returns the addresses of the host

func (*BasicHost) FullAddr

func (h *BasicHost) FullAddr() string

FullAddr returns the full host address

func (*BasicHost) Get

func (h *BasicHost) Get() core.Host

Get returns the host object

func (*BasicHost) ID

func (h *BasicHost) ID() peer.ID

ID returns the peer ID of the host

type Host

type Host interface {
	Get() core.Host
	ID() peer.ID
	Addrs() []multiaddr.Multiaddr
	FullAddr() string
}

Host describes an object participating in a p2p network.