server

Documentation

Overview

nolint

Index

• Variables
• type Handler
• type Host
• type Opt
  • func WithContext(ctx context.Context) Opt
  • func WithLog(log log.Log) Opt
  • func WithRequestSizeLimit(limit int) Opt
  • func WithTimeout(timeout time.Duration) Opt
• type Response
  • func (t *Response) DecodeScale(dec *scale.Decoder) (total int, err error)
  • func (t *Response) EncodeScale(enc *scale.Encoder) (total int, err error)
• type Server
  • func New(h Host, proto string, handler Handler, opts ...Opt) *Server
  • func (s *Server) Request(ctx context.Context, pid peer.ID, req []byte, resp func([]byte), ...) error

Variables

var ErrNotConnected = errors.New("peer is not connected")

ErrNotConnected is returned when peer is not connected.

Types

type Handler

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

Handler is the handler to be defined by the application.

type Host

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

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

type Opt

type Opt func(s *Server)

Opt is a type to configure a server.

func WithContext

func WithContext(ctx context.Context) Opt

WithContext configures parent context for contexts that are passed to the handler.

func WithLog

func WithLog(log log.Log) Opt

WithLog configures logger for the server.

func WithRequestSizeLimit

func WithRequestSizeLimit(limit int) Opt

func WithTimeout

func WithTimeout(timeout time.Duration) Opt

WithTimeout configures stream timeout.

type Response

type Response struct {
	Data  []byte `scale:"max=41943040"` // 40 MiB
	Error string `scale:"max=1024"`     // TODO(mafa): make error code instead of string
}

Response is a server response.

func (*Response) DecodeScale

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

func (*Response) EncodeScale

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

type Server

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

Server for the Handler.

func New

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

New server for the handler.

func (*Server) Request

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

Request sends a binary request to the peer. Request is executed in the background, one of the callbacks is guaranteed to be called on success/error.