grpc

Documentation

Index

• type Config
  • func NewConfig() *Config
  • func (c *Config) IsEnabled() bool
  • func (c *Config) RegisterFlagsWithPrefix(prefix string, f *pflag.FlagSet)
  • func (c *Config) Validate() error
• type MockServer
  • func (s *MockServer) GetProtoManager() protomanager.Provider
  • func (s *MockServer) Start(ctx context.Context, cancelFunc context.CancelFunc) error
• type Provider
  • func New(cfg *Config, apiManager apimanager.Provider, logger logger.Logger, ...) (Provider, error)

Types

type Config

type Config struct {
	Enable       bool
	Address      string
	ProtoManager *protomanager.Config
}

Config defines the config structure

func NewConfig

func NewConfig() *Config

NewConfig is used to init config with default values

func (*Config) IsEnabled

func (c *Config) IsEnabled() bool

IsEnabled is used to return whether the current component is enabled This attribute is required in pluggable components

func (*Config) RegisterFlagsWithPrefix

func (c *Config) RegisterFlagsWithPrefix(prefix string, f *pflag.FlagSet)

RegisterFlagsWithPrefix is used to register flags

func (*Config) Validate

func (c *Config) Validate() error

Validate is used to validate config and returns error on failure

type MockServer

type MockServer struct {
	logger.Logger
	// contains filtered or unexported fields
}

MockServer is the implement of gRPC mock server

func (*MockServer) GetProtoManager

func (s *MockServer) GetProtoManager() protomanager.Provider

GetProtoManager is used to get proto manager

func (*MockServer) Start

func (s *MockServer) Start(ctx context.Context, cancelFunc context.CancelFunc) error

Start is used to start the service

type Provider

type Provider interface {
	Start(ctx context.Context, cancelFunc context.CancelFunc) error
	GetProtoManager() protomanager.Provider
}

Provider defines the mock server interface

func New

func New(cfg *Config,
	apiManager apimanager.Provider,
	logger logger.Logger, registerer prometheus.Registerer) (Provider, error)

New is used to init service