server Namespace Reference

Classes
class	ActionMgr
	This class is responsible for the life-cycle management of actions and activities. More...
class	ActionsStd
	This class contains the implementation of the actions dealing with the standard commands from stdif.xml and the following signals: More...
class	Config
	This class provide access to the command line options and the configuration parameters stored in the configuration file. More...
class	DataContext
	This class provide access to the application run-time data including the in-memory DB. More...
class	DbInterface
	This class is the interface to the in-memory DB. More...
class	StdCmdsImpl

Functions
std::optional< std::string >	MakeStatusString (std::set< scxml4cpp::State * > &&states)
	Make a status string from active states (as returned from scxml4cpp::Executor::getStatus()). More...
log4cplus::Logger &	GetLogger ()

Variables
const std::string	CONFIG_DEFAULT_PROCNAME = "ocm"
	Default application configuration values. More...
const std::string	CONFIG_DEFAULT_FILENAME = "config/ocmServer/config.yaml"
const std::string	CONFIG_DEFAULT_SCXML_FILENAME = "config/ocmServer/sm.xml"
const std::string	CONFIG_DEFAULT_LOGLEVEL = "INFO"
const std::string	CONFIG_DEFAULT_LOG_PROPERTIES = "server/log.properties"
const std::string	CONFIG_DEFAULT_DB_ENDPOINT = "127.0.0.1:6379"
const int	CONFIG_DEFAULT_DB_TIMEOUT_SEC = 2
const std::string	CONFIG_DEFAULT_REQ_ENDPOINT = "zpb.rr://127.0.0.1:12081/"
const std::string	CONFIG_DEFAULT_PUB_ENDPOINT = "zpb.ps://127.0.0.1:12082/"
const std::string	CONFIG_ENVVAR_DBHOST = "DB_HOST"
	Application configuration environment variables. More...
const std::string	CONFIG_ENVVAR_OUT_PATH = "DATAROOT"
const std::string	KEY_CONTROL_STATE = "ctr.state"
const std::string	KEY_CONFIG_REQ_ENDPOINT = "cfg.req.endpoint"
const std::string	KEY_CONFIG_PUB_ENDPOINT = "cfg.pub.endpoint"
const std::string	KEY_CONFIG_DB_ENDPOINT = "cfg.db.endpoint"
const std::string	KEY_CONFIG_DB_TIMEOUT_SEC = "cfg.db.timeout.sec"
const std::string	KEY_CONFIG_SM_SCXML = "cfg.sm.scxml"
const std::string	KEY_CONFIG_FILENAME = "cfg.filename"
const std::string	KEY_CONFIG_LOG_LEVEL = "cfg.log.level"
const std::string	KEY_CONFIG_LOG_PROPERTIES = "cfg.log.properties"
const std::string	KEY_CONFIG_INSTRUMENT_ID = "cfg.instrument_id"
const std::string	KEY_CONFIG_DATAROOT = "cfg.dataroot"
const std::string	LOGGER_NAME = "server"

Function Documentation

GetLogger()

log4cplus::Logger & server::GetLogger

(

)

Definition at line 14 of file logger.cpp.

MakeStatusString()

std::optional< std::string > server::MakeStatusString

(

std::set< scxml4cpp::State * > &&

states

)

Make a status string from active states (as returned from scxml4cpp::Executor::getStatus()).

Assumptions:

• Top level state Off is a final state when exiting, otherwise:
• One leaf state (State::isActive() == true).
• Ancestors == 2 (On/<state>/<substate>)

Note

: scml4cpp::State does not provide const-accessors so states must be provided as non-const, but won't modiy it.

Returns

"<state>;<substate>" if assumptions hold

std::nullopt otherwise.

Definition at line 28 of file actionsStd.cpp.

Variable Documentation

CONFIG_DEFAULT_DB_ENDPOINT

const std::string server::CONFIG_DEFAULT_DB_ENDPOINT = "127.0.0.1:6379"

Definition at line 26 of file config.hpp.

CONFIG_DEFAULT_DB_TIMEOUT_SEC

const int server::CONFIG_DEFAULT_DB_TIMEOUT_SEC = 2

Definition at line 27 of file config.hpp.

CONFIG_DEFAULT_FILENAME

const std::string server::CONFIG_DEFAULT_FILENAME = "config/ocmServer/config.yaml"

Definition at line 22 of file config.hpp.

CONFIG_DEFAULT_LOG_PROPERTIES

const std::string server::CONFIG_DEFAULT_LOG_PROPERTIES = "server/log.properties"

Definition at line 25 of file config.hpp.

CONFIG_DEFAULT_LOGLEVEL

const std::string server::CONFIG_DEFAULT_LOGLEVEL = "INFO"

Definition at line 24 of file config.hpp.

CONFIG_DEFAULT_PROCNAME

const std::string server::CONFIG_DEFAULT_PROCNAME = "ocm"

Default application configuration values.

Definition at line 21 of file config.hpp.

CONFIG_DEFAULT_PUB_ENDPOINT

const std::string server::CONFIG_DEFAULT_PUB_ENDPOINT = "zpb.ps://127.0.0.1:12082/"

Definition at line 29 of file config.hpp.

CONFIG_DEFAULT_REQ_ENDPOINT

const std::string server::CONFIG_DEFAULT_REQ_ENDPOINT = "zpb.rr://127.0.0.1:12081/"

Definition at line 28 of file config.hpp.

CONFIG_DEFAULT_SCXML_FILENAME

const std::string server::CONFIG_DEFAULT_SCXML_FILENAME = "config/ocmServer/sm.xml"

Definition at line 23 of file config.hpp.

CONFIG_ENVVAR_DBHOST

const std::string server::CONFIG_ENVVAR_DBHOST = "DB_HOST"

Application configuration environment variables.

Definition at line 34 of file config.hpp.

CONFIG_ENVVAR_OUT_PATH

const std::string server::CONFIG_ENVVAR_OUT_PATH = "DATAROOT"

Definition at line 35 of file config.hpp.

KEY_CONFIG_DATAROOT

const std::string server::KEY_CONFIG_DATAROOT = "cfg.dataroot"

Definition at line 29 of file dbInterface.hpp.

KEY_CONFIG_DB_ENDPOINT

const std::string server::KEY_CONFIG_DB_ENDPOINT = "cfg.db.endpoint"

Definition at line 22 of file dbInterface.hpp.

KEY_CONFIG_DB_TIMEOUT_SEC

const std::string server::KEY_CONFIG_DB_TIMEOUT_SEC = "cfg.db.timeout.sec"

Definition at line 23 of file dbInterface.hpp.

KEY_CONFIG_FILENAME

const std::string server::KEY_CONFIG_FILENAME = "cfg.filename"

Definition at line 25 of file dbInterface.hpp.

KEY_CONFIG_INSTRUMENT_ID

const std::string server::KEY_CONFIG_INSTRUMENT_ID = "cfg.instrument_id"

Definition at line 28 of file dbInterface.hpp.

KEY_CONFIG_LOG_LEVEL

const std::string server::KEY_CONFIG_LOG_LEVEL = "cfg.log.level"

Definition at line 26 of file dbInterface.hpp.

KEY_CONFIG_LOG_PROPERTIES

const std::string server::KEY_CONFIG_LOG_PROPERTIES = "cfg.log.properties"

Definition at line 27 of file dbInterface.hpp.

KEY_CONFIG_PUB_ENDPOINT

const std::string server::KEY_CONFIG_PUB_ENDPOINT = "cfg.pub.endpoint"

Definition at line 21 of file dbInterface.hpp.

KEY_CONFIG_REQ_ENDPOINT

const std::string server::KEY_CONFIG_REQ_ENDPOINT = "cfg.req.endpoint"

Definition at line 20 of file dbInterface.hpp.

KEY_CONFIG_SM_SCXML

const std::string server::KEY_CONFIG_SM_SCXML = "cfg.sm.scxml"

Definition at line 24 of file dbInterface.hpp.

KEY_CONTROL_STATE

const std::string server::KEY_CONTROL_STATE = "ctr.state"

Definition at line 18 of file dbInterface.hpp.

LOGGER_NAME

const std::string server::LOGGER_NAME = "server"

Definition at line 17 of file logger.hpp.