network

package

v0.0.1 Latest Latest Go to latest Published: Jul 30, 2020 License: Apache-2.0, MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrNilHost = errors.New("host is nil")

ErrNilHost is returned when trying to instantiate a network with a nil host

This section is empty.

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

Host wraps a libp2p host. It contains the current pubsub state. Host implements the Network interface

func NewNetwork(h host.Host) (*Network, error)

NewNetwork returns a Network

func (n *Network) AddrInfo() peer.AddrInfo

AddrInfo returns the host's AddrInfo

func (n *Network) Connect(p peer.AddrInfo) error

Connect connects directly to a peer

func (n *Network) Messages() <-chan []byte

Messages returns the receive-only pubsub message channel

func (n *Network) MultiAddrs() []string

func (n *Network) PeerID() peer.ID

func (n *Network) Peers() []peer.ID

func (n *Network) Publish(ctx context.Context, data []byte) error

Publish publishes some data

func (n *Network) RegisterStreamHandler(id core.ProtocolID, handler network.StreamHandler)

RegisterStreamHandler registers a handler and protocol ID on the libp2p host

func (n *Network) Send(ctx context.Context, protocol core.ProtocolID, p peer.ID, data []byte) error

Send opens a stream and sends data to the given peer

func (n *Network) Start() error

Start begins pubsub by subscribing to the markets topic

func (n *Network) Stop() error

Stop cancels all subscriptions