mirror of
https://github.com/ipfs/kubo.git
synced 2025-07-01 02:30:39 +08:00
some net docs
This commit is contained in:
@ -22,7 +22,7 @@ type Conn interface {
|
|||||||
// LocalMultiaddr is the Multiaddr on this side
|
// LocalMultiaddr is the Multiaddr on this side
|
||||||
LocalMultiaddr() ma.Multiaddr
|
LocalMultiaddr() ma.Multiaddr
|
||||||
|
|
||||||
// LocalPeer is the Peer on this side
|
// LocalPeer is the Peer on our side of the connection
|
||||||
LocalPeer() peer.Peer
|
LocalPeer() peer.Peer
|
||||||
|
|
||||||
// RemoteMultiaddr is the Multiaddr on the remote side
|
// RemoteMultiaddr is the Multiaddr on the remote side
|
||||||
@ -37,10 +37,9 @@ type Conn interface {
|
|||||||
// Out returns a writable message channel
|
// Out returns a writable message channel
|
||||||
Out() chan<- []byte
|
Out() chan<- []byte
|
||||||
|
|
||||||
|
// Get an error from this conn if one is available
|
||||||
|
// TODO: implement a better error handling system
|
||||||
GetError() error
|
GetError() error
|
||||||
|
|
||||||
// Close ends the connection
|
|
||||||
// Close() error -- already in ContextCloser
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Dialer is an object that can open connections. We could have a "convenience"
|
// Dialer is an object that can open connections. We could have a "convenience"
|
||||||
|
@ -59,9 +59,9 @@ type Handler srv.Handler
|
|||||||
// Service interface for network resources.
|
// Service interface for network resources.
|
||||||
type Service srv.Service
|
type Service srv.Service
|
||||||
|
|
||||||
// Dialer service that can dial to peers
|
// Dialer represents a service that can dial out to peers
|
||||||
// (this is usually just a Network, but other services may not need the whole
|
// (this is usually just a Network, but other services may not need the whole
|
||||||
// thing, and thus it becomes easier to mock)
|
// stack, and thus it becomes easier to mock)
|
||||||
type Dialer interface {
|
type Dialer interface {
|
||||||
|
|
||||||
// DialPeer attempts to establish a connection to a given peer
|
// DialPeer attempts to establish a connection to a given peer
|
||||||
|
Reference in New Issue
Block a user