s

Documentation

Index

• type BlockTimePerIncident
• type DbSettings
• type HttpsSettings
• type Settings
  • func NewSettingsFromFile(filePath string, versionInfo *ver.Versioneer) (stn *Settings, err error)
  • func (stn *Settings) Check() (err error)
  • func (stn *Settings) UseConstructor(filePath string, versionInfo *ver.Versioneer) (cmi.ISettings, error)
• type SystemSettings
  • func (s SystemSettings) Check() (err error)

Types

type BlockTimePerIncident

type BlockTimePerIncident struct {
	IllegalAccessAttempt            base2.Count `json:"illegalAccessAttempt"`            // 1.
	ReadingNotificationOfOtherUsers base2.Count `json:"readingNotificationOfOtherUsers"` // 2.
	WrongDKey                       base2.Count `json:"wrongDKey"`                       // 3.
}

BlockTimePerIncident is block time in seconds for each type of incident.

type DbSettings

type DbSettings = cs.DbSettings

DbSettings are parameters of the Database.

type HttpsSettings

type HttpsSettings = cs.HttpsSettings

HttpsSettings are settings of an HTTPS server for incoming requests.

type Settings

type Settings struct {
	// Path to the file with these settings.
	FilePath cm.Path `json:"-"`

	// Program versioning information.
	VersionInfo *ver.Versioneer `json:"-"`

	HttpsSettings  `json:"https"`
	DbSettings     `json:"db"`
	SystemSettings `json:"system"`

	// External services.
	AcmSettings s.ServiceClientSettings `json:"acm"`
	GwmSettings s.ServiceClientSettings `json:"gwm"`
	SmSettings  s.ServiceClientSettings `json:"sm"`
}

Settings is Server's settings.

func NewSettingsFromFile

func NewSettingsFromFile(filePath string, versionInfo *ver.Versioneer) (stn *Settings, err error)

func (*Settings) Check

func (stn *Settings) Check() (err error)

func (*Settings) UseConstructor

func (stn *Settings) UseConstructor(filePath string, versionInfo *ver.Versioneer) (cmi.ISettings, error)

type SystemSettings

type SystemSettings struct {
	NotificationTtl        base2.Count `json:"notificationTtl"`
	NotificationCountLimit base2.Count `json:"notificationCountLimit"`
	PageSize               base2.Count `json:"pageSize"`
	DKeySize               base2.Count `json:"dKeySize"`

	// This setting must be synchronised with settings of the Gateway module.
	IsTableOfIncidentsUsed base2.Flag `json:"isTableOfIncidentsUsed"`

	// This setting is used only when a table of incidents is enabled.
	BlockTimePerIncident BlockTimePerIncident `json:"blockTimePerIncident"`

	IsDebugMode base2.Flag `json:"isDebugMode"`
}

SystemSettings are system settings.

func (SystemSettings) Check

func (s SystemSettings) Check() (err error)