server

package
v1.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 29, 2024 License: MIT Imports: 22 Imported by: 1

Documentation

Overview

nolint

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrNotConnected is returned when peer is not connected.
	ErrNotConnected = errors.New("peer is not connected")
	// ErrPeerResponseFailed raised if peer responded with an error.
	ErrPeerResponseFailed = errors.New("peer response failed")
)

Functions

func ReadResponse added in v1.4.1 

func ReadResponse(r io.Reader, toCall func(resLen uint32) (int, error)) (int, error)

func WriteErrorResponse added in v1.4.1 

func WriteErrorResponse(w io.Writer, respErr error) error

Types

type DecayingTagSpec added in v1.3.10 

type DecayingTagSpec struct {
	Interval time.Duration `mapstructure:"interval"`
	Inc      int           `mapstructure:"inc"`
	Dec      int           `mapstructure:"dec"`
	Cap      int           `mapstructure:"cap"`
}

type Handler added in v1.0.0 

type Handler func(context.Context, []byte) ([]byte, error)

Handler is a handler to be defined by the application.

type Host added in v1.0.0 

type Host interface {
	SetStreamHandler(protocol.ID, network.StreamHandler)
	NewStream(context.Context, peer.ID, ...protocol.ID) (network.Stream, error)
	Network() network.Network
	ConnManager() connmgr.ConnManager
}

Host is a subset of libp2p Host interface that needs to be implemented to be usable with server.

type Opt added in v1.0.0 

type Opt func(s *Server)

Opt is a type to configure a server.

func WithDecayingTag added in v1.3.10 

func WithDecayingTag(tag DecayingTagSpec) Opt

func WithHardTimeout added in v1.3.6 

func WithHardTimeout(timeout time.Duration) Opt

WithHardTimeout configures the hard timeout for requests. Requests are terminated if they take longer than the specified duration.

func WithLog added in v1.0.0 

func WithLog(log log.Log) Opt

WithLog configures logger for the server.

func WithMetrics added in v1.3.0 

func WithMetrics() Opt

WithMetrics will enable metrics collection in the server.

func WithQueueSize added in v1.3.0 

func WithQueueSize(size int) Opt

WithQueueSize parametrize number of message that will be kept in queue and eventually processed by server. Otherwise stream is closed immediately.

Size of the queue should be set to account for maximum expected latency, such as if expected latency is 10s and server processes 1000 requests per second size should be 100.

Defaults to 100.

func WithRequestSizeLimit added in v1.0.0 

func WithRequestSizeLimit(limit int) Opt

func WithRequestsPerInterval added in v1.3.0 

func WithRequestsPerInterval(n int, interval time.Duration) Opt

WithRequestsPerInterval parametrizes server rate limit to limit maximum amount of bandwidth that this handler can consume.

Defaults to 100 requests per second.

func WithTimeout added in v1.0.0 

func WithTimeout(timeout time.Duration) Opt

WithTimeout configures stream timeout. The requests are terminated when no data is received or sent for the specified duration.

type Response added in v1.0.0 

type Response struct {
	// keep in line with limit of ResponseMessage.Data in `fetch/wire_types.go`
	Data  []byte `scale:"max=125829120"` // 120 MiB > 3.5 mio ATX * 32 bytes per ID
	Error string `scale:"max=1024"`      // TODO(mafa): make error code instead of string
}

Response is a server response.

func (*Response) DecodeScale added in v1.0.0 

func (t *Response) DecodeScale(dec *scale.Decoder) (total int, err error)

func (*Response) EncodeScale added in v1.0.0 

func (t *Response) EncodeScale(enc *scale.Encoder) (total int, err error)

type Server added in v1.0.0 

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

Server for the Handler.

func New added in v1.0.0 

func New(h Host, proto string, handler StreamHandler, opts ...Opt) *Server

New server for the handler.

func (*Server) NumAcceptedRequests added in v1.4.3 

func (s *Server) NumAcceptedRequests() int

NumAcceptedRequests returns the number of accepted requests for this server. It is used for testing.

func (*Server) Request added in v1.0.0 

func (s *Server) Request(ctx context.Context, pid peer.ID, req []byte, extraProtocols ...string) ([]byte, error)

Request sends a binary request to the peer.

func (*Server) Run added in v1.3.0 

func (s *Server) Run(ctx context.Context) error

func (*Server) StreamRequest added in v1.4.1 

func (s *Server) StreamRequest(
	ctx context.Context,
	pid peer.ID,
	req []byte,
	callback StreamRequestCallback,
	extraProtocols ...string,
) error

StreamRequest sends a binary request to the peer. The response is read from the stream by the specified callback.

type ServerError added in v1.4.1 

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

ServerError is used by the client (Request/StreamRequest) to represent an error returned by the server.

func NewServerError added in v1.4.1 

func NewServerError(msg string) *ServerError

func (*ServerError) Error added in v1.4.1 

func (err *ServerError) Error() string

func (*ServerError) Is added in v1.4.1 

func (*ServerError) Is(target error) bool

type StreamHandler added in v1.4.1 

type StreamHandler func(context.Context, []byte, io.ReadWriter) error

StreamHandler is a handler that writes the response to the stream directly instead of buffering the serialized representation.

func WrapHandler added in v1.4.1 

func WrapHandler(handler Handler) StreamHandler

type StreamRequestCallback added in v1.4.1 

type StreamRequestCallback func(context.Context, io.ReadWriter) error

StreamRequestCallback is a function that executes a streamed request.

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.