websocket

Documentation

Overview

Package websocket provides WebSocket transport support for JSON-RPC 2.0.

Index

• type ObjectStream
  • func NewObjectStream(conn *ws.Conn) ObjectStream
  • func (t ObjectStream) Close() error
  • func (t ObjectStream) ReadObject(v interface{}) error
  • func (t ObjectStream) WriteObject(obj interface{}) error

Types

type ObjectStream

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

A ObjectStream is a jsonrpc2.ObjectStream that uses a WebSocket to send and receive JSON-RPC 2.0 objects.

func NewObjectStream

func NewObjectStream(conn *ws.Conn) ObjectStream

NewObjectStream creates a new jsonrpc2.ObjectStream for sending and receiving JSON-RPC 2.0 objects over a WebSocket.

func (ObjectStream) Close

func (t ObjectStream) Close() error

Close implements jsonrpc2.ObjectStream.

func (ObjectStream) ReadObject

func (t ObjectStream) ReadObject(v interface{}) error

ReadObject implements jsonrpc2.ObjectStream.

func (ObjectStream) WriteObject

func (t ObjectStream) WriteObject(obj interface{}) error

WriteObject implements jsonrpc2.ObjectStream.