summaryrefslogtreecommitdiff
path: root/vendor/github.com/ugorji/go/codec/rpc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/ugorji/go/codec/rpc.go')
-rw-r--r--vendor/github.com/ugorji/go/codec/rpc.go228
1 files changed, 0 insertions, 228 deletions
diff --git a/vendor/github.com/ugorji/go/codec/rpc.go b/vendor/github.com/ugorji/go/codec/rpc.go
deleted file mode 100644
index bdc535b6d..000000000
--- a/vendor/github.com/ugorji/go/codec/rpc.go
+++ /dev/null
@@ -1,228 +0,0 @@
-// Copyright (c) 2012-2020 Ugorji Nwoke. All rights reserved.
-// Use of this source code is governed by a MIT license found in the LICENSE file.
-
-package codec
-
-import (
- "errors"
- "io"
- "net"
- "net/rpc"
- "sync/atomic"
-)
-
-var (
- errRpcIsClosed = errors.New("rpc - connection has been closed")
- errRpcNoConn = errors.New("rpc - no connection")
-
- rpcSpaceArr = [1]byte{' '}
-)
-
-// Rpc provides a rpc Server or Client Codec for rpc communication.
-type Rpc interface {
- ServerCodec(conn io.ReadWriteCloser, h Handle) rpc.ServerCodec
- ClientCodec(conn io.ReadWriteCloser, h Handle) rpc.ClientCodec
-}
-
-// RPCOptions holds options specific to rpc functionality
-type RPCOptions struct {
- // RPCNoBuffer configures whether we attempt to buffer reads and writes during RPC calls.
- //
- // Set RPCNoBuffer=true to turn buffering off.
- //
- // Buffering can still be done if buffered connections are passed in, or
- // buffering is configured on the handle.
- //
- // Deprecated: Buffering should be configured at the Handle or by using a buffer Reader.
- // Setting this has no effect anymore (after v1.2.12 - authored 2025-05-06)
- RPCNoBuffer bool
-}
-
-// rpcCodec defines the struct members and common methods.
-type rpcCodec struct {
- c io.Closer
- r io.Reader
- w io.Writer
- f ioFlusher
- nc net.Conn
- dec *Decoder
- enc *Encoder
- h Handle
-
- cls atomic.Pointer[clsErr]
-}
-
-func newRPCCodec(conn io.ReadWriteCloser, h Handle) *rpcCodec {
- nc, _ := conn.(net.Conn)
- f, _ := conn.(ioFlusher)
- rc := &rpcCodec{
- h: h,
- c: conn,
- w: conn,
- r: conn,
- f: f,
- nc: nc,
- enc: NewEncoder(conn, h),
- dec: NewDecoder(conn, h),
- }
- rc.cls.Store(new(clsErr))
- return rc
-}
-
-func (c *rpcCodec) write(obj ...interface{}) (err error) {
- err = c.ready()
- if err != nil {
- return
- }
- if c.f != nil {
- defer func() {
- flushErr := c.f.Flush()
- if flushErr != nil && err == nil {
- err = flushErr
- }
- }()
- }
-
- for _, o := range obj {
- err = c.enc.Encode(o)
- if err != nil {
- return
- }
- // defensive: ensure a space is always written after each encoding,
- // in case the value was a number, and encoding a value right after
- // without a space will lead to invalid output.
- if c.h.isJson() {
- _, err = c.w.Write(rpcSpaceArr[:])
- if err != nil {
- return
- }
- }
- }
- return
-}
-
-func (c *rpcCodec) read(obj interface{}) (err error) {
- err = c.ready()
- if err == nil {
- // Setting ReadDeadline should not be necessary,
- // especially since it only works for net.Conn (not generic ioReadCloser).
- // if c.nc != nil {
- // c.nc.SetReadDeadline(time.Now().Add(1 * time.Second))
- // }
-
- // Note: If nil is passed in, we should read and discard
- if obj == nil {
- // return c.dec.Decode(&obj)
- err = panicToErr(c.dec, func() { c.dec.swallow() })
- } else {
- err = c.dec.Decode(obj)
- }
- }
- return
-}
-
-func (c *rpcCodec) Close() (err error) {
- if c.c != nil {
- cls := c.cls.Load()
- if !cls.closed {
- // writing to same pointer could lead to a data race (always make new one)
- cls = &clsErr{closed: true, err: c.c.Close()}
- c.cls.Store(cls)
- }
- err = cls.err
- }
- return
-}
-
-func (c *rpcCodec) ready() (err error) {
- if c.c == nil {
- err = errRpcNoConn
- } else {
- cls := c.cls.Load()
- if cls != nil && cls.closed {
- if err = cls.err; err == nil {
- err = errRpcIsClosed
- }
- }
- }
- return
-}
-
-func (c *rpcCodec) ReadResponseBody(body interface{}) error {
- return c.read(body)
-}
-
-// -------------------------------------
-
-type goRpcCodec struct {
- *rpcCodec
-}
-
-func (c *goRpcCodec) WriteRequest(r *rpc.Request, body interface{}) error {
- return c.write(r, body)
-}
-
-func (c *goRpcCodec) WriteResponse(r *rpc.Response, body interface{}) error {
- return c.write(r, body)
-}
-
-func (c *goRpcCodec) ReadResponseHeader(r *rpc.Response) error {
- return c.read(r)
-}
-
-func (c *goRpcCodec) ReadRequestHeader(r *rpc.Request) error {
- return c.read(r)
-}
-
-func (c *goRpcCodec) ReadRequestBody(body interface{}) error {
- return c.read(body)
-}
-
-// -------------------------------------
-
-// goRpc is the implementation of Rpc that uses the communication protocol
-// as defined in net/rpc package.
-type goRpc struct{}
-
-// GoRpc implements Rpc using the communication protocol defined in net/rpc package.
-//
-// Note: network connection (from net.Dial, of type io.ReadWriteCloser) is not buffered.
-//
-// For performance, you should configure WriterBufferSize and ReaderBufferSize on the handle.
-// This ensures we use an adequate buffer during reading and writing.
-// If not configured, we will internally initialize and use a buffer during reads and writes.
-// This can be turned off via the RPCNoBuffer option on the Handle.
-//
-// var handle codec.JsonHandle
-// handle.RPCNoBuffer = true // turns off attempt by rpc module to initialize a buffer
-//
-// Example 1: one way of configuring buffering explicitly:
-//
-// var handle codec.JsonHandle // codec handle
-// handle.ReaderBufferSize = 1024
-// handle.WriterBufferSize = 1024
-// var conn io.ReadWriteCloser // connection got from a socket
-// var serverCodec = GoRpc.ServerCodec(conn, handle)
-// var clientCodec = GoRpc.ClientCodec(conn, handle)
-//
-// Example 2: you can also explicitly create a buffered connection yourself,
-// and not worry about configuring the buffer sizes in the Handle.
-//
-// var handle codec.Handle // codec handle
-// var conn io.ReadWriteCloser // connection got from a socket
-// var bufconn = struct { // bufconn here is a buffered io.ReadWriteCloser
-// io.Closer
-// *bufio.Reader
-// *bufio.Writer
-// }{conn, bufio.NewReader(conn), bufio.NewWriter(conn)}
-// var serverCodec = GoRpc.ServerCodec(bufconn, handle)
-// var clientCodec = GoRpc.ClientCodec(bufconn, handle)
-var GoRpc goRpc
-
-func (x goRpc) ServerCodec(conn io.ReadWriteCloser, h Handle) rpc.ServerCodec {
- return &goRpcCodec{newRPCCodec(conn, h)}
-}
-
-func (x goRpc) ClientCodec(conn io.ReadWriteCloser, h Handle) rpc.ClientCodec {
- return &goRpcCodec{newRPCCodec(conn, h)}
-}