Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jsonrpc2

package

Go to main page

Versions in this module

v1

v1.0.0

Mar 5, 2020

Changes in this version

+ const CodeInternalError

+ const CodeInvalidParams

+ const CodeInvalidRequest

+ const CodeMethodNotFound

+ const CodeParseError

+ const CodeServerOverloaded

+ const CodeUnknownError

+ const Receive

+ const Send

+ var ErrDisconnected = errors.New("disconnected")

type Conn

+ func (c *Conn) AddHandler(handler Handler)

+ func (c *Conn) Cancel(id ID)

+ func (c *Conn) Run(runCtx context.Context) error

+ type Direction bool

+ func (d Direction) String() string

+ type EmptyHandler struct

+ func (EmptyHandler) Cancel(ctx context.Context, conn *Conn, id ID, cancelled bool) bool

+ func (EmptyHandler) Deliver(ctx context.Context, r *Request, delivered bool) bool

+ func (EmptyHandler) Done(ctx context.Context, err error)

+ func (EmptyHandler) Error(ctx context.Context, err error)

+ func (EmptyHandler) Read(ctx context.Context, bytes int64) context.Context

+ func (EmptyHandler) Request(ctx context.Context, conn *Conn, direction Direction, r *WireRequest) context.Context

+ func (EmptyHandler) Response(ctx context.Context, conn *Conn, direction Direction, r *WireResponse) context.Context

+ func (EmptyHandler) Wrote(ctx context.Context, bytes int64) context.Context

+ type Error struct

+ Code int64

+ Data *json.RawMessage

+ Message string

+ func NewErrorf(code int64, format string, args ...interface{}) *Error

+ func (err *Error) Error() string

type Handler

+ Cancel func(ctx context.Context, conn *Conn, id ID, cancelled bool) bool

+ Deliver func(ctx context.Context, r *Request, delivered bool) bool

+ Done func(ctx context.Context, err error)

+ Error func(ctx context.Context, err error)

+ Read func(ctx context.Context, bytes int64) context.Context

+ Request func(ctx context.Context, conn *Conn, direction Direction, r *WireRequest) context.Context

+ Response func(ctx context.Context, conn *Conn, direction Direction, r *WireResponse) context.Context

+ Wrote func(ctx context.Context, bytes int64) context.Context

type ID

+ Name string

+ Number int64

+ func (id *ID) String() string

type Request

+ func (r *Request) Conn() *Conn

+ func (r *Request) IsNotify() bool

+ func (r *Request) Parallel()

+ func (r *Request) Reply(ctx context.Context, result interface{}, err error) error

type Stream

+ func NewStream(in io.Reader, out io.Writer) Stream

+ type VersionTag struct

+ func (VersionTag) MarshalJSON() ([]byte, error)

+ func (VersionTag) UnmarshalJSON(data []byte) error

+ type WireRequest struct

+ ID *ID

+ Method string

+ Params *json.RawMessage

+ VersionTag VersionTag

+ type WireResponse struct

+ Error *Error

+ ID *ID

+ Result *json.RawMessage

+ VersionTag VersionTag

v0

v0.1.7

Aug 22, 2021

v0.1.6

Aug 22, 2021

v0.1.4

Aug 22, 2021

Changes in this version

+ const ErrIdleTimeout

+ var ErrInternal = NewError(-32603, "JSON RPC internal error")

+ var ErrInvalidParams = NewError(-32602, "JSON RPC invalid params")

+ var ErrInvalidRequest = NewError(-32600, "JSON RPC invalid request")

+ var ErrMethodNotFound = NewError(-32601, "JSON RPC method not found")

+ var ErrParse = NewError(-32700, "JSON RPC parse error")

+ var ErrServerOverloaded = NewError(-32000, "JSON RPC overloaded")

+ var ErrUnknown = NewError(-32001, "JSON RPC unknown error")

+ func ListenAndServe(ctx context.Context, network, addr string, server StreamServer, ...) error

+ func MethodNotFound(ctx context.Context, reply Replier, req Request) error

+ func NewError(code int64, message string) error

+ func Serve(ctx context.Context, ln net.Listener, server StreamServer, ...) error

+ type Call struct

+ func NewCall(id ID, method string, params interface{}) (*Call, error)

+ func (c *Call) MarshalJSON() ([]byte, error)

+ func (c *Call) UnmarshalJSON(data []byte) error

+ func (msg *Call) ID() ID

+ func (msg *Call) Method() string

+ func (msg *Call) Params() json.RawMessage

+ type Conn interface

+ Call func(ctx context.Context, method string, params, result interface{}) (ID, error)

+ Close func() error

+ Done func() <-chan struct{}

+ Err func() error

+ Go func(ctx context.Context, handler Handler)

+ Notify func(ctx context.Context, method string, params interface{}) error

+ func NewConn(s Stream) Conn

+ type Framer func(conn net.Conn) Stream

+ type Handler func(ctx context.Context, reply Replier, req Request) error

+ func AsyncHandler(handler Handler) Handler

+ func CancelHandler(handler Handler) (Handler, func(id ID))

+ func MustReplyHandler(handler Handler) Handler

+ type ID struct

+ func NewIntID(v int64) ID

+ func NewStringID(v string) ID

+ func (id *ID) MarshalJSON() ([]byte, error)

+ func (id *ID) UnmarshalJSON(data []byte) error

+ func (id ID) Format(f fmt.State, r rune)

+ type Message interface

+ func DecodeMessage(data []byte) (Message, error)

+ type Notification struct

+ func NewNotification(method string, params interface{}) (*Notification, error)

+ func (msg *Notification) Method() string

+ func (msg *Notification) Params() json.RawMessage

+ func (n *Notification) MarshalJSON() ([]byte, error)

+ func (n *Notification) UnmarshalJSON(data []byte) error

+ type Replier func(ctx context.Context, result interface{}, err error) error

+ type Request interface

+ Method func() string

+ Params func() json.RawMessage

+ type Response struct

+ func NewResponse(id ID, result interface{}, err error) (*Response, error)

+ func (msg *Response) Err() error

+ func (msg *Response) ID() ID

+ func (msg *Response) Result() json.RawMessage

+ func (r *Response) MarshalJSON() ([]byte, error)

+ func (r *Response) UnmarshalJSON(data []byte) error

+ type ServerFunc func(context.Context, Conn) error

+ func (f ServerFunc) ServeStream(ctx context.Context, c Conn) error

+ type Stream interface

+ Close func() error

+ Read func(context.Context) (Message, int64, error)

+ Write func(context.Context, Message) (int64, error)

+ func NewHeaderStream(conn net.Conn) Stream

+ func NewRawStream(conn net.Conn) Stream

+ type StreamServer interface

+ ServeStream func(context.Context, Conn) error

+ func HandlerServer(h Handler) StreamServer