mirror of
https://github.com/ipfs/kubo.git
synced 2025-09-10 11:52:21 +08:00
50 lines
1.5 KiB
Go
50 lines
1.5 KiB
Go
// package routing defines the interface for a routing system used by ipfs.
|
|
package routing
|
|
|
|
import (
|
|
"errors"
|
|
"time"
|
|
|
|
context "github.com/jbenet/go-ipfs/Godeps/_workspace/src/code.google.com/p/go.net/context"
|
|
|
|
peer "github.com/jbenet/go-ipfs/p2p/peer"
|
|
u "github.com/jbenet/go-ipfs/util"
|
|
)
|
|
|
|
// ErrNotFound is returned when a search fails to find anything
|
|
var ErrNotFound = errors.New("routing: not found")
|
|
|
|
// IpfsRouting is the routing module interface
|
|
// It is implemented by things like DHTs, etc.
|
|
type IpfsRouting interface {
|
|
FindProvidersAsync(context.Context, u.Key, int) <-chan peer.PeerInfo
|
|
|
|
// Basic Put/Get
|
|
|
|
// PutValue adds value corresponding to given Key.
|
|
PutValue(context.Context, u.Key, []byte) error
|
|
|
|
// GetValue searches for the value corresponding to given Key.
|
|
GetValue(context.Context, u.Key) ([]byte, error)
|
|
|
|
// Value provider layer of indirection.
|
|
// This is what DSHTs (Coral and MainlineDHT) do to store large values in a DHT.
|
|
|
|
// Announce that this node can provide value for given key
|
|
Provide(context.Context, u.Key) error
|
|
|
|
// Find specific Peer
|
|
// FindPeer searches for a peer with given ID, returns a peer.PeerInfo
|
|
// with relevant addresses.
|
|
FindPeer(context.Context, peer.ID) (peer.PeerInfo, error)
|
|
|
|
// Ping a peer, log the time it took
|
|
Ping(context.Context, peer.ID) (time.Duration, error)
|
|
|
|
// Bootstrap allows callers to hint to the routing system to get into a
|
|
// Boostrapped state
|
|
Bootstrap(context.Context) error
|
|
|
|
// TODO expose io.Closer or plain-old Close error
|
|
}
|