p2p

Documentation

Index

• Variables
• func ProtocolID(networkID, protocolString string) protocol.ID
• func RateLimitMiddleware(inner network.StreamHandler, concurrencyLimit int) network.StreamHandler
• type Parameters
  • func DefaultParameters() *Parameters
  • func (p *Parameters) NetworkID() string
  • func (p *Parameters) Validate() error
  • func (p *Parameters) WithNetworkID(networkID string)

Variables

var ErrInvalidResponse = errors.New("server returned an invalid response or caused an internal error")

ErrInvalidResponse is returned when a peer returns an invalid response or caused an internal error. It is used to signal that the peer couldn't serve the data successfully, and should not be retried.

var ErrUnavailable = errors.New("server cannot serve the requested data at this time")

ErrUnavailable is returned when a peer doesn't have the requested data or doesn't have the capacity to serve it at the moment. It is used to signal that the peer couldn't serve the data successfully, but should be retried later.

Functions

func ProtocolID

func ProtocolID(networkID, protocolString string) protocol.ID

ProtocolID creates a protocol ID string according to common format

func RateLimitMiddleware

func RateLimitMiddleware(inner network.StreamHandler, concurrencyLimit int) network.StreamHandler

Types

type Parameters

type Parameters struct {
	// ServerReadTimeout sets the timeout for reading messages from the stream.
	ServerReadTimeout time.Duration

	// ServerWriteTimeout sets the timeout for writing messages to the stream.
	ServerWriteTimeout time.Duration

	// HandleRequestTimeout defines the deadline for handling request.
	HandleRequestTimeout time.Duration

	// ConcurrencyLimit is the maximum number of concurrently handled streams
	ConcurrencyLimit int
	// contains filtered or unexported fields
}

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

func DefaultParameters

func DefaultParameters() *Parameters

func (*Parameters) NetworkID

func (p *Parameters) NetworkID() string

NetworkID returns the value of networkID stored in params

func (*Parameters) Validate

func (p *Parameters) Validate() error

func (*Parameters) WithNetworkID

func (p *Parameters) WithNetworkID(networkID string)

WithNetworkID sets the value of networkID in params