contentrouting

type Routing ¶

type Routing interface {
	FindProviders(context.Context, cid.Cid, ...RoutingOptions) <-chan RoutingRecord
}

The Routing interface is an evolution of the ContentRouting interface found in [libp2p](https://github.com/libp2p/go-libp2p-core/blob/master/routing/routing.go#L26).

Routing focuses only on the retrieval half of the interface: how do I located content given a content identifier?

The returned channel of RoutingRecords must be consumed until closed by the Caller. The same instance of a provider may block if previous calls have left un-drained records. The provider will close the channel once complete or once the context is canceled.

type RoutingError ¶

type RoutingError struct {
	cid.Cid
	Error error
}

RoutingError is a RoutingRecord used for signalling an underlying error

func (r *RoutingError) Payload() interface{}

func (r *RoutingError) Protocol() multicodec.Code

func (r *RoutingError) Provider() interface{}

func (r *RoutingError) Request() cid.Cid

type RoutingOptions ¶

type RoutingOptions func()

RoutingOptions further specify a content routing request

type RoutingRecord ¶

type RoutingRecord interface {
	Request() cid.Cid
	Protocol() multicodec.Code
	Provider() interface{}
	Payload() interface{}
}

A RoutingRecord is an abstract record of a content routing response.

func RecordError(c cid.Cid, err error) RoutingRecord