Documentation
¶
Overview ¶
Package retrieval provides the retrieval protocol implementation. The protocol is used to retrieve chunks over the network using forwarding-kademlia routing.
Index ¶
- Constants
- type Interface
- type Service
- func (s *Service) Close() error
- func (s *Service) Metrics() []prometheus.Collector
- func (s *Service) Protocol() p2p.ProtocolSpec
- func (s *Service) RetrieveChunk(ctx context.Context, chunkAddr, sourcePeerAddr swarm.Address) (swarm.Chunk, error)
- func (s *Service) StatusMetrics() []prometheus.Collector
- type Storer
Constants ¶
View Source
const (
RetrieveChunkTimeout = time.Second * 30
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Interface ¶
type Interface interface { // RetrieveChunk retrieves a chunk from the network using the retrieval protocol. // it takes as parameters a context, a chunk address to retrieve (content-addressed or single-owner) and // a source peer address, for the case that we are requesting the chunk for another peer. In case the request // originates at the current node (i.e. no forwarding involved), the caller should use swarm.ZeroAddress // as the value for sourcePeerAddress. RetrieveChunk(ctx context.Context, address, sourcePeerAddr swarm.Address) (chunk swarm.Chunk, err error) }
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func (*Service) Metrics ¶
func (s *Service) Metrics() []prometheus.Collector
func (*Service) Protocol ¶
func (s *Service) Protocol() p2p.ProtocolSpec
func (*Service) RetrieveChunk ¶
func (*Service) StatusMetrics ¶ added in v2.6.0
func (s *Service) StatusMetrics() []prometheus.Collector
StatusMetrics exposes metrics that are exposed on the status protocol.
Click to show internal directories.
Click to hide internal directories.