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

rpc

package

Go to main page

Versions in this module

v1

v1.0.7

May 10, 2024

v1.0.6

Aug 24, 2023

v1.0.5

Sep 5, 2022

v1.0.4

Sep 1, 2022

v1.0.3

Aug 31, 2022

v1.0.2

Dec 24, 2021

Changes in this version

+ const EarliestBlockNumber

+ const LatestBlockNumber

+ const MetadataApi

+ const PendingBlockNumber

+ var DefaultClientTimeouts = ClientTimeouts

+ var DefaultHTTPTimeouts = HTTPTimeouts

+ var ErrClientQuit = errors.New("client is closed")

+ var ErrNoResult = errors.New("no result in JSON-RPC response")

+ var ErrNotificationsUnsupported = errors.New("notifications not supported")

+ var ErrSubscriptionNotFound = errors.New("subscription not found")

+ var ErrSubscriptionQueueOverflow = errors.New("subscription queue overflow")

+ func NewHTTPServer(cors []string, vhosts []string, timeouts HTTPTimeouts, srv *Server) *http.Server

+ func NewWSServer(allowedOrigins []string, srv *Server) *http.Server

+ type API struct

+ Namespace string

+ Public bool

+ Service interface{}

+ Version string

+ type BatchElem struct

+ Args []interface{}

+ Error error

+ Method string

+ Result interface{}

+ type BlockNumber int64

+ func (bn *BlockNumber) UnmarshalJSON(data []byte) error

+ func (bn BlockNumber) Int64() int64

+ type BlockNumberOrHash struct

+ BlockHash *types.Hash

+ BlockNumber *BlockNumber

+ RequireCanonical bool

+ func BlockNumberOrHashWithHash(hash types.Hash, canonical bool) BlockNumberOrHash

+ func BlockNumberOrHashWithNumber(blockNr BlockNumber) BlockNumberOrHash

+ func (bnh *BlockNumberOrHash) Hash() (types.Hash, bool)

+ func (bnh *BlockNumberOrHash) Number() (BlockNumber, bool)

+ func (bnh *BlockNumberOrHash) UnmarshalJSON(data []byte) error

+ type Client struct

+ func Dial(rawurl string) (*Client, error)

+ func DialContext(ctx context.Context, rawurl string, timeouts ClientTimeouts, ...) (*Client, error)

+ func DialHTTP(endpoint string, timeouts ClientTimeouts, tlsConfig network.TlsConfig) (*Client, error)

+ func DialHTTPWithClient(endpoint string, client *http.Client) (*Client, error)

+ func DialHttps(rawurl string, timeouts ClientTimeouts, tlsConfig network.TlsConfig) (*Client, error)

+ func DialIPC(ctx context.Context, endpoint string) (*Client, error)

+ func DialInProc(handler *Server) *Client

+ func DialStdIO(ctx context.Context) (*Client, error)

+ func DialWebsocket(ctx context.Context, endpoint, origin string) (*Client, error)

+ func (c *Client) BatchCall(b []BatchElem) error

+ func (c *Client) BatchCallContext(ctx context.Context, b []BatchElem) error

+ func (c *Client) Call(result interface{}, method string, args ...interface{}) error

+ func (c *Client) CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error

+ func (c *Client) Close()

+ func (c *Client) Subscribe(ctx context.Context, namespace string, channel interface{}, ...) (*ClientSubscription, error)

+ func (c *Client) SupportedModules() (map[string]string, error)

+ type ClientSubscription struct

+ func (sub *ClientSubscription) Err() <-chan error

+ func (sub *ClientSubscription) Unsubscribe()

+ type ClientTimeouts struct

+ IdleConnTimeout time.Duration

+ KeepAlive time.Duration

+ MaxIdleConns int

+ MaxIdleConnsPerHost int

+ type CodecOption int

+ const OptionMethodInvocation

+ const OptionSubscriptions

+ type Error interface

+ Error func() string

+ ErrorCode func() int

+ type HTTPTimeouts struct

+ IdleTimeout time.Duration

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ type HttpConfig struct

+ Cors []string

+ Host string

+ Modules []string

+ Port int

+ Timeouts HTTPTimeouts

+ VirtualHosts []string

+ func (c HttpConfig) Endpoint() string

+ type ID string

+ func NewID() ID

+ type IpcConfig struct

+ Path string

+ func (c IpcConfig) Endpoint() string

+ type Notifier struct

+ func NotifierFromContext(ctx context.Context) (*Notifier, bool)

+ func (n *Notifier) Closed() <-chan interface{}

+ func (n *Notifier) CreateSubscription() *Subscription

+ func (n *Notifier) Notify(id ID, data interface{}) error

+ type RPCService struct

+ func (s *RPCService) Modules() map[string]string

+ func (s *RPCService) Ping() error

+ type Server struct

+ func NewServer() *Server

+ func StartHTTPEndpoint(httpConfig HttpConfig, tlsConfig network.TlsConfig, apis []API) (net.Listener, *Server, error)

+ func StartIPCEndpoint(ipcEndpoint string, apis []API) (net.Listener, *Server, error)

+ func StartWSEndpoint(wsConfig WSConfig, tlsConfig network.TlsConfig, apis []API) (net.Listener, *Server, error)

+ func (s *Server) RegisterName(name string, rcvr interface{}) error

+ func (s *Server) ServeCodec(codec ServerCodec, options CodecOption)

+ func (s *Server) ServeSingleRequest(ctx context.Context, codec ServerCodec, options CodecOption)

+ func (s *Server) Stop()

+ func (srv *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (srv *Server) ServeListener(l net.Listener) error

+ func (srv *Server) WebsocketHandler(allowedOrigins []string) http.Handler

+ type ServerCodec interface

+ Close func()

+ Closed func() <-chan interface{}

+ CreateErrorResponse func(id interface{}, err Error) interface{}

+ CreateErrorResponseWithInfo func(id interface{}, err Error, info interface{}) interface{}

+ CreateNotification func(id, namespace string, event interface{}) interface{}

+ CreateResponse func(id interface{}, reply interface{}) interface{}

+ ParseRequestArguments func(argTypes []reflect.Type, params interface{}) ([]reflect.Value, Error)

+ ReadRequestHeaders func() ([]rpcRequest, bool, Error)

+ Write func(msg interface{}) error

+ func NewCodec(rwc io.ReadWriteCloser, encode, decode func(v interface{}) error) ServerCodec

+ func NewJSONCodec(rwc io.ReadWriteCloser) ServerCodec

+ type StdIOConn struct

+ func (io StdIOConn) Close() error

+ func (io StdIOConn) LocalAddr() net.Addr

+ func (io StdIOConn) Read(b []byte) (n int, err error)

+ func (io StdIOConn) RemoteAddr() net.Addr

+ func (io StdIOConn) SetDeadline(t time.Time) error

+ func (io StdIOConn) SetReadDeadline(t time.Time) error

+ func (io StdIOConn) SetWriteDeadline(t time.Time) error

+ func (io StdIOConn) Write(b []byte) (n int, err error)

+ type Subscription struct

+ ID ID

+ func (s *Subscription) Err() <-chan error

+ type WSConfig struct

+ ExposeAll bool

+ Host string

+ Modules []string

+ Origins []string

+ Port int

+ func (c WSConfig) Endpoint() string