apiserver

Documentation

Index

• type APIServer
  • func New(cfg Config) (*APIServer, error)
  • func (s *APIServer) Serve() error
  • func (s *APIServer) Stop()
• type Config
  • func (c *Config) CheckAndSetDefaults() error

Types

type APIServer

type APIServer struct {
	Config
	// contains filtered or unexported fields
}

Server is a combination of the underlying grpc.Server and its RuntimeOpts.

func New

func New(cfg Config) (*APIServer, error)

New creates an instance of API Server

func (*APIServer) Serve

func (s *APIServer) Serve() error

Serve starts accepting incoming connections

func (*APIServer) Stop

func (s *APIServer) Stop()

Stop stops the server and closes all listeners

type Config

type Config struct {
	// HostAddr is the APIServer host address
	HostAddr string
	// Daemon is the terminal daemon service
	Daemon *daemon.Service
	// Log is a component logger
	Log             logrus.FieldLogger
	TshdServerCreds grpc.ServerOption
	// ListeningC propagates the address on which the gRPC server listens. Mostly useful in tests, as
	// the Electron app gets the server port from stdout.
	ListeningC chan<- utils.NetAddr
}

Config is the APIServer configuration

func (*Config) CheckAndSetDefaults

func (c *Config) CheckAndSetDefaults() error

CheckAndSetDefaults checks and sets default config values.