github.com/ethereumproject/go-ethereum@v5.5.2+incompatible/rpc/inproc.go (about)

     1  // Copyright 2016 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package rpc
    18  
    19  import (
    20  	"encoding/json"
    21  	"io"
    22  	"net"
    23  )
    24  
    25  // inProcClient is an in-process buffer stream attached to an RPC server.
    26  type inProcClient struct {
    27  	server *Server
    28  	cl     io.Closer
    29  	enc    *json.Encoder
    30  	dec    *json.Decoder
    31  }
    32  
    33  // Close tears down the request channel of the in-proc client.
    34  func (c *inProcClient) Close() {
    35  	c.cl.Close()
    36  }
    37  
    38  // NewInProcRPCClient creates an in-process buffer stream attachment to a given
    39  // RPC server.
    40  func NewInProcRPCClient(handler *Server) Client {
    41  	p1, p2 := net.Pipe()
    42  	go handler.ServeCodec(NewJSONCodec(p1), OptionMethodInvocation|OptionSubscriptions)
    43  	return &inProcClient{handler, p2, json.NewEncoder(p2), json.NewDecoder(p2)}
    44  }
    45  
    46  // Send marshals a message into a json format and injects in into the client
    47  // request channel.
    48  func (c *inProcClient) Send(msg interface{}) error {
    49  	return c.enc.Encode(msg)
    50  }
    51  
    52  // Recv reads a message from the response channel and tries to parse it into the
    53  // given msg interface.
    54  func (c *inProcClient) Recv(msg interface{}) error {
    55  	return c.dec.Decode(msg)
    56  }
    57  
    58  // Returns the collection of modules the RPC server offers.
    59  func (c *inProcClient) SupportedModules() (map[string]string, error) {
    60  	return SupportedModules(c)
    61  }