dds Namespace Reference

Miscellaneous functions and helpers are located here. More...

Namespaces
	agent_cmd
	agent_cmd_cmd
	commander_cmd
	custom_cmd
	info_cmd
	intercom_api
	DDS intercom API.
	internal_api
	misc
	pipe_log_engine
	protocol_api
	session_cmd
	ssh_cmd
	submit_cmd
	tools_api
	topology_api
	topology_cmd
	user_defaults_api

Classes
class	CMonitoringThread
class	CSMIntercomChannel
class	CSSHConfigFile
	Reads dds-ssh configuration file either from a text file or stream. More...
struct	SConfigRecord
	The class represents a single record of a dds-ssh configuration file. More...

Typedefs
typedef std::map< EAgentCmdType, std::string >	mapAgentCmdTypeCodes_t
using	configRecord_t = std::shared_ptr< SConfigRecord >
using	configRecords_t = std::vector< configRecord_t >

Enumerations
enum	EAgentCmdType { EAgentCmdType::UNKNOWN = -1, EAgentCmdType::GETLOG = 0 }
enum	EEnvProp {   task_id, task_index, task_name, task_path,   collection_index, collection_name, group_name, dds_location,   dds_session_id, dds_slot_id }
	a list of envioronment properties More...

Functions
std::istream &	operator>> (std::istream &_in, EAgentCmdType &_agentCmd)
std::ostream &	operator<< (std::ostream &_out, EAgentCmdType &_agentCmd)
template<EEnvProp T>
std::enable_if< T==task_id||T==dds_slot_id, uint64_t >::type	env_prop ()
	The function returns a value for a given environment property. More...
template<EEnvProp T>
std::enable_if< T==task_index||T==collection_index, size_t >::type	env_prop ()
	The function returns a value for a given environment property. More...
template<EEnvProp T>
std::enable_if< T==task_name||T==collection_name||T==group_name||T==dds_location||T==task_path||T==dds_session_id, std::string >::type	env_prop ()
	The function returns a value for a given environment property. More...

Variables
const mapAgentCmdTypeCodes_t	AgentCmdTypeCodeToString = { { EAgentCmdType::GETLOG, "getlog" } }

Detailed Description

Miscellaneous functions and helpers are located here.

Typedef Documentation

configRecord_t

using dds::configRecord_t = typedef std::shared_ptr<SConfigRecord>

configRecords_t

using dds::configRecords_t = typedef std::vector<configRecord_t>

mapAgentCmdTypeCodes_t

typedef std::map<EAgentCmdType, std::string> dds::mapAgentCmdTypeCodes_t

Enumeration Type Documentation

EAgentCmdType

enum dds::EAgentCmdType

strong

Enumerator
UNKNOWN
GETLOG

EEnvProp

enum dds::EEnvProp

a list of envioronment properties

Enumerator
task_id	associated with $DDS_TASK_ID environment variable.
task_index	associated with $DDS_TASK_INDEX environment variable.
task_name	associated with $DDS_TASK_NAME - ID of the task.
task_path	associated with $DDS_TASK_PATH - full path to the user task, for example, main/group1/collection_12/task_3.
collection_index	associated with $DDS_COLLECTION_INDEX environemnt variable.
collection_name	associated with $DDS_COLLECTION_NAME - ID of the parent collection.
group_name	associated with $DDS_GROUP_NAME - ID of the parent group.
dds_location	associated with $DDS_LOCATION environemnt variable.
dds_session_id	associated with $DDS_SESSION_ID - session ID of the DDS.
dds_slot_id	associated with $DDS_SLOT_ID - slot ID

Function Documentation

env_prop() [1/3]

template<EEnvProp T>

std::enable_if<T == task_id || T == dds_slot_id, uint64_t>::type dds::env_prop ( )

inline

The function returns a value for a given environment property.

Example Usage:

#include "DDSEnvProp.h"
uint64_t val = env_prop<task_id>();

Template Parameters

T	type one of the environment property listed in EEnvProp.

Returns

a numeric value for a given environment property.

env_prop() [2/3]

template<EEnvProp T>

std::enable_if<T == task_index || T == collection_index, size_t>::type dds::env_prop ( )

inline

The function returns a value for a given environment property.

Example Usage:

#include "DDSEnvProp.h"
size_t val = env_prop<collection_index>();

Template Parameters

T	type one of the environment property listed in EEnvProp.

Returns

a numeric value for a given environment property.

env_prop() [3/3]

template<EEnvProp T>

std::enable_if<T == task_name || T == collection_name || T == group_name || T == dds_location || T == task_path || T == dds_session_id, std::string>::type dds::env_prop ( )

inline

The function returns a value for a given environment property.

Example Usage:

#include "DDSEnvProp.h"
std::string val = env_prop<task_name>();

Template Parameters

T	type one of the environment property listed in enum EEnvProp.

Returns

a string value for a given environment property.

operator<<()

std::ostream& dds::operator<< ( std::ostream &  _out, EAgentCmdType &  _agentCmd  )

inline

operator>>()

std::istream& dds::operator>> ( std::istream &  _in, EAgentCmdType &  _agentCmd  )

inline

Variable Documentation

AgentCmdTypeCodeToString

const mapAgentCmdTypeCodes_t dds::AgentCmdTypeCodeToString = { { EAgentCmdType::GETLOG, "getlog" } }