routing

Documentation

Index

• func NewParamNeededErr(param string, routing config.RouterType) error
• func Parse(routers config.Routers, methods config.Methods, extraDHT *ExtraDHTParams, ...) (routing.Routing, error)
• type Composer
  • func (c *Composer) Bootstrap(ctx context.Context) error
  • func (c *Composer) FindPeer(ctx context.Context, pid peer.ID) (peer.AddrInfo, error)
  • func (c *Composer) FindProvidersAsync(ctx context.Context, cid cid.Cid, count int) <-chan peer.AddrInfo
  • func (c *Composer) GetValue(ctx context.Context, key string, opts ...routing.Option) ([]byte, error)
  • func (c *Composer) Provide(ctx context.Context, cid cid.Cid, provide bool) error
  • func (c *Composer) ProvideMany(ctx context.Context, keys []multihash.Multihash) error
  • func (c *Composer) PutValue(ctx context.Context, key string, val []byte, opts ...routing.Option) error
  • func (c *Composer) Ready() bool
  • func (c *Composer) SearchValue(ctx context.Context, key string, opts ...routing.Option) (<-chan []byte, error)
• type ExtraDHTParams
• type ExtraReframeParams
• type ParamNeededError
  • func (e *ParamNeededError) Error() string
• type ProvideManyRouter

Functions

func NewParamNeededErr

func NewParamNeededErr(param string, routing config.RouterType) error

func Parse

func Parse(routers config.Routers, methods config.Methods, extraDHT *ExtraDHTParams, extraReframe *ExtraReframeParams) (routing.Routing, error)

Types

type Composer

type Composer struct {
	GetValueRouter      routing.Routing
	PutValueRouter      routing.Routing
	FindPeersRouter     routing.Routing
	FindProvidersRouter routing.Routing
	ProvideRouter       routing.Routing
}

func (*Composer) Bootstrap

func (c *Composer) Bootstrap(ctx context.Context) error

func (*Composer) FindPeer

func (c *Composer) FindPeer(ctx context.Context, pid peer.ID) (peer.AddrInfo, error)

func (*Composer) FindProvidersAsync

func (c *Composer) FindProvidersAsync(ctx context.Context, cid cid.Cid, count int) <-chan peer.AddrInfo

func (*Composer) GetValue

func (c *Composer) GetValue(ctx context.Context, key string, opts ...routing.Option) ([]byte, error)

func (*Composer) Provide

func (c *Composer) Provide(ctx context.Context, cid cid.Cid, provide bool) error

func (*Composer) ProvideMany

func (c *Composer) ProvideMany(ctx context.Context, keys []multihash.Multihash) error

func (*Composer) PutValue

func (c *Composer) PutValue(ctx context.Context, key string, val []byte, opts ...routing.Option) error

func (*Composer) Ready

func (c *Composer) Ready() bool

func (*Composer) SearchValue

func (c *Composer) SearchValue(ctx context.Context, key string, opts ...routing.Option) (<-chan []byte, error)

type ExtraDHTParams

type ExtraDHTParams struct {
	BootstrapPeers []peer.AddrInfo
	Host           host.Host
	Validator      record.Validator
	Datastore      datastore.Batching
	Context        context.Context
}

type ExtraReframeParams

type ExtraReframeParams struct {
	PeerID     string
	Addrs      []string
	PrivKeyB64 string
}

type ParamNeededError

type ParamNeededError struct {
	ParamName  string
	RouterType config.RouterType
}

func (*ParamNeededError) Error

func (e *ParamNeededError) Error() string

type ProvideManyRouter

type ProvideManyRouter interface {
	routinghelpers.ProvideManyRouter
	routing.Routing
}