rpc: fix godoc comments and run gofmt

This commit is contained in:
Felix Lange 2019-11-15 14:25:46 +01:00
parent 1c3e0688b0
commit e903598c22
4 changed files with 13 additions and 14 deletions

View file

@ -47,7 +47,7 @@ type httpConn struct {
client *http.Client client *http.Client
req *http.Request req *http.Request
closeOnce sync.Once closeOnce sync.Once
closeCh chan interface{} closeCh chan interface{}
} }
// httpConn is treated specially by Client. // httpConn is treated specially by Client.

View file

@ -54,4 +54,3 @@ func DialIPC(ctx context.Context, endpoint string) (*Client, error) {
return NewCodec(conn), err return NewCodec(conn), err
}) })
} }

View file

@ -164,24 +164,24 @@ func (c connWithRemoteAddr) RemoteAddr() string { return c.addr }
// jsonCodec reads and writes JSON-RPC messages to the underlying connection. It also has // jsonCodec reads and writes JSON-RPC messages to the underlying connection. It also has
// support for parsing arguments and serializing (result) objects. // support for parsing arguments and serializing (result) objects.
type jsonCodec struct { type jsonCodec struct {
remote string remote string
closer sync.Once // close closed channel once closer sync.Once // close closed channel once
closeCh chan interface{} // closed on Close closeCh chan interface{} // closed on Close
decode func(v interface{}) error // decoder to allow multiple transports decode func(v interface{}) error // decoder to allow multiple transports
encMu sync.Mutex // guards the encoder encMu sync.Mutex // guards the encoder
encode func(v interface{}) error // encoder to allow multiple transports encode func(v interface{}) error // encoder to allow multiple transports
conn deadlineCloser conn deadlineCloser
} }
// NewCodec creates a codec which uses the given functions to read and write. If conn // NewFuncCodec creates a codec which uses the given functions to read and write. If conn
// implements ConnRemoteAddr, log messages will use it to include the remote address of // implements ConnRemoteAddr, log messages will use it to include the remote address of
// the connection. // the connection.
func NewFuncCodec(conn deadlineCloser, encode, decode func(v interface{}) error) ServerCodec { func NewFuncCodec(conn deadlineCloser, encode, decode func(v interface{}) error) ServerCodec {
codec := &jsonCodec{ codec := &jsonCodec{
closeCh: make(chan interface{}), closeCh: make(chan interface{}),
encode: encode, encode: encode,
decode: decode, decode: decode,
conn: conn, conn: conn,
} }
if ra, ok := conn.(ConnRemoteAddr); ok { if ra, ok := conn.(ConnRemoteAddr); ok {
codec.remote = ra.RemoteAddr() codec.remote = ra.RemoteAddr()

View file

@ -66,7 +66,7 @@ func (s *Server) RegisterName(name string, receiver interface{}) error {
return s.services.registerName(name, receiver) return s.services.registerName(name, receiver)
} }
// receiver reads incoming requests from codec, calls the appropriate callback and writes // ServeCodec reads incoming requests from codec, calls the appropriate callback and writes
// the response back using the given codec. It will block until the codec is closed or the // the response back using the given codec. It will block until the codec is closed or the
// server is stopped. In either case the codec is closed. // server is stopped. In either case the codec is closed.
// //