Documentation
¶
Overview ¶
Package transport provides a set of definitions of abstractions that layer above the implementation enabling the use of simple functions that interact on channels to queue and receive messages from the tpt.Transport of which several variants are here implemented.
Index ¶
- Constants
- Variables
- func BadgerStore(dataPath string) (datastore.Batching, func())
- func Discover(ctx context.Context, h host.Host, dht *dht.IpfsDHT, ...)
- func GetHostFirstMultiaddr(ha host.Host) string
- func GetHostMultiaddrs(ha host.Host) (addrs []string)
- func GetHostOnlyFirstMultiaddr(ha host.Host) string
- func GetHostOnlyMultiaddrs(ha host.Host) (addrs []string)
- func NewDHT(ctx context.Context, host host.Host, bootstrapPeers []multiaddr.Multiaddr) (d *dht.IpfsDHT, e error)
- func SetUserAgent(s string)
- func Tick(h host.Host, rendezvous []multiaddr.Multiaddr, peers <-chan peer.AddrInfo, ...) (e error)
- type ByteChan
- type Conn
- type DuplexByteChan
- type Listener
- func (l *Listener) Accept() <-chan *Conn
- func (l *Listener) AddConn(d *Conn)
- func (l *Listener) DelConn(d *Conn)
- func (l *Listener) Dial(multiAddr string) (d *Conn)
- func (l *Listener) FindConn(multiAddr string) (d *Conn)
- func (l *Listener) GetConnRecv(multiAddr string) (recv tpt.Transport)
- func (l *Listener) GetConnSend(multiAddr string) (send tpt.Transport)
- func (l *Listener) ProtocolsAvailable() (p protocols.NetworkProtocols)
- func (l *Listener) SetMTU(mtu int)
Constants ¶
const ( // LocalhostZeroIPv4TCP is the default localhost to bind to any address. Used in // tests. LocalhostZeroIPv4TCP = "/ip4/127.0.0.1/tcp/0" // LocalhostZeroIPv6TCP is the default localhost to bind to any address. Used in // tests. LocalhostZeroIPv6TCP = "/ip6/::1/tcp/0" // DefaultMTU is the default maximum size for a packet. DefaultMTU = 1382 // ConnBufs is the number of buffers to use in message dispatch channels. ConnBufs = 8192 // IndraLibP2PID is the indra protocol identifier. IndraLibP2PID = "/indra/relay/" + indra.SemVer )
Variables ¶
var (
DefaultUserAgent = "/indra:" + indra.SemVer + "/"
)
Functions ¶
func BadgerStore ¶ added in v0.1.19
func BadgerStore(dataPath string) (datastore.Batching, func())
BadgerStore creates a new badger database backed persistence engine for keys and values used in the peer information database.
func GetHostFirstMultiaddr ¶ added in v0.1.20
GetHostFirstMultiaddr returns the multiaddr string encoding of a host.Host's network listener.
func GetHostMultiaddrs ¶ added in v0.1.20
GetHostMultiaddrs returns the multiaddr strings encoding of a host.Host's network listener.
This includes (the repeated) p2p key sections of the peer identity key.
func GetHostOnlyFirstMultiaddr ¶ added in v0.1.20
GetHostOnlyFirstMultiaddr returns the multiaddr string without the p2p key.
func GetHostOnlyMultiaddrs ¶ added in v0.1.20
GetHostOnlyMultiaddrs returns the multiaddr string without the p2p key.
func NewDHT ¶
func NewDHT(ctx context.Context, host host.Host, bootstrapPeers []multiaddr.Multiaddr) (d *dht.IpfsDHT, e error)
NewDHT sets up a DHT for use in searching and propagating peer information.
func SetUserAgent ¶ added in v0.1.16
func SetUserAgent(s string)
SetUserAgent changes the user agent. Note that this will only have an effect before a new listener is created.
Types ¶
type ByteChan ¶
ByteChan is the most primitive form of an atomic FIFO queue used to dispatch jobs to a network I/O handler.
func NewByteChan ¶
NewByteChan creates a new ByteChan with a specified number of buffers.
type Conn ¶
type Conn struct {
// Conn is the actual network connection, which is a ReaderWriterCloser.
network.Conn
// MTU is the size of packet segments handled on the connection.
MTU int
// RemoteKey is the receiver public key messages should be encrypted to.
//
// todo: this is also handled by the dispatcher for key changes etc?
RemoteKey *crypto.Pub
// MultiAddr is the multiaddr.Multiaddr of the other side of the connection.
MultiAddr multiaddr.Multiaddr
// Host is the libp2p host implementing the Conn.
Host host.Host
// Transport is the duplex channel that is given to calling code to dispatch
// messages through the Conn.
Transport *DuplexByteChan
// Mutex to prevent concurrent read/write of shared data.
sync.Mutex
// C can be closed to shut down the connection, and closes the Conn.
qu.C
// contains filtered or unexported fields
}
Conn is a wrapper around the bidirectional connection established between two peers via the libp2p API.
func (*Conn) GetRecv ¶
GetRecv returns the Transport that is functioning as receiver, used to receive messages.
func (*Conn) GetRemoteKey ¶
GetRemoteKey ruturns the current remote receiver public key we want to encrypt to (with ECDH).
func (*Conn) GetSend ¶
GetSend returns the Transport that is functioning as sender, used to send messages.
func (*Conn) SetRemoteKey ¶
SetRemoteKey changes the key that should be used with ECDH to generate message encryption secrets. This will be called in response to the other side sending a key change message.
type DuplexByteChan ¶
type DuplexByteChan struct {
// Receiver and Sender can send and receive in parallel.
Receiver, Sender tpt.Transport
}
DuplexByteChan is intended to be connected up in chains with other processing steps as a pipeline. The send and receive functions send bytes to their respective send and receive channels, and the processing is added by a consuming type by listening to the send channel for requests to send, and forwarding data from the upstream to the recieve channel.
func NewDuplexByteChan ¶
func NewDuplexByteChan(bufs int) *DuplexByteChan
NewDuplexByteChan creates a new DuplexByteChan with each of the two channels given a specified number of buffer queue slots.
func NewSimDuplex ¶
func NewSimDuplex(bufs int, ctx context.Context) (d *DuplexByteChan)
NewSimDuplex creates a DuplexByteChan that behaves like a single ByteChan by forwarding from the send channel to the receiver channel. This creates something like a virtual in memory packet connection, as used in many of the Onion tests for testing correct forwarding without a full network.
A network-using version of the same tests should also work exactly the same.
func (*DuplexByteChan) Receive ¶
func (d *DuplexByteChan) Receive() (C <-chan slice.Bytes)
Receive messages from the receiver channel of the DuplexByteChan.
type Listener ¶
type Listener struct {
// The DHT is used by peer discovery and peer information gossip to provide
// information to clients to enable them to set up sessions and then send traffic
// through them.
DHT *dht.IpfsDHT
// MTU is the size of the packets that should be used by the dispatcher, which
// should be the same as the Path MTU between the node and its routeable internet
// address.
MTU int
// Host is the libp2p peer management system and provides access to all the
// connectivity and related services provided by libp2p.
Host host.Host
// Keys are this node's identity keys, used for identification and authentication
// of peer advertisements.
*crypto.Keys
// Context here allows listener processes to be signalled to shut down.
context.Context
// Mutex because any number of threads can be handling Listener work.
sync.Mutex
// contains filtered or unexported fields
}
Listener is a libp2p connected network transport with a DHT and peer information gossip exchange system that carries the advertisements for services and relays providing access to them.
func NewListener ¶
func NewListener(rendezvous, multiAddr []string, storePath string, keys *crypto.Keys, ctx context.Context, mtu int) (c *Listener, e error)
NewListener creates a new Listener with the given parameters.
func (*Listener) Accept ¶
Accept waits on inbound connections and hands them out to listeners on the returned channel.
func (*Listener) AddConn ¶
AddConn adds a new connection, including dispatching it to any callers of Accept.
func (*Listener) FindConn ¶
FindConn searches a Listener's collection of connections for the one matching a given multiaddr string.
func (*Listener) GetConnRecv ¶
GetConnRecv searches a Listener's collection of connections for the one matching a given multiaddr string, and returns the transport for receiving messages.
func (*Listener) GetConnSend ¶
GetConnSend searches a Listener's collection of connections for the one matching a given multiaddr string, and returns the transport for sending messages.
func (*Listener) ProtocolsAvailable ¶ added in v0.1.19
func (l *Listener) ProtocolsAvailable() (p protocols.NetworkProtocols)
Source Files