package rpc

Import Path
	net/rpc (on golang.org and go.dev)

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files
	    client.go
	    debug.go
	d-> server.go

Exported Type Names

	type Call (struct)
		Call represents an active RPC.

		Exported Fields (5)
			Args interface{}
				// The argument to the function (*struct).

			Done chan *Call
				// Receives *Call when Go is complete.

			Error error
				// After completion, the error status.

			Reply interface{}
				// The reply from the function (*struct).

			ServiceMethod string
				// The name of the service and method to call.

		As Outputs Of (1+)
			func (*Client).Go(serviceMethod string, args interface{}, reply interface{}, done chan *Call) *Call
		As Inputs Of (1+)
			func (*Client).Go(serviceMethod string, args interface{}, reply interface{}, done chan *Call) *Call
	type Client (struct)
		Client represents an RPC Client.
		There may be multiple outstanding Calls associated
		with a single Client, and a Client may be used by
		multiple goroutines simultaneously.

		Exported Methods (3)
			(*T) Call(serviceMethod string, args interface{}, reply interface{}) error
				Call invokes the named function, waits for it to complete, and returns its error status.

			(*T) Close() error
				Close calls the underlying codec's Close method. If the connection is already
				shutting down, ErrShutdown is returned.

			(*T) Go(serviceMethod string, args interface{}, reply interface{}, done chan *Call) *Call
				Go invokes the function asynchronously. It returns the Call structure representing
				the invocation. The done channel will signal when the call is complete by returning
				the same Call object. If done is nil, Go will allocate a new channel.
				If non-nil, done must be buffered or Go will deliberately crash.

		Implements (1+)
			*T : io.Closer
		As Outputs Of (7+)
			func Dial(network, address string) (*Client, error)
			func DialHTTP(network, address string) (*Client, error)
			func DialHTTPPath(network, address, path string) (*Client, error)
			func NewClient(conn io.ReadWriteCloser) *Client
			func NewClientWithCodec(codec ClientCodec) *Client
			func net/rpc/jsonrpc.Dial(network, address string) (*Client, error)
			func net/rpc/jsonrpc.NewClient(conn io.ReadWriteCloser) *Client
	type ClientCodec (interface)
		A ClientCodec implements writing of RPC requests and
		reading of RPC responses for the client side of an RPC session.
		The client calls WriteRequest to write a request to the connection
		and calls ReadResponseHeader and ReadResponseBody in pairs
		to read responses. The client calls Close when finished with the
		connection. ReadResponseBody may be called with a nil
		argument to force the body of the response to be read and then
		discarded.
		See NewClient's comment for information about concurrent access.

		Exported Methods (4)
			( T) Close() error
			( T) ReadResponseBody(interface{}) error
			( T) ReadResponseHeader(*Response) error
			( T) WriteRequest(*Request, interface{}) error
		Implements (1+)
			 T : io.Closer
		As Outputs Of (1+)
			func net/rpc/jsonrpc.NewClientCodec(conn io.ReadWriteCloser) ClientCodec
		As Inputs Of (1+)
			func NewClientWithCodec(codec ClientCodec) *Client
	type Request (struct)
		Request is a header written before every RPC call. It is used internally
		but documented here as an aid to debugging, such as when analyzing
		network traffic.

		Exported Fields (2)
			Seq uint64
				// sequence number chosen by client

			ServiceMethod string
				// format: "Service.Method"

		As Inputs Of (2+)
			func ClientCodec.WriteRequest(*Request, interface{}) error
			func ServerCodec.ReadRequestHeader(*Request) error
	type Response (struct)
		Response is a header written before every RPC return. It is used internally
		but documented here as an aid to debugging, such as when analyzing
		network traffic.

		Exported Fields (3)
			Error string
				// error, if any.

			Seq uint64
				// echoes that of the request

			ServiceMethod string
				// echoes that of the Request

		As Inputs Of (2+)
			func ClientCodec.ReadResponseHeader(*Response) error
			func ServerCodec.WriteResponse(*Response, interface{}) error
	type Server (struct)
		Server represents an RPC Server.

		Exported Methods (8)
			(*T) Accept(lis net.Listener)
				Accept accepts connections on the listener and serves requests
				for each incoming connection. Accept blocks until the listener
				returns a non-nil error. The caller typically invokes Accept in a
				go statement.

			(*T) HandleHTTP(rpcPath, debugPath string)
				HandleHTTP registers an HTTP handler for RPC messages on rpcPath,
				and a debugging handler on debugPath.
				It is still necessary to invoke http.Serve(), typically in a go statement.

			(*T) Register(rcvr interface{}) error
				Register publishes in the server the set of methods of the
				receiver value that satisfy the following conditions:
					- exported method of exported type
					- two arguments, both of exported type
					- the second argument is a pointer
					- one return value, of type error
				It returns an error if the receiver is not an exported type or has
				no suitable methods. It also logs the error using package log.
				The client accesses each method using a string of the form "Type.Method",
				where Type is the receiver's concrete type.

			(*T) RegisterName(name string, rcvr interface{}) error
				RegisterName is like Register but uses the provided name for the type
				instead of the receiver's concrete type.

			(*T) ServeCodec(codec ServerCodec)
				ServeCodec is like ServeConn but uses the specified codec to
				decode requests and encode responses.

			(*T) ServeConn(conn io.ReadWriteCloser)
				ServeConn runs the server on a single connection.
				ServeConn blocks, serving the connection until the client hangs up.
				The caller typically invokes ServeConn in a go statement.
				ServeConn uses the gob wire format (see package gob) on the
				connection. To use an alternate codec, use ServeCodec.
				See NewClient's comment for information about concurrent access.

			(*T) ServeHTTP(w http.ResponseWriter, req *http.Request)
				ServeHTTP implements an http.Handler that answers RPC requests.

			(*T) ServeRequest(codec ServerCodec) error
				ServeRequest is like ServeCodec but synchronously serves a single request.
				It does not close the codec upon completion.

		Implements (1+)
			*T : net/http.Handler
		As Outputs Of (1+)
			func NewServer() *Server
		As Types Of (1+)
			  var DefaultServer *Server
	type ServerCodec (interface)
		A ServerCodec implements reading of RPC requests and writing of
		RPC responses for the server side of an RPC session.
		The server calls ReadRequestHeader and ReadRequestBody in pairs
		to read requests from the connection, and it calls WriteResponse to
		write a response back. The server calls Close when finished with the
		connection. ReadRequestBody may be called with a nil
		argument to force the body of the request to be read and discarded.
		See NewClient's comment for information about concurrent access.

		Exported Methods (4)
			( T) Close() error
				Close can be called multiple times and must be idempotent.

			( T) ReadRequestBody(interface{}) error
			( T) ReadRequestHeader(*Request) error
			( T) WriteResponse(*Response, interface{}) error
		Implements (1+)
			 T : io.Closer
		As Outputs Of (1+)
			func net/rpc/jsonrpc.NewServerCodec(conn io.ReadWriteCloser) ServerCodec
		As Inputs Of (4+)
			func ServeCodec(codec ServerCodec)
			func ServeRequest(codec ServerCodec) error
			func (*Server).ServeCodec(codec ServerCodec)
			func (*Server).ServeRequest(codec ServerCodec) error
	type ServerError string
		ServerError represents an error that has been returned from
		the remote side of the RPC connection.

		One Exported Method
			( T) Error() string
		Implements (1+)
			 T : error
Exported Values

	 func Accept(lis net.Listener)
		Accept accepts connections on the listener and serves requests
		to DefaultServer for each incoming connection.
		Accept blocks; the caller typically invokes it in a go statement.
	const DefaultDebugPath = "/debug/rpc"
	const DefaultRPCPath = "/_goRPC_"
		Defaults used by HandleHTTP
	  var DefaultServer *Server
		DefaultServer is the default instance of *Server.
	 func Dial(network, address string) (*Client, error)
		Dial connects to an RPC server at the specified network address.
	 func DialHTTP(network, address string) (*Client, error)
		DialHTTP connects to an HTTP RPC server at the specified network address
		listening on the default HTTP RPC path.
	 func DialHTTPPath(network, address, path string) (*Client, error)
		DialHTTPPath connects to an HTTP RPC server
		at the specified network address and path.
	  var ErrShutdown error
	 func HandleHTTP()
		HandleHTTP registers an HTTP handler for RPC messages to DefaultServer
		on DefaultRPCPath and a debugging handler on DefaultDebugPath.
		It is still necessary to invoke http.Serve(), typically in a go statement.
	 func NewClient(conn io.ReadWriteCloser) *Client
		NewClient returns a new Client to handle requests to the
		set of services at the other end of the connection.
		It adds a buffer to the write side of the connection so
		the header and payload are sent as a unit.

		The read and write halves of the connection are serialized independently,
		so no interlocking is required. However each half may be accessed
		concurrently so the implementation of conn should protect against
		concurrent reads or concurrent writes.
	 func NewClientWithCodec(codec ClientCodec) *Client
		NewClientWithCodec is like NewClient but uses the specified
		codec to encode requests and decode responses.
	 func NewServer() *Server
		NewServer returns a new Server.
	 func Register(rcvr interface{}) error
		Register publishes the receiver's methods in the DefaultServer.
	 func RegisterName(name string, rcvr interface{}) error
		RegisterName is like Register but uses the provided name for the type
		instead of the receiver's concrete type.
	 func ServeCodec(codec ServerCodec)
		ServeCodec is like ServeConn but uses the specified codec to
		decode requests and encode responses.
	 func ServeConn(conn io.ReadWriteCloser)
		ServeConn runs the DefaultServer on a single connection.
		ServeConn blocks, serving the connection until the client hangs up.
		The caller typically invokes ServeConn in a go statement.
		ServeConn uses the gob wire format (see package gob) on the
		connection. To use an alternate codec, use ServeCodec.
		See NewClient's comment for information about concurrent access.
	 func ServeRequest(codec ServerCodec) error
		ServeRequest is like ServeCodec but synchronously serves a single request.
		It does not close the codec upon completion.

The pages are generated with Golds v0.1.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project and developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.