websocket

Documentation

Index

• Constants
• func ServerMaker() (jsonrpc.Handler, jrpctest.ClientMaker, func())
• func WebsocketHandler(s jsonrpc.Handler, allowedOrigins []string) http.Handler
• func WsClientHeaders(endpoint, origin string) (string, http.Header, error)
• type Client
  • func DialWebsocket(ctx context.Context, endpoint, origin string) (*Client, error)
  • func DialWebsocketWithDialer(ctx context.Context, endpoint, origin string, opts *websocket.DialOptions) (*Client, error)
  • func (c *Client) Close() error
• type Codec
  • func (c *Codec) Close() error
  • func (c *Codec) Closed() <-chan struct{}
  • func (c *Codec) Flush() error
  • func (c *Codec) PeerInfo() jsonrpc.PeerInfo
  • func (c *Codec) ReadBatch(ctx context.Context) (jsonrpc.Bundle, error)
  • func (c *Codec) RemoteAddr() string
  • func (c *Codec) Write(p []byte) (n int, err error)
• type Server
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const (
	MaxRequestContentLength = 1024 * 1024 * 5
	ContentType             = "application/json"
	WsReadBuffer            = 1024
	WsWriteBuffer           = 1024
	WsPingInterval          = 60 * time.Second
	WsPingWriteTimeout      = 5 * time.Second
	WsPongTimeout           = 30 * time.Second
	WsMessageSizeLimit      = 128 * 1024 * 1024
)

Functions

func ServerMaker

func ServerMaker() (jsonrpc.Handler, jrpctest.ClientMaker, func())

func WebsocketHandler

func WebsocketHandler(s jsonrpc.Handler, allowedOrigins []string) http.Handler

WebsocketHandler returns a handler that serves JSON-RPC to WebSocket connections.

allowedOrigins should be a comma-separated list of allowed origin URLs. To allow connections with any origin, pass "*".

func WsClientHeaders

func WsClientHeaders(endpoint, origin string) (string, http.Header, error)

Types

type Client

type Client struct {
	*rdwr.Client
	// contains filtered or unexported fields
}

func DialWebsocket

func DialWebsocket(ctx context.Context, endpoint, origin string) (*Client, error)

DialWebsocket creates a new RPC client that communicates with a JSON-RPC server that is listening on the given endpoint.

The context is used for the initial connection establishment. It does not affect subsequent interactions with the client.

func DialWebsocketWithDialer

func DialWebsocketWithDialer(ctx context.Context, endpoint, origin string, opts *websocket.DialOptions) (*Client, error)

that is listening on the given endpoint using the provided dialer.

func (*Client) Close

func (c *Client) Close() error

type Codec

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

func (*Codec) Close

func (c *Codec) Close() error

func (*Codec) Closed

func (c *Codec) Closed() <-chan struct{}

func (*Codec) Flush

func (c *Codec) Flush() error

func (*Codec) PeerInfo

func (c *Codec) PeerInfo() jsonrpc.PeerInfo

func (*Codec) ReadBatch

func (c *Codec) ReadBatch(ctx context.Context) (jsonrpc.Bundle, error)

func (*Codec) RemoteAddr

func (c *Codec) RemoteAddr() string

func (*Codec) Write

func (c *Codec) Write(p []byte) (n int, err error)

type Server

type Server struct {
	Handler jsonrpc.Handler
}

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)