rpc

package

v0.10.7 Latest Latest Go to latest Published: Jan 11, 2023 License: MIT Imports: 18 Imported by: 33

Details

View Source

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

This section is empty.

func CLIFlags(envPrefix string) []cli.Flag

type CLIConfig struct {
	ListenAddr string
	ListenPort int
}

func ReadCLIConfig(ctx *cli.Context) CLIConfig

func (c CLIConfig) Check() error

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

type Middleware func(next http.Handler) http.Handler

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

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(b *Server)

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 WithMiddleware(middleware func(http.Handler) (hdlr http.Handler)) ServerOption

WithMiddleware adds an http.Handler to the rpc server handler stack The added middleware is invoked directly before the RPC callback

func WithRPCPath(path string) ServerOption

func WithTLSConfig(tls *ServerTLSConfig) ServerOption

WithTLSConfig configures TLS for the RPC server If this option is passed, the server will use ListenAndServeTLS

func WithVHosts(hosts []string) ServerOption

type ServerTLSConfig struct {
	Config    *tls.Config
	CLIConfig *optls.CLIConfig // paths to certificate and key files
}