rpc

Documentation

Index

• Constants
• func CLIFlags(envPrefix string) []cli.Flag
• type CLIConfig
  • func ReadCLIConfig(ctx *cli.Context) CLIConfig
  • func (c CLIConfig) Check() error
• type HealthzResponse
• type Server
  • func NewServer(host string, port int, appVersion string, opts ...ServerOption) *Server
  • func (b *Server) AddAPI(api rpc.API)
  • func (b *Server) Endpoint() string
  • func (b *Server) Start() error
  • func (b *Server) Stop() error
• type ServerOption
  • func WithAPIs(apis []rpc.API) ServerOption
  • func WithCORSHosts(hosts []string) ServerOption
  • func WithHTTPRecorder(recorder opmetrics.HTTPRecorder) ServerOption
  • func WithHealthzHandler(hdlr http.Handler) ServerOption
  • func WithHealthzPath(path string) ServerOption
  • func WithJWTSecret(secret []byte) ServerOption
  • func WithLogger(lgr log.Logger) ServerOption
  • func WithRPCPath(path string) ServerOption
  • func WithVHosts(hosts []string) ServerOption

Constants

const (
	ListenAddrFlagName = "rpc.addr"
	PortFlagName       = "rpc.port"
)

Functions

func CLIFlags

func CLIFlags(envPrefix string) []cli.Flag

Types

type CLIConfig

type CLIConfig struct {
	ListenAddr string
	ListenPort int
}

func ReadCLIConfig

func ReadCLIConfig(ctx *cli.Context) CLIConfig

func (CLIConfig) Check

func (c CLIConfig) Check() error

type HealthzResponse

type HealthzResponse struct {
	Version string `json:"version"`
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(host string, port int, appVersion string, opts ...ServerOption) *Server

func (*Server) AddAPI

func (b *Server) AddAPI(api rpc.API)

func (*Server) Endpoint

func (b *Server) Endpoint() string

func (*Server) Start

func (b *Server) Start() error

func (*Server) Stop

func (b *Server) Stop() error

type ServerOption

type ServerOption func(b *Server)

func WithAPIs

func WithAPIs(apis []rpc.API) ServerOption

func WithCORSHosts

func WithCORSHosts(hosts []string) ServerOption

func WithHTTPRecorder

func WithHTTPRecorder(recorder opmetrics.HTTPRecorder) ServerOption

func WithHealthzHandler

func WithHealthzHandler(hdlr http.Handler) ServerOption

func WithHealthzPath

func WithHealthzPath(path string) ServerOption

func WithJWTSecret

func WithJWTSecret(secret []byte) ServerOption

func WithLogger

func WithLogger(lgr log.Logger) ServerOption

func WithRPCPath

func WithRPCPath(path string) ServerOption

func WithVHosts

func WithVHosts(hosts []string) ServerOption