mirror of
https://github.com/libp2p/go-libp2p-core.git
synced 2024-12-26 23:30:27 +08:00
76 lines
2.6 KiB
Go
76 lines
2.6 KiB
Go
// Package host provides the core Host interface for libp2p.
|
|
//
|
|
// Host represents a single libp2p node in a peer-to-peer network.
|
|
package host
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/libp2p/go-libp2p-core/connmgr"
|
|
"github.com/libp2p/go-libp2p-core/event"
|
|
"github.com/libp2p/go-libp2p-core/network"
|
|
"github.com/libp2p/go-libp2p-core/peer"
|
|
"github.com/libp2p/go-libp2p-core/peerstore"
|
|
"github.com/libp2p/go-libp2p-core/protocol"
|
|
|
|
ma "github.com/multiformats/go-multiaddr"
|
|
)
|
|
|
|
// Host is an object participating in a p2p network, which
|
|
// implements protocols or provides services. It handles
|
|
// requests like a Server, and issues requests like a Client.
|
|
// It is called Host because it is both Server and Client (and Peer
|
|
// may be confusing).
|
|
type Host interface {
|
|
// ID returns the (local) peer.ID associated with this Host
|
|
ID() peer.ID
|
|
|
|
// Peerstore returns the Host's repository of Peer Addresses and Keys.
|
|
Peerstore() peerstore.Peerstore
|
|
|
|
// Returns the listen addresses of the Host
|
|
Addrs() []ma.Multiaddr
|
|
|
|
// Networks returns the Network interface of the Host
|
|
Network() network.Network
|
|
|
|
// Mux returns the Mux multiplexing incoming streams to protocol handlers
|
|
Mux() protocol.Switch
|
|
|
|
// 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. // TODO: Relay + NAT.
|
|
Connect(ctx context.Context, pi peer.AddrInfo) error
|
|
|
|
// SetStreamHandler sets the protocol handler on the Host's Mux.
|
|
// This is equivalent to:
|
|
// host.Mux().SetHandler(proto, handler)
|
|
// (Threadsafe)
|
|
SetStreamHandler(pid protocol.ID, handler network.StreamHandler)
|
|
|
|
// SetStreamHandlerMatch sets the protocol handler on the Host's Mux
|
|
// using a matching function for protocol selection.
|
|
SetStreamHandlerMatch(protocol.ID, func(string) bool, network.StreamHandler)
|
|
|
|
// RemoveStreamHandler removes a handler on the mux that was set by
|
|
// SetStreamHandler
|
|
RemoveStreamHandler(pid protocol.ID)
|
|
|
|
// NewStream opens a new stream to given peer p, and writes a p2p/protocol
|
|
// header with given ProtocolID. If there is no connection to p, attempts
|
|
// to create one. If ProtocolID is "", writes no header.
|
|
// (Threadsafe)
|
|
NewStream(ctx context.Context, p peer.ID, pids ...protocol.ID) (network.Stream, error)
|
|
|
|
// Close shuts down the host, its Network, and services.
|
|
Close() error
|
|
|
|
// ConnManager returns this hosts connection manager
|
|
ConnManager() connmgr.ConnManager
|
|
|
|
// EventBus returns the hosts eventbus
|
|
EventBus() event.Bus
|
|
}
|