host

Documentation

Index

• Constants
• type Host
  • func New(ctx context.Context, conf config.Config) (*Host, error)
  • func (h *Host) Addresses() []string
  • func (h *Host) BuildDiscoveryAndRouting() error
  • func (h *Host) BuildPubSub() (*pubsub.PubSub, error)
  • func (h *Host) BuildRPC(ch chan error, ps *pubsub.PubSub) error
  • func (h *Host) Connect(peers []string) error
  • func (h *Host) ID() string
  • func (h *Host) IPFSAddresses() []string
  • func (h *Host) RPCAddress() string
  • func (h *Host) Start(ch chan error, stop chan os.Signal) error

Constants

const (
	// ErrUnknownTransportOption is returned when an unknown transport has been specified
	ErrUnknownTransportOption = cerr.Error("unknown transport option")
	// ErrImproperTransportOption is returned when an improper transport has been specified (e.g. 'none' with other options)
	ErrImproperTransportOption = cerr.Error("unknown improper option")
	// ErrUnknownMuxerOption is returned when an unknown muxer has been specified
	ErrUnknownMuxerOption = cerr.Error("unknown muxer option")
	// ErrImproperMuxerOption is returned when an improper muxer option format has been provided. It expects ['name', 'type']
	ErrImproperMuxerOption = cerr.Error("improper muxer option")
	// ErrUnknownSecurityOption is returned when an unknown security option has been specified
	ErrUnknownSecurityOption = cerr.Error("unknown security option")
	// ErrUnknownPubsubAlgorithm is thrown with the pubsub algorithm passed is not recognized
	ErrUnknownPubsubAlgorithm = cerr.Error("unknown pubsub algorithm")
	// ErrNilRouter is returned when a router is needed but not found
	ErrNilRouter = cerr.Error("nil router")
)

Types

type Host

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

Host is the go-libp2p host note: lhost.Host and lrouter.Routing are interfaces

func New

func New(ctx context.Context, conf config.Config) (*Host, error)

New returns a new host note: not passing reference to config because want it to be read only.

func (*Host) Addresses

func (h *Host) Addresses() []string

Addresses returns the listening addresses of the host

func (*Host) BuildDiscoveryAndRouting

func (h *Host) BuildDiscoveryAndRouting() error

BuildDiscoveryAndRouting ...

func (*Host) BuildPubSub

func (h *Host) BuildPubSub() (*pubsub.PubSub, error)

BuildPubSub returns a pubsub service

func (*Host) BuildRPC

func (h *Host) BuildRPC(ch chan error, ps *pubsub.PubSub) error

BuildRPC returns an rpc service

func (*Host) Connect

func (h *Host) Connect(peers []string) error

Connect connects the host to the list of peers note: it expects the peers to be in IPFS form

func (*Host) ID

func (h *Host) ID() string

ID returns the host's id

func (*Host) IPFSAddresses

func (h *Host) IPFSAddresses() []string

IPFSAddresses returns the ipfs listening addresses of the host

func (*Host) RPCAddress

func (h *Host) RPCAddress() string

RPCAddress returns the host rpc address

func (*Host) Start

func (h *Host) Start(ch chan error, stop chan os.Signal) error

Start starts a new pubsub host