app

Documentation

Index

• Constants
• func NewServer[T cm.IServer](classSelector T, settings cm.ISettings) (srv cm.IServer, err error)
• func NewSettingsFromFile[T cm.ISettings](classSelector T, filePath string, versionInfo *ver.Versioneer) (stn cm.ISettings, err error)
• type Application
  • func NewApplication[T1 cm.ISettings, T2 cm.IServer](settingsClassSelector T1, serverClassSelector T2, serviceName string, ...) (a *Application, err error)
  • func (a *Application) Use() (err error)
• type CommandLineArguments
  • func NewCommandLineArgumentsFromOsArgs(osArgs []string, defaultCfgFilePath string) (cla *CommandLineArguments, err error)
  • func (cla *CommandLineArguments) GetConfigurationFilePath() string
  • func (cla *CommandLineArguments) IsDefaultFile() (isDefaultFile bool)

Constants

const (
	ErrServiceName                  = "service name error"
	ErrConfigurationFilePathDefault = "default configuration file path error"
)

const (
	ServiceName_ACM  = "Access Control Module"
	ServiceName_GWM  = "Gateway Module"
	ServiceName_MM   = "Message Module"
	ServiceName_RCS  = "Captcha Module"
	ServiceName_SMTP = "SMTP Module"
)

const (
	ConfigurationFilePathDefault_ACM  = "ACM.json"
	ConfigurationFilePathDefault_GWM  = "GWM.json"
	ConfigurationFilePathDefault_MM   = "MM.json"
	ConfigurationFilePathDefault_RCS  = "RCS.json"
	ConfigurationFilePathDefault_SMTP = "SMTP.json"
)

const (
	ServiceShortName_ACM  = "ACM"
	ServiceShortName_GWM  = "GWM"
	ServiceShortName_MM   = "MM"
	ServiceShortName_RCS  = "RCS"
	ServiceShortName_SMTP = "SMTP"
)

const (
	ModuleId_ACM  = 1
	ModuleId_GWM  = 2
	ModuleId_MM   = 3
	ModuleId_RCS  = 4
	ModuleId_SMTP = 5
)

Functions

func NewServer

func NewServer[T cm.IServer](classSelector T, settings cm.ISettings) (srv cm.IServer, err error)

func NewSettingsFromFile

func NewSettingsFromFile[T cm.ISettings](classSelector T, filePath string, versionInfo *ver.Versioneer) (stn cm.ISettings, err error)

Types

type Application

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

func NewApplication

func NewApplication[T1 cm.ISettings, T2 cm.IServer](
	settingsClassSelector T1,
	serverClassSelector T2,
	serviceName string,
	configurationFilePathDefault string,
) (a *Application, err error)

func (*Application) Use

func (a *Application) Use() (err error)

type CommandLineArguments

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

func NewCommandLineArgumentsFromOsArgs

func NewCommandLineArgumentsFromOsArgs(osArgs []string, defaultCfgFilePath string) (cla *CommandLineArguments, err error)

func (*CommandLineArguments) GetConfigurationFilePath

func (cla *CommandLineArguments) GetConfigurationFilePath() string

func (*CommandLineArguments) IsDefaultFile

func (cla *CommandLineArguments) IsDefaultFile() (isDefaultFile bool)

IsDefaultFile tells whether the default file path is used for the configuration file.