server

Documentation

Index

• func ContextWithMessageStream(ctx context.Context, c *jsonrpc.MessageStream) context.Context
• func ContextWithPeerInfo(ctx context.Context, c jsonrpc.PeerInfo) context.Context
• func MessageStreamFromContext(ctx context.Context) *jsonrpc.MessageStream
• func PeerInfoFromContext(ctx context.Context) jsonrpc.PeerInfo
• type Server
  • func NewServer(r jsonrpc.Handler) *Server
  • func (s *Server) ServeCodec(ctx context.Context, remote jsonrpc.ReaderWriter) error
  • func (s *Server) Shutdown(ctx context.Context) error

Functions

func ContextWithMessageStream

func ContextWithMessageStream(ctx context.Context, c *jsonrpc.MessageStream) context.Context

func ContextWithPeerInfo

func ContextWithPeerInfo(ctx context.Context, c jsonrpc.PeerInfo) context.Context

func MessageStreamFromContext

func MessageStreamFromContext(ctx context.Context) *jsonrpc.MessageStream

func PeerInfoFromContext

func PeerInfoFromContext(ctx context.Context) jsonrpc.PeerInfo

PeerInfoFromContext returns information about the client's network connection. Use this with the context passed to RPC method handler functions.

The zero value is returned if no connection info is present in ctx.

Types

type Server

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

Server is an RPC server. it is in charge of calling the handler on the message object, the json encoding of responses, and dealing with batch semantics. a server can be used to listenandserve multiple codecs at a time

func NewServer

func NewServer(r jsonrpc.Handler) *Server

NewServer creates a new server instance with no registered handlers.

func (*Server) ServeCodec

func (s *Server) ServeCodec(ctx context.Context, remote jsonrpc.ReaderWriter) error

ServeCodec reads incoming requests from codec, calls the appropriate callback and writes the response back using the given codec. It will block until the codec is closed. the codec will return if either of these conditions are met 1. every request read from ReadBatch until ReadBatch returns context.Canceled is processed. 2. there is a server related error (failed encoding, broken conn) that was received while processing/reading messages.

func (*Server) Shutdown

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