rpc

package

v1.4.2 Latest Latest Go to latest Published: Apr 23, 2024 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kroma-network/kroma

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CLIFlags(envPrefix string) []cli.Flag
func ToGethAdminAPI(api *CommonAdminAPI) rpc.API
type CLIConfig
- func DefaultCLIConfig() CLIConfig
- func ReadCLIConfig(ctx *cli.Context) CLIConfig
- func (c CLIConfig) Check() error
type CommonAdminAPI
- func NewCommonAdminAPI(m metrics.RPCMetricer, log log.Logger) *CommonAdminAPI
- func (n *CommonAdminAPI) SetLogLevel(ctx context.Context, lvlStr string) error
type HealthzResponse
type Middleware
type Server
- func NewServer(host string, port int, appVersion string, opts ...ServerOption) *Server
type ServerOption
type ServerTLSConfig

Constants ¶

View Source

const (
	ListenAddrFlagName  = "rpc.addr"
	PortFlagName        = "rpc.port"
	EnableAdminFlagName = "rpc.enable-admin"
)

Variables ¶

This section is empty.

Functions ¶

func CLIFlags ¶

func CLIFlags(envPrefix string) []cli.Flag

func ToGethAdminAPI ¶ added in v1.2.0

func ToGethAdminAPI(api *CommonAdminAPI) rpc.API

Types ¶

type CLIConfig ¶

type CLIConfig struct {
	ListenAddr  string
	ListenPort  int
	EnableAdmin bool
}

func DefaultCLIConfig ¶ added in v1.3.0

func DefaultCLIConfig() CLIConfig

func ReadCLIConfig ¶

func ReadCLIConfig(ctx *cli.Context) CLIConfig

func (CLIConfig) Check ¶

func (c CLIConfig) Check() error

type CommonAdminAPI ¶

type CommonAdminAPI struct {
	M metrics.RPCMetricer
	// contains filtered or unexported fields
}

func NewCommonAdminAPI ¶

func NewCommonAdminAPI(m metrics.RPCMetricer, log log.Logger) *CommonAdminAPI

func (*CommonAdminAPI) SetLogLevel ¶

func (n *CommonAdminAPI) SetLogLevel(ctx context.Context, lvlStr string) error

type HealthzResponse ¶

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

type Middleware ¶

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

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 WithMiddleware ¶

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 ¶

func WithRPCPath(path string) ServerOption

func WithTLSConfig ¶

func WithTLSConfig(tls *ServerTLSConfig) ServerOption

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

func WithVHosts ¶

func WithVHosts(hosts []string) ServerOption

type ServerTLSConfig ¶

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL