rpc

Documentation

Index

• func Handler(rpcConfig *config.RPCConfig, routes core.RoutesMap, logger log.Logger) http.Handler
• func Routes(cfg config.RPCConfig, s state.Store, bs state.BlockStore, ...) core.RoutesMap
• type Server
  • func (srv *Server) ListenAndServe(ctx context.Context) error
  • func (srv *Server) ListenAndServeTLS(ctx context.Context, certFile, keyFile string) error

Functions

func Handler

func Handler(rpcConfig *config.RPCConfig, routes core.RoutesMap, logger log.Logger) http.Handler

Handler returns the http.Handler configured for use with an Inspector server. Handler registers the routes on the http.Handler and also registers the websocket handler and the CORS handler if specified by the configuration options.

func Routes

func Routes(cfg config.RPCConfig, s state.Store, bs state.BlockStore, txidx txindex.TxIndexer, blkidx indexer.BlockIndexer, logger log.Logger) core.RoutesMap

Routes returns the set of routes used by the Inspector server.

Types

type Server

type Server struct {
	Addr    string // TCP address to listen on, ":http" if empty
	Handler http.Handler
	Logger  log.Logger
	Config  *config.RPCConfig
}

Server defines parameters for running an Inspector rpc server.

func (*Server) ListenAndServe

func (srv *Server) ListenAndServe(ctx context.Context) error

ListenAndServe listens on the address specified in srv.Addr and handles any incoming requests over HTTP using the Inspector rpc handler specified on the server.

func (*Server) ListenAndServeTLS

func (srv *Server) ListenAndServeTLS(ctx context.Context, certFile, keyFile string) error

ListenAndServeTLS listens on the address specified in srv.Addr. ListenAndServeTLS handles incoming requests over HTTPS using the Inspector rpc handler specified on the server.