websocket

package

v0.5.2 Latest Latest Go to latest Published: Apr 12, 2024 License: Unlicense Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gfx.cafe/open/jrpc

Links

Open Source Insights

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
type Server
- func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants ¶

View Source

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
)

Variables ¶

This section is empty.

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 ¶ added in v0.3.8

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

func (*Codec) Flush ¶ added in v0.3.9

func (c *Codec) Flush() error

func (*Codec) PeerInfo ¶

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

func (*Codec) ReadBatch ¶ added in v0.3.8

func (c *Codec) ReadBatch(ctx context.Context) ([]*jsonrpc.Message, bool, error)

func (*Codec) RemoteAddr ¶

func (c *Codec) RemoteAddr() string

func (*Codec) Write ¶ added in v0.3.9

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)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL