shrexnd

Documentation

Index

• type Client
  • func NewClient(params *Parameters, host host.Host) (*Client, error)
  • func (c *Client) RequestND(ctx context.Context, root *share.Root, namespace share.Namespace, peer peer.ID) (share.NamespacedShares, error)
  • func (c *Client) WithMetrics() error
• type Parameters
  • func DefaultParameters() *Parameters
• type Server
  • func NewServer(params *Parameters, host host.Host, store *eds.Store, getter share.Getter) (*Server, error)
  • func (srv *Server) SetHandler(handler network.StreamHandler)
  • func (srv *Server) Start(context.Context) error
  • func (srv *Server) Stop(context.Context) error
  • func (srv *Server) WithMetrics() error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client implements client side of shrex/nd protocol to obtain namespaced shares data from remote peers.

func NewClient

func NewClient(params *Parameters, host host.Host) (*Client, error)

NewClient creates a new shrEx/nd client

func (*Client) RequestND

func (c *Client) RequestND(
	ctx context.Context,
	root *share.Root,
	namespace share.Namespace,
	peer peer.ID,
) (share.NamespacedShares, error)

RequestND requests namespaced data from the given peer. Returns shares with unverified inclusion proofs against the share.Root.

func (*Client) WithMetrics

func (c *Client) WithMetrics() error

type Parameters

type Parameters = p2p.Parameters

Parameters is the set of parameters that must be configured for the shrex/eds protocol.

func DefaultParameters

func DefaultParameters() *Parameters

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server implements server side of shrex/nd protocol to serve namespaced share to remote peers.

func NewServer

func NewServer(params *Parameters, host host.Host, store *eds.Store, getter share.Getter) (*Server, error)

NewServer creates new Server

func (*Server) SetHandler

func (srv *Server) SetHandler(handler network.StreamHandler)

SetHandler sets server handler

func (*Server) Start

func (srv *Server) Start(context.Context) error

Start starts the server

func (*Server) Stop

func (srv *Server) Stop(context.Context) error

Stop stops the server

func (*Server) WithMetrics

func (srv *Server) WithMetrics() error