servers

Documentation

Overview

Package servers implements the components required for the servers.

Index

• func NewCommunityServerInitializer(displayName string, serviceKinds []services.ServiceKind) (servers.ServerInitializer, error)
• type CommunityServerInitializer
  • func (c *CommunityServerInitializer) HasCentralStorage() bool
  • func (c *CommunityServerInitializer) HostInfo() *services.HostInfo
  • func (c *CommunityServerInitializer) Services() []services.ServiceKind
  • func (c *CommunityServerInitializer) ServicesFactories() (map[services.ServiceKind]services.ServiceFactoryProvider, error)
  • func (c *CommunityServerInitializer) Storages(centralStorageEngine storage.Kind) []storage.Kind
  • func (c *CommunityServerInitializer) StoragesFactories(centralStorageEngine storage.Kind) (map[storage.Kind]storage.FactoryProvider, error)
• type Server
  • func (s *Server) DisplayName() string
  • func (s *Server) HasDebug() bool
  • func (s *Server) Logger() *zap.Logger
  • func (s *Server) Serve(ctx context.Context, onShutdown func()) (bool, error)
  • func (s *Server) Shutdown(ctx context.Context)
• type ServerConfig
  • func (c *ServerConfig) AddFlags(flagSet *flag.FlagSet) error
  • func (c *ServerConfig) AppData() string
  • func (c *ServerConfig) CentralStorageEngine() storage.Kind
  • func (c *ServerConfig) DisplayName() string
  • func (c *ServerConfig) InitFromViper(v *viper.Viper) error
  • func (c *ServerConfig) Services() []services.ServiceKind
  • func (c *ServerConfig) ServicesFactories() map[services.ServiceKind]services.ServiceFactoryProvider
  • func (c *ServerConfig) Storages() []storage.Kind
  • func (c *ServerConfig) StoragesFactories() map[storage.Kind]storage.FactoryProvider
• type ServerFactory
  • func NewServerFactory(serverCfg *ServerFactoryConfig) (*ServerFactory, error)
  • func (f *ServerFactory) CreateServer() (*Server, error)
• type ServerFactoryConfig
  • func NewServerFactoryConfig(initializer servers.ServerInitializer, centralStorageEngine storage.Kind) (*ServerFactoryConfig, error)
  • func (c *ServerFactoryConfig) AddFlags(flagSet *flag.FlagSet) error
  • func (c *ServerFactoryConfig) InitFromViper(v *viper.Viper) error

Functions

func NewCommunityServerInitializer

func NewCommunityServerInitializer(displayName string, serviceKinds []services.ServiceKind) (servers.ServerInitializer, error)

NewCommunityServerInitializer creates a new community server initializer.

Types

type CommunityServerInitializer

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

CommunityServerInitializer is the community service factory initializer.

func (*CommunityServerInitializer) HasCentralStorage

func (c *CommunityServerInitializer) HasCentralStorage() bool

HasCentralStorage returns true if a central storage is required.

func (*CommunityServerInitializer) HostInfo

func (c *CommunityServerInitializer) HostInfo() *services.HostInfo

HostInfo returns the infos of the service kind set as host.

func (*CommunityServerInitializer) Services

func (c *CommunityServerInitializer) Services() []services.ServiceKind

Services returns the active service kinds.

func (*CommunityServerInitializer) ServicesFactories

func (c *CommunityServerInitializer) ServicesFactories() (map[services.ServiceKind]services.ServiceFactoryProvider, error)

ServicesFactories returns the service factories providers.

func (*CommunityServerInitializer) Storages

func (c *CommunityServerInitializer) Storages(centralStorageEngine storage.Kind) []storage.Kind

Storages returns the active storage kinds.

func (*CommunityServerInitializer) StoragesFactories

func (c *CommunityServerInitializer) StoragesFactories(centralStorageEngine storage.Kind) (map[storage.Kind]storage.FactoryProvider, error)

StoragesFactories returns the storage factories providers.

type Server

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

Server represents the applicative server.

func (*Server) DisplayName

func (s *Server) DisplayName() string

DisplayName returns the display name.

func (*Server) HasDebug

func (s *Server) HasDebug() bool

HasDebug returns true if debug is enabled.

func (*Server) Logger

func (s *Server) Logger() *zap.Logger

Logger returns the logger.

func (*Server) Serve

func (s *Server) Serve(ctx context.Context, onShutdown func()) (bool, error)

Serve runs the server and then calls the onshutdown function.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context)

Shutdown signals the server to shutdown.

type ServerConfig

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

ServerConfig holds the configuration for the server.

func (*ServerConfig) AddFlags

func (c *ServerConfig) AddFlags(flagSet *flag.FlagSet) error

AddFlags adds flags.

func (*ServerConfig) AppData

func (c *ServerConfig) AppData() string

AppData returns the zone data.

func (*ServerConfig) CentralStorageEngine

func (c *ServerConfig) CentralStorageEngine() storage.Kind

CentralStorageEngine returns the central storage engine.

func (*ServerConfig) DisplayName

func (c *ServerConfig) DisplayName() string

DisplayName returns the display name.

func (*ServerConfig) InitFromViper

func (c *ServerConfig) InitFromViper(v *viper.Viper) error

InitFromViper initializes the configuration from viper.

func (*ServerConfig) Services

func (c *ServerConfig) Services() []services.ServiceKind

Services returns service kinds.

func (*ServerConfig) ServicesFactories

func (c *ServerConfig) ServicesFactories() map[services.ServiceKind]services.ServiceFactoryProvider

ServicesFactories returns factories.

func (*ServerConfig) Storages

func (c *ServerConfig) Storages() []storage.Kind

Storages returns service kinds.

func (*ServerConfig) StoragesFactories

func (c *ServerConfig) StoragesFactories() map[storage.Kind]storage.FactoryProvider

StoragesFactories returns factories.

type ServerFactory

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

ServerFactory is the configuration for the server factory.

func NewServerFactory

func NewServerFactory(serverCfg *ServerFactoryConfig) (*ServerFactory, error)

NewServerFactory creates the server factory.

func (*ServerFactory) CreateServer

func (f *ServerFactory) CreateServer() (*Server, error)

CreateServer creates a new server.

type ServerFactoryConfig

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

ServerFactoryConfig holds the configuration for the server factory.

func NewServerFactoryConfig

func NewServerFactoryConfig(initializer servers.ServerInitializer, centralStorageEngine storage.Kind) (*ServerFactoryConfig, error)

NewServerFactoryConfig creates a new server factory configuration.

func (*ServerFactoryConfig) AddFlags

func (c *ServerFactoryConfig) AddFlags(flagSet *flag.FlagSet) error

AddFlags adds flags.

func (*ServerFactoryConfig) InitFromViper

func (c *ServerFactoryConfig) InitFromViper(v *viper.Viper) error

InitFromViper initializes the configuration from viper.