basichost

package

v0.0.0-...-f5aa18a Latest Latest Go to latest Published: Jun 12, 2017 License: MIT Imports: 17 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

Repository

github.com/ericxtang/livepeer-libp2p-spike

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type BasicHost
- func New(net inet.Network, opts ...interface{}) *BasicHost
type Option

Constants ¶

This section is empty.

Variables ¶

View Source

var NegotiateTimeout = time.Second * 60

Functions ¶

This section is empty.

Types ¶

type BasicHost ¶

type BasicHost struct {
	NegotiateTimeout time.Duration
	// contains filtered or unexported fields
}

BasicHost is the basic implementation of the host.Host interface. This particular host implementation:

uses a protocol muxer to mux per-protocol streams
uses an identity service to send + receive node information
uses a nat service to establish NAT port mappings

func New ¶

func New(net inet.Network, opts ...interface{}) *BasicHost

New constructs and sets up a new *BasicHost with given Network

func (*BasicHost) AddVideoStreamNetwork ¶

func (h *BasicHost) AddVideoStreamNetwork(strmID string, ntwk inet.Network)

func (*BasicHost) Addrs ¶

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

Addrs returns all the addresses of BasicHost at this moment in time. It's ok to not include addresses if they're not available to be used now.

func (*BasicHost) Close ¶

func (h *BasicHost) Close() error

Close shuts down the Host's services (network, etc).

func (*BasicHost) Connect ¶

func (h *BasicHost) Connect(ctx context.Context, pi pstore.PeerInfo) error

Connect ensures there is a connection between this host and the peer with given peer.ID. Connect will absorb the addresses in pi into its internal peerstore. If there is not an active connection, Connect will issue a h.Network.Dial, and block until a connection is open, or an error is returned.

func (*BasicHost) GetBandwidthReporter ¶

func (h *BasicHost) GetBandwidthReporter() metrics.Reporter

GetBandwidthReporter exposes the Host's bandiwth metrics reporter

func (*BasicHost) ID ¶

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

ID returns the (local) peer.ID associated with this Host

func (*BasicHost) IDService ¶

func (h *BasicHost) IDService() *identify.IDService

IDService returns

func (*BasicHost) Mux ¶

func (h *BasicHost) Mux() *msmux.MultistreamMuxer

Mux returns the Mux multiplexing incoming streams to protocol handlers

func (*BasicHost) Network ¶

func (h *BasicHost) Network() inet.Network

Network returns the Network interface of the Host

func (*BasicHost) NewStream ¶

func (h *BasicHost) NewStream(ctx context.Context, p peer.ID, pids ...protocol.ID) (inet.Stream, error)

NewStream opens a new stream to given peer p, and writes a p2p/protocol header with given protocol.ID. If there is no connection to p, attempts to create one. If ProtocolID is "", writes no header. (Threadsafe)

func (*BasicHost) Peerstore ¶

func (h *BasicHost) Peerstore() pstore.Peerstore

Peerstore returns the Host's repository of Peer Addresses and Keys.

func (*BasicHost) RemoveStreamHandler ¶

func (h *BasicHost) RemoveStreamHandler(pid protocol.ID)

RemoveStreamHandler returns ..

func (*BasicHost) RemoveVideoStreamNetwork ¶

func (h *BasicHost) RemoveVideoStreamNetwork(strmID string)

func (*BasicHost) SetStreamHandler ¶

func (h *BasicHost) SetStreamHandler(pid protocol.ID, handler inet.StreamHandler)

SetStreamHandler sets the protocol handler on the Host's Mux. This is equivalent to:

host.Mux().SetHandler(proto, handler)

(Threadsafe)

func (*BasicHost) SetStreamHandlerMatch ¶

func (h *BasicHost) SetStreamHandlerMatch(pid protocol.ID, m func(string) bool, handler inet.StreamHandler)

SetStreamHandlerMatch sets the protocol handler on the Host's Mux using a matching function to do protocol comparisons

type Option ¶

type Option int

Option is a type used to pass in options to the host.

const (
	// NATPortMap makes the host attempt to open port-mapping in NAT devices
	// for all its listeners. Pass in this option in the constructor to
	// asynchronously a) find a gateway, b) open port mappings, c) republish
	// port mappings periodically. The NATed addresses are included in the
	// Host's Addrs() list.
	NATPortMap Option = iota
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL