mirror of
https://github.com/ipfs/kubo.git
synced 2025-09-11 07:03:32 +08:00
f25893e31a
having an error return value makes the interface a bit confusing to use. Just ponder... What would an error returned from a predicate function mean? License: MIT Signed-off-by: Brian Tiger Chow <brian@perfmode.com>
78 lines
2.5 KiB
Go
78 lines
2.5 KiB
Go
package net
|
|
|
|
import (
|
|
"github.com/jbenet/go-ipfs/Godeps/_workspace/src/code.google.com/p/go.net/context"
|
|
conn "github.com/jbenet/go-ipfs/net/conn"
|
|
msg "github.com/jbenet/go-ipfs/net/message"
|
|
mux "github.com/jbenet/go-ipfs/net/mux"
|
|
srv "github.com/jbenet/go-ipfs/net/service"
|
|
peer "github.com/jbenet/go-ipfs/peer"
|
|
ctxc "github.com/jbenet/go-ipfs/util/ctxcloser"
|
|
|
|
ma "github.com/jbenet/go-ipfs/Godeps/_workspace/src/github.com/jbenet/go-multiaddr"
|
|
)
|
|
|
|
// Network is the interface IPFS uses for connecting to the world.
|
|
type Network interface {
|
|
ctxc.ContextCloser
|
|
|
|
// Listen handles incoming connections on given Multiaddr.
|
|
// Listen(*ma.Muliaddr) error
|
|
// TODO: for now, only listen on addrs in local peer when initializing.
|
|
|
|
// DialPeer attempts to establish a connection to a given peer
|
|
DialPeer(context.Context, peer.Peer) error
|
|
|
|
// ClosePeer connection to peer
|
|
ClosePeer(peer.Peer) error
|
|
|
|
// IsConnected returns whether a connection to given peer exists.
|
|
IsConnected(peer.Peer) bool
|
|
|
|
// GetProtocols returns the protocols registered in the network.
|
|
GetProtocols() *mux.ProtocolMap
|
|
|
|
// GetPeerList returns the list of peers currently connected in this network.
|
|
GetPeerList() []peer.Peer
|
|
|
|
// GetConnections returns the list of connections currently open in this network.
|
|
GetConnections() []conn.Conn
|
|
|
|
// GetBandwidthTotals returns the total number of bytes passed through
|
|
// the network since it was instantiated
|
|
GetBandwidthTotals() (uint64, uint64)
|
|
|
|
// GetMessageCounts returns the total number of messages passed through
|
|
// the network since it was instantiated
|
|
GetMessageCounts() (uint64, uint64)
|
|
|
|
// SendMessage sends given Message out
|
|
SendMessage(msg.NetMessage) error
|
|
|
|
// ListenAddresses returns a list of addresses at which this network listens.
|
|
ListenAddresses() []ma.Multiaddr
|
|
|
|
// InterfaceListenAddresses returns a list of addresses at which this network
|
|
// listens. It expands "any interface" addresses (/ip4/0.0.0.0, /ip6/::) to
|
|
// use the known local interfaces.
|
|
InterfaceListenAddresses() ([]ma.Multiaddr, error)
|
|
}
|
|
|
|
// Sender interface for network services.
|
|
type Sender srv.Sender
|
|
|
|
// Handler interface for network services.
|
|
type Handler srv.Handler
|
|
|
|
// Service interface for network resources.
|
|
type Service srv.Service
|
|
|
|
// Dialer represents a service that can dial out to peers
|
|
// (this is usually just a Network, but other services may not need the whole
|
|
// stack, and thus it becomes easier to mock)
|
|
type Dialer interface {
|
|
|
|
// DialPeer attempts to establish a connection to a given peer
|
|
DialPeer(context.Context, peer.Peer) error
|
|
}
|