DDS  ver. 3.4
Classes | Typedefs | Enumerations | Functions | Variables
dds::protocol_api Namespace Reference

Classes

class  CBaseChannelImpl
 
class  CBaseEventHandlersImpl
 
class  CBaseSMChannelImpl
 
class  CChannelEventHandlersImpl
 
class  CChannelMessageHandlersImpl
 
class  CClientChannelImpl
 
class  CConnectionManagerImpl
 Base class for connection managers. More...
 
class  CProtocolMessage
 
class  CServerChannelImpl
 
class  CStatImpl
 
struct  SAgentsInfoCmd
 
struct  SAssignUserTaskCmd
 
struct  SAttachmentDataProvider
 
struct  SBasicCmd
 
struct  SBinaryAttachmentCmd
 
struct  SBinaryAttachmentInfo
 
struct  SBinaryAttachmentReceivedCmd
 
struct  SBinaryAttachmentStartCmd
 
struct  SChannelInfo
 
struct  SCommandAttachmentImpl
 
struct  SCustomCmdCmd
 
struct  SEmptyCmd
 
struct  SGetPropValuesCmd
 
struct  SHandlerHlpBaseFunc
 
struct  SHandlerHlpFunc
 Helpers for event dispatching. More...
 
struct  SHostInfoCmd
 
struct  SIDCmd
 
struct  SMessageHeader
 
struct  SProgressCmd
 
struct  SReadStat
 
struct  SReplyCmd
 
struct  SSenderInfo
 
struct  SSimpleMsgCmd
 
struct  SStatParams
 
struct  SSubmitCmd
 
struct  SUpdateKeyCmd
 
struct  SUpdateTopologyCmd
 
struct  SUserTaskDoneCmd
 
struct  SVersionCmd
 
struct  SWeakChannelInfo
 
struct  SWriteStat
 

Typedefs

typedef std::shared_ptr< SBinaryAttachmentInfobinaryAttachmentInfoPtr_t
 
typedef boost::asio::basic_socket_acceptor< boost::asio::ip::tcp > asioAcceptor_t
 
typedef std::shared_ptr< asioAcceptor_tasioAcceptorPtr_t
 
typedef std::vector< EChannelTypechannelTypeVector_t
 
typedef boost::accumulators::accumulator_set< double, boost::accumulators::features< boost::accumulators::tag::mean, boost::accumulators::tag::max, boost::accumulators::tag::count, boost::accumulators::tag::sum > > statsAccumulator_t
 
typedef std::map< uint16_t, statsAccumulator_tstatsAccumulatorMap_t
 
typedef std::map< uint16_t, SStatParamsstatParamsMap_t
 

Enumerations

enum  EMQOpenType { EMQOpenType::CreateOnly, EMQOpenType::OpenOrCreate, EMQOpenType::OpenOnly }
 
enum  EChannelEvents {
  EChannelEvents::OnConnected, EChannelEvents::OnFailedToConnect, EChannelEvents::OnRemoteEndDissconnected, EChannelEvents::OnHandshakeOK,
  EChannelEvents::OnHandshakeFailed, EChannelEvents::OnAssignUserTask, EChannelEvents::OnSMStart, EChannelEvents::OnReplyAddSlot,
  EChannelEvents::OnChangeChannelInfo
}
 Channel events, which channels and users of channel objects can subscribe on. More...
 
enum  ECmdType {
  cmdUNKNOWN = 1, cmdRAW_MSG = 2, cmdSHUTDOWN = 3, cmdHANDSHAKE,
  cmdSUBMIT, cmdSIMPLE_MSG, cmdREPLY_HANDSHAKE_OK, cmdREPLY_HANDSHAKE_ERR,
  cmdGET_HOST_INFO, cmdREPLY_HOST_INFO, cmdGED_PID, cmdREPLY_PID,
  cmdBINARY_ATTACHMENT, cmdBINARY_ATTACHMENT_RECEIVED, cmdBINARY_ATTACHMENT_START, cmdGET_ID,
  cmdREPLY_ID, cmdSET_ID, cmdGET_LOG, cmdGET_AGENTS_INFO,
  cmdREPLY_AGENTS_INFO, cmdASSIGN_USER_TASK, cmdACTIVATE_USER_TASK, cmdSTOP_USER_TASK,
  cmdUSER_TASK_DONE, cmdTRANSPORT_TEST, cmdUPDATE_KEY, cmdGET_PROP_LIST,
  cmdGET_PROP_VALUES, cmdPROGRESS, cmdWATCHDOG_HEARTBEAT, cmdSET_TOPOLOGY,
  cmdUPDATE_TOPOLOGY, cmdENABLE_STAT, cmdDISABLE_STAT, cmdGET_STAT,
  cmdCUSTOM_CMD, cmdLOBBY_MEMBER_INFO, cmdLOBBY_MEMBER_HANDSHAKE, cmdREPLY,
  cmdGET_IDLE_AGENTS_COUNT, cmdREPLY_IDLE_AGENTS_COUNT, cmdADD_SLOT, cmdREPLY_ADD_SLOT
}
 
enum  EChannelType { UNKNOWN = 0, AGENT, UI }
 

Functions

std::ostream & operator<< (std::ostream &_stream, const SAgentsInfoCmd &_val)
 
bool operator!= (const SAgentsInfoCmd &_lhs, const SAgentsInfoCmd &_rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SAssignUserTaskCmd &val)
 
bool operator!= (const SAssignUserTaskCmd &lhs, const SAssignUserTaskCmd &rhs)
 
template<typename T >
size_t dsize (const T &_value)
 All vectors (except uint8_t) have a maximum size of uint16_t i.e. 2^16. All vector<uint8_t>'s have a maximum size of uint32_t i.e. 2^32. All std::string's have a maximum size of uint16_t i.e. 2^16. More...
 
template<>
size_t dsize< uint8_t > (const uint8_t &_value)
 Helper function calculating size of uint8_t. More...
 
template<>
size_t dsize< uint16_t > (const uint16_t &_value)
 Helper function calculating size of uint16_t. More...
 
template<>
size_t dsize< uint32_t > (const uint32_t &_value)
 Helper function calculating size of uint32_t. More...
 
template<>
size_t dsize< uint64_t > (const uint64_t &_value)
 Helper function calculating size of uint64_t. More...
 
template<>
size_t dsize< std::string > (const std::string &_value)
 Helper function calculating size of std::string. More...
 
template<>
size_t dsize< std::vector< uint8_t > > (const std::vector< uint8_t > &_value)
 Helper function calculating size of the vector of uint8_t. More...
 
template<>
size_t dsize< std::vector< uint16_t > > (const std::vector< uint16_t > &_value)
 Helper function calculating size of the vector of uint16_t. More...
 
template<>
size_t dsize< std::vector< uint32_t > > (const std::vector< uint32_t > &_value)
 Helper function calculating size of the vector of uint32_t. More...
 
template<>
size_t dsize< std::vector< uint64_t > > (const std::vector< uint64_t > &_value)
 Helper function calculating size of the vector of uint64_t. More...
 
template<>
size_t dsize< std::vector< std::string > > (const std::vector< std::string > &_value)
 Helper function calculating size of the vector of std::string. More...
 
template<>
size_t dsize< boost::uuids::uuid > (const boost::uuids::uuid &_value)
 Helper function calculating size of the boost::uuids::uuid. More...
 
template<typename T >
void readData (T *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 Helper template function reading data from byte array. More...
 
template<>
void readData< uint8_t > (uint8_t *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< uint16_t > (uint16_t *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< uint32_t > (uint32_t *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< uint64_t > (uint64_t *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< std::string > (std::string *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< boost::uuids::uuid > (boost::uuids::uuid *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<typename T >
void readDataVector (std::vector< T > *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< std::vector< uint8_t > > (std::vector< uint8_t > *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< std::vector< uint16_t > > (std::vector< uint16_t > *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< std::vector< uint32_t > > (std::vector< uint32_t > *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< std::vector< uint64_t > > (std::vector< uint64_t > *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<>
void readData< std::vector< std::string > > (std::vector< std::string > *_value, const MiscCommon::BYTEVector_t *_data, size_t *_nPos)
 
template<typename T >
void pushData (const T &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< uint8_t > (const uint8_t &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< uint16_t > (const uint16_t &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< uint32_t > (const uint32_t &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< uint64_t > (const uint64_t &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< std::string > (const std::string &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< boost::uuids::uuid > (const boost::uuids::uuid &_value, MiscCommon::BYTEVector_t *_data)
 
template<typename T >
void pushDataVector (const std::vector< T > &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< std::vector< uint8_t > > (const std::vector< uint8_t > &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< std::vector< uint16_t > > (const std::vector< uint16_t > &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< std::vector< uint32_t > > (const std::vector< uint32_t > &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< std::vector< uint64_t > > (const std::vector< uint64_t > &_value, MiscCommon::BYTEVector_t *_data)
 
template<>
void pushData< std::vector< std::string > > (const std::vector< std::string > &_value, MiscCommon::BYTEVector_t *_data)
 
std::ostream & operator<< (std::ostream &_stream, const SBinaryAttachmentCmd &_val)
 
bool operator!= (const SBinaryAttachmentCmd &lhs, const SBinaryAttachmentCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SBinaryAttachmentReceivedCmd &_val)
 
bool operator!= (const SBinaryAttachmentReceivedCmd &lhs, const SBinaryAttachmentReceivedCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SBinaryAttachmentStartCmd &_val)
 
bool operator!= (const SBinaryAttachmentStartCmd &lhs, const SBinaryAttachmentStartCmd &rhs)
 
template<class T >
bool operator== (const SChannelInfo< T > &lhs, const SChannelInfo< T > &rhs)
 
template<class T >
bool operator== (const SWeakChannelInfo< T > &lhs, const SWeakChannelInfo< T > &rhs)
 
 REGISTER_CMD_ATTACHMENT (SVersionCmd, cmdHANDSHAKE) REGISTER_CMD_ATTACHMENT(SSimpleMsgCmd
 
cmdREPLY_HANDSHAKE_ERR REGISTER_CMD_ATTACHMENT (SSubmitCmd, cmdSUBMIT) REGISTER_CMD_ATTACHMENT(SSimpleMsgCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG REGISTER_CMD_ATTACHMENT (SHostInfoCmd, cmdREPLY_HOST_INFO) REGISTER_CMD_ATTACHMENT(SSimpleMsgCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID REGISTER_CMD_ATTACHMENT (SBinaryAttachmentCmd, cmdBINARY_ATTACHMENT) REGISTER_CMD_ATTACHMENT(SIDCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID REGISTER_CMD_ATTACHMENT (SIDCmd, cmdSET_ID) REGISTER_CMD_ATTACHMENT(SAgentsInfoCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO REGISTER_CMD_ATTACHMENT (SAssignUserTaskCmd, cmdASSIGN_USER_TASK) REGISTER_CMD_ATTACHMENT(SBinaryAttachmentReceivedCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED REGISTER_CMD_ATTACHMENT (SBinaryAttachmentStartCmd, cmdBINARY_ATTACHMENT_START) REGISTER_CMD_ATTACHMENT(SUpdateKeyCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED cmdUPDATE_KEY REGISTER_CMD_ATTACHMENT (SProgressCmd, cmdPROGRESS) REGISTER_CMD_ATTACHMENT(SUserTaskDoneCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED cmdUPDATE_KEY cmdUSER_TASK_DONE REGISTER_CMD_ATTACHMENT (SGetPropValuesCmd, cmdGET_PROP_VALUES) REGISTER_CMD_ATTACHMENT(SUpdateTopologyCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED cmdUPDATE_KEY cmdUSER_TASK_DONE cmdUPDATE_TOPOLOGY REGISTER_CMD_ATTACHMENT (SCustomCmdCmd, cmdCUSTOM_CMD) REGISTER_CMD_ATTACHMENT(SSimpleMsgCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED cmdUPDATE_KEY cmdUSER_TASK_DONE cmdUPDATE_TOPOLOGY cmdLOBBY_MEMBER_INFO REGISTER_CMD_ATTACHMENT (SVersionCmd, cmdLOBBY_MEMBER_HANDSHAKE) REGISTER_CMD_ATTACHMENT(SReplyCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED cmdUPDATE_KEY cmdUSER_TASK_DONE cmdUPDATE_TOPOLOGY cmdLOBBY_MEMBER_INFO cmdREPLY REGISTER_CMD_ATTACHMENT (SSimpleMsgCmd, cmdREPLY_IDLE_AGENTS_COUNT) REGISTER_CMD_ATTACHMENT(SIDCmd
 
cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID cmdREPLY_AGENTS_INFO cmdBINARY_ATTACHMENT_RECEIVED cmdUPDATE_KEY cmdUSER_TASK_DONE cmdUPDATE_TOPOLOGY cmdLOBBY_MEMBER_INFO cmdREPLY cmdADD_SLOT REGISTER_CMD_ATTACHMENT (SIDCmd, cmdREPLY_ADD_SLOT) REGISTER_CMD_ATTACHMENT(SIDCmd
 
std::ostream & operator<< (std::ostream &_stream, const SCustomCmdCmd &val)
 
bool operator!= (const SCustomCmdCmd &lhs, const SCustomCmdCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SGetPropValuesCmd &val)
 
bool operator!= (const SGetPropValuesCmd &lhs, const SGetPropValuesCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SHostInfoCmd &val)
 
bool operator!= (const SHostInfoCmd &lhs, const SHostInfoCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SProgressCmd &val)
 
bool operator!= (const SProgressCmd &lhs, const SProgressCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SReplyCmd &val)
 
bool operator!= (const SReplyCmd &lhs, const SReplyCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SSimpleMsgCmd &val)
 
bool operator!= (const SSimpleMsgCmd &lhs, const SSimpleMsgCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SSubmitCmd &val)
 
bool operator!= (const SSubmitCmd &lhs, const SSubmitCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SUpdateKeyCmd &val)
 
bool operator!= (const SUpdateKeyCmd &lhs, const SUpdateKeyCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SUpdateTopologyCmd &val)
 
bool operator!= (const SUpdateTopologyCmd &lhs, const SUpdateTopologyCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SUserTaskDoneCmd &val)
 
bool operator!= (const SUserTaskDoneCmd &lhs, const SUserTaskDoneCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SIDCmd &_val)
 
bool operator!= (const SIDCmd &lhs, const SIDCmd &rhs)
 
std::ostream & operator<< (std::ostream &_stream, const SVersionCmd &val)
 
bool operator!= (const SVersionCmd &lhs, const SVersionCmd &rhs)
 

Variables

const std::array< std::string, 3 > gChannelTypeName { { "unknown", "agent", "ui" } }
 

Typedef Documentation

◆ asioAcceptor_t

typedef boost::asio::basic_socket_acceptor<boost::asio::ip::tcp> dds::protocol_api::asioAcceptor_t

◆ asioAcceptorPtr_t

◆ binaryAttachmentInfoPtr_t

◆ channelTypeVector_t

◆ statParamsMap_t

typedef std::map<uint16_t, SStatParams> dds::protocol_api::statParamsMap_t

◆ statsAccumulator_t

typedef boost::accumulators::accumulator_set<double, boost::accumulators::features<boost::accumulators::tag::mean, boost::accumulators::tag::max, boost::accumulators::tag::count, boost::accumulators::tag::sum> > dds::protocol_api::statsAccumulator_t

◆ statsAccumulatorMap_t

Enumeration Type Documentation

◆ EChannelEvents

Channel events, which channels and users of channel objects can subscribe on.

Enumerator
OnConnected 
OnFailedToConnect 
OnRemoteEndDissconnected 
OnHandshakeOK 
OnHandshakeFailed 
OnAssignUserTask 
OnSMStart 

Shared memory channel start.

OnReplyAddSlot 
OnChangeChannelInfo 

◆ EChannelType

Enumerator
UNKNOWN 
AGENT 
UI 

◆ ECmdType

Enumerator
cmdUNKNOWN 
cmdRAW_MSG 
cmdSHUTDOWN 
cmdHANDSHAKE 
cmdSUBMIT 
cmdSIMPLE_MSG 
cmdREPLY_HANDSHAKE_OK 
cmdREPLY_HANDSHAKE_ERR 
cmdGET_HOST_INFO 
cmdREPLY_HOST_INFO 
cmdGED_PID 
cmdREPLY_PID 
cmdBINARY_ATTACHMENT 
cmdBINARY_ATTACHMENT_RECEIVED 
cmdBINARY_ATTACHMENT_START 
cmdGET_ID 
cmdREPLY_ID 
cmdSET_ID 
cmdGET_LOG 
cmdGET_AGENTS_INFO 
cmdREPLY_AGENTS_INFO 
cmdASSIGN_USER_TASK 
cmdACTIVATE_USER_TASK 
cmdSTOP_USER_TASK 
cmdUSER_TASK_DONE 
cmdTRANSPORT_TEST 
cmdUPDATE_KEY 
cmdGET_PROP_LIST 
cmdGET_PROP_VALUES 
cmdPROGRESS 
cmdWATCHDOG_HEARTBEAT 
cmdSET_TOPOLOGY 
cmdUPDATE_TOPOLOGY 
cmdENABLE_STAT 
cmdDISABLE_STAT 
cmdGET_STAT 
cmdCUSTOM_CMD 
cmdLOBBY_MEMBER_INFO 
cmdLOBBY_MEMBER_HANDSHAKE 
cmdREPLY 
cmdGET_IDLE_AGENTS_COUNT 
cmdREPLY_IDLE_AGENTS_COUNT 
cmdADD_SLOT 
cmdREPLY_ADD_SLOT 

◆ EMQOpenType

Enumerator
CreateOnly 
OpenOrCreate 
OpenOnly 

Function Documentation

◆ dsize()

template<typename T >
size_t dds::protocol_api::dsize ( const T &  _value)

All vectors (except uint8_t) have a maximum size of uint16_t i.e. 2^16. All vector<uint8_t>'s have a maximum size of uint32_t i.e. 2^32. All std::string's have a maximum size of uint16_t i.e. 2^16.

Helper template function calculating size of the variable.

◆ dsize< boost::uuids::uuid >()

template<>
size_t dds::protocol_api::dsize< boost::uuids::uuid > ( const boost::uuids::uuid &  _value)
inline

Helper function calculating size of the boost::uuids::uuid.

◆ dsize< std::string >()

template<>
size_t dds::protocol_api::dsize< std::string > ( const std::string &  _value)
inline

Helper function calculating size of std::string.

◆ dsize< std::vector< std::string > >()

template<>
size_t dds::protocol_api::dsize< std::vector< std::string > > ( const std::vector< std::string > &  _value)
inline

Helper function calculating size of the vector of std::string.

◆ dsize< std::vector< uint16_t > >()

template<>
size_t dds::protocol_api::dsize< std::vector< uint16_t > > ( const std::vector< uint16_t > &  _value)
inline

Helper function calculating size of the vector of uint16_t.

◆ dsize< std::vector< uint32_t > >()

template<>
size_t dds::protocol_api::dsize< std::vector< uint32_t > > ( const std::vector< uint32_t > &  _value)
inline

Helper function calculating size of the vector of uint32_t.

◆ dsize< std::vector< uint64_t > >()

template<>
size_t dds::protocol_api::dsize< std::vector< uint64_t > > ( const std::vector< uint64_t > &  _value)
inline

Helper function calculating size of the vector of uint64_t.

◆ dsize< std::vector< uint8_t > >()

template<>
size_t dds::protocol_api::dsize< std::vector< uint8_t > > ( const std::vector< uint8_t > &  _value)
inline

Helper function calculating size of the vector of uint8_t.

◆ dsize< uint16_t >()

template<>
size_t dds::protocol_api::dsize< uint16_t > ( const uint16_t &  _value)
inline

Helper function calculating size of uint16_t.

◆ dsize< uint32_t >()

template<>
size_t dds::protocol_api::dsize< uint32_t > ( const uint32_t &  _value)
inline

Helper function calculating size of uint32_t.

◆ dsize< uint64_t >()

template<>
size_t dds::protocol_api::dsize< uint64_t > ( const uint64_t &  _value)
inline

Helper function calculating size of uint64_t.

◆ dsize< uint8_t >()

template<>
size_t dds::protocol_api::dsize< uint8_t > ( const uint8_t &  _value)
inline

Helper function calculating size of uint8_t.

◆ operator!=() [1/17]

bool dds::protocol_api::operator!= ( const SIDCmd lhs,
const SIDCmd rhs 
)

◆ operator!=() [2/17]

bool dds::protocol_api::operator!= ( const SGetPropValuesCmd lhs,
const SGetPropValuesCmd rhs 
)

◆ operator!=() [3/17]

bool dds::protocol_api::operator!= ( const SUserTaskDoneCmd lhs,
const SUserTaskDoneCmd rhs 
)

◆ operator!=() [4/17]

bool dds::protocol_api::operator!= ( const SCustomCmdCmd lhs,
const SCustomCmdCmd rhs 
)

◆ operator!=() [5/17]

bool dds::protocol_api::operator!= ( const SAgentsInfoCmd _lhs,
const SAgentsInfoCmd _rhs 
)

◆ operator!=() [6/17]

bool dds::protocol_api::operator!= ( const SSubmitCmd lhs,
const SSubmitCmd rhs 
)

◆ operator!=() [7/17]

bool dds::protocol_api::operator!= ( const SUpdateKeyCmd lhs,
const SUpdateKeyCmd rhs 
)

◆ operator!=() [8/17]

bool dds::protocol_api::operator!= ( const SSimpleMsgCmd lhs,
const SSimpleMsgCmd rhs 
)

◆ operator!=() [9/17]

bool dds::protocol_api::operator!= ( const SVersionCmd lhs,
const SVersionCmd rhs 
)

◆ operator!=() [10/17]

bool dds::protocol_api::operator!= ( const SBinaryAttachmentReceivedCmd lhs,
const SBinaryAttachmentReceivedCmd rhs 
)

◆ operator!=() [11/17]

bool dds::protocol_api::operator!= ( const SHostInfoCmd lhs,
const SHostInfoCmd rhs 
)

◆ operator!=() [12/17]

bool dds::protocol_api::operator!= ( const SProgressCmd lhs,
const SProgressCmd rhs 
)

◆ operator!=() [13/17]

bool dds::protocol_api::operator!= ( const SAssignUserTaskCmd lhs,
const SAssignUserTaskCmd rhs 
)

◆ operator!=() [14/17]

bool dds::protocol_api::operator!= ( const SReplyCmd lhs,
const SReplyCmd rhs 
)

◆ operator!=() [15/17]

bool dds::protocol_api::operator!= ( const SBinaryAttachmentCmd lhs,
const SBinaryAttachmentCmd rhs 
)

◆ operator!=() [16/17]

bool dds::protocol_api::operator!= ( const SBinaryAttachmentStartCmd lhs,
const SBinaryAttachmentStartCmd rhs 
)

◆ operator!=() [17/17]

bool dds::protocol_api::operator!= ( const SUpdateTopologyCmd lhs,
const SUpdateTopologyCmd rhs 
)

◆ operator<<() [1/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SIDCmd _val 
)

◆ operator<<() [2/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SGetPropValuesCmd val 
)

◆ operator<<() [3/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SUserTaskDoneCmd val 
)

◆ operator<<() [4/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SAgentsInfoCmd _val 
)

◆ operator<<() [5/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SCustomCmdCmd val 
)

◆ operator<<() [6/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SUpdateKeyCmd val 
)

◆ operator<<() [7/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SSubmitCmd val 
)

◆ operator<<() [8/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SSimpleMsgCmd val 
)

◆ operator<<() [9/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SVersionCmd val 
)

◆ operator<<() [10/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SBinaryAttachmentReceivedCmd _val 
)

◆ operator<<() [11/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SHostInfoCmd val 
)

◆ operator<<() [12/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SProgressCmd val 
)

◆ operator<<() [13/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SAssignUserTaskCmd val 
)

◆ operator<<() [14/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SReplyCmd val 
)

◆ operator<<() [15/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SBinaryAttachmentStartCmd _val 
)

◆ operator<<() [16/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SBinaryAttachmentCmd _val 
)

◆ operator<<() [17/17]

std::ostream & dds::protocol_api::operator<< ( std::ostream &  _stream,
const SUpdateTopologyCmd val 
)

◆ operator==() [1/2]

template<class T >
bool dds::protocol_api::operator== ( const SChannelInfo< T > &  lhs,
const SChannelInfo< T > &  rhs 
)

◆ operator==() [2/2]

template<class T >
bool dds::protocol_api::operator== ( const SWeakChannelInfo< T > &  lhs,
const SWeakChannelInfo< T > &  rhs 
)

◆ pushData()

template<typename T >
void dds::protocol_api::pushData ( const T &  _value,
MiscCommon::BYTEVector_t _data 
)

◆ pushData< boost::uuids::uuid >()

template<>
void dds::protocol_api::pushData< boost::uuids::uuid > ( const boost::uuids::uuid &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< std::string >()

template<>
void dds::protocol_api::pushData< std::string > ( const std::string &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< std::vector< std::string > >()

template<>
void dds::protocol_api::pushData< std::vector< std::string > > ( const std::vector< std::string > &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< std::vector< uint16_t > >()

template<>
void dds::protocol_api::pushData< std::vector< uint16_t > > ( const std::vector< uint16_t > &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< std::vector< uint32_t > >()

template<>
void dds::protocol_api::pushData< std::vector< uint32_t > > ( const std::vector< uint32_t > &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< std::vector< uint64_t > >()

template<>
void dds::protocol_api::pushData< std::vector< uint64_t > > ( const std::vector< uint64_t > &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< std::vector< uint8_t > >()

template<>
void dds::protocol_api::pushData< std::vector< uint8_t > > ( const std::vector< uint8_t > &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< uint16_t >()

template<>
void dds::protocol_api::pushData< uint16_t > ( const uint16_t &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< uint32_t >()

template<>
void dds::protocol_api::pushData< uint32_t > ( const uint32_t &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< uint64_t >()

template<>
void dds::protocol_api::pushData< uint64_t > ( const uint64_t &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushData< uint8_t >()

template<>
void dds::protocol_api::pushData< uint8_t > ( const uint8_t &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ pushDataVector()

template<typename T >
void dds::protocol_api::pushDataVector ( const std::vector< T > &  _value,
MiscCommon::BYTEVector_t _data 
)
inline

◆ readData()

template<typename T >
void dds::protocol_api::readData ( T *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)

Helper template function reading data from byte array.

◆ readData< boost::uuids::uuid >()

template<>
void dds::protocol_api::readData< boost::uuids::uuid > ( boost::uuids::uuid *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< std::string >()

template<>
void dds::protocol_api::readData< std::string > ( std::string *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< std::vector< std::string > >()

template<>
void dds::protocol_api::readData< std::vector< std::string > > ( std::vector< std::string > *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< std::vector< uint16_t > >()

template<>
void dds::protocol_api::readData< std::vector< uint16_t > > ( std::vector< uint16_t > *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< std::vector< uint32_t > >()

template<>
void dds::protocol_api::readData< std::vector< uint32_t > > ( std::vector< uint32_t > *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< std::vector< uint64_t > >()

template<>
void dds::protocol_api::readData< std::vector< uint64_t > > ( std::vector< uint64_t > *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< std::vector< uint8_t > >()

template<>
void dds::protocol_api::readData< std::vector< uint8_t > > ( std::vector< uint8_t > *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< uint16_t >()

template<>
void dds::protocol_api::readData< uint16_t > ( uint16_t *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< uint32_t >()

template<>
void dds::protocol_api::readData< uint32_t > ( uint32_t *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< uint64_t >()

template<>
void dds::protocol_api::readData< uint64_t > ( uint64_t *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readData< uint8_t >()

template<>
void dds::protocol_api::readData< uint8_t > ( uint8_t *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ readDataVector()

template<typename T >
void dds::protocol_api::readDataVector ( std::vector< T > *  _value,
const MiscCommon::BYTEVector_t _data,
size_t *  _nPos 
)
inline

◆ REGISTER_CMD_ATTACHMENT() [1/13]

dds::protocol_api::REGISTER_CMD_ATTACHMENT ( SVersionCmd  ,
cmdHANDSHAKE   
)

◆ REGISTER_CMD_ATTACHMENT() [2/13]

cmdREPLY_HANDSHAKE_ERR dds::protocol_api::REGISTER_CMD_ATTACHMENT ( SSubmitCmd  ,
cmdSUBMIT   
)

◆ REGISTER_CMD_ATTACHMENT() [3/13]

cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG dds::protocol_api::REGISTER_CMD_ATTACHMENT ( SHostInfoCmd  ,
cmdREPLY_HOST_INFO   
)

◆ REGISTER_CMD_ATTACHMENT() [4/13]

cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID dds::protocol_api::REGISTER_CMD_ATTACHMENT ( SBinaryAttachmentCmd  ,
cmdBINARY_ATTACHMENT   
)

◆ REGISTER_CMD_ATTACHMENT() [5/13]

cmdREPLY_HANDSHAKE_ERR cmdSIMPLE_MSG cmdREPLY_PID cmdREPLY_ID dds::protocol_api::REGISTER_CMD_ATTACHMENT ( SIDCmd  ,
cmdSET_ID   
)

◆ REGISTER_CMD_ATTACHMENT() [6/13]

◆ REGISTER_CMD_ATTACHMENT() [7/13]

◆ REGISTER_CMD_ATTACHMENT() [8/13]

◆ REGISTER_CMD_ATTACHMENT() [9/13]

◆ REGISTER_CMD_ATTACHMENT() [10/13]

◆ REGISTER_CMD_ATTACHMENT() [11/13]

◆ REGISTER_CMD_ATTACHMENT() [12/13]

◆ REGISTER_CMD_ATTACHMENT() [13/13]

Variable Documentation

◆ gChannelTypeName

const std::array<std::string, 3> dds::protocol_api::gChannelTypeName { { "unknown", "agent", "ui" } }