WsfXIO_HeartbeatPkt Class Reference
Sent at regular intervals over the UDP connections. More...
#include <WsfXIO_PacketRegistry.hpp>
Inheritance diagram for WsfXIO_HeartbeatPkt:
Collaboration diagram for WsfXIO_HeartbeatPkt:
Public Member Functions | |
| XIO_DEFINE_PACKET (WsfXIO_HeartbeatPkt, WsfXIO_Packet, 1) | |
| Public Member Functions inherited from WsfXIO_Packet | |
| WsfXIO_Packet (int aPacketId) | |
| template<typename T> | |
| void | Serialize (T &aBuff) |
| Serializes the packet header. Must be called first from derived class Serialize(). | |
| float | GetTimeStamp () const |
| void | SetTimeStamp (float aTimeStamp) |
| void | SetFlags (uint32_t aFlags) |
| void | AddFlags (uint32_t aFlags) |
| uint32_t | GetFlags () const |
Public Attributes | |
| WsfStringId | mApplicationName |
| Application's user-defined name. | |
| wsf::xio::ApplicationType | mApplicationType |
| Member of WsfXIO::ApplicationType. | |
| uint16_t | mTCP_Port |
| Port for connecting via TCP, 0 if N/A. | |
| Public Attributes inherited from WsfXIO_Packet | |
| GenUniqueId | mApplicationId |
Additional Inherited Members | |
| Public Types inherited from WsfXIO_Packet | |
| enum | PacketFlags { cSYNCHRONIZED = 1 } |
| typedef bool | BaseType |
| Static Public Attributes inherited from WsfXIO_Packet | |
| static const int | cPACKET_ID = -1 |
| Protected Attributes inherited from WsfXIO_Packet | |
| uint32_t | mFlags |
| float | mTimeStamp |
Detailed Description
Sent at regular intervals over the UDP connections.
Member Function Documentation
◆ XIO_DEFINE_PACKET()
|
inline |
References mApplicationName, mApplicationType, mTCP_Port, and WsfXIO_Packet::WsfXIO_Packet().
Member Data Documentation
◆ mApplicationName
| WsfStringId WsfXIO_HeartbeatPkt::mApplicationName |
Application's user-defined name.
Referenced by XIO_DEFINE_PACKET().
◆ mApplicationType
| wsf::xio::ApplicationType WsfXIO_HeartbeatPkt::mApplicationType |
Member of WsfXIO::ApplicationType.
Referenced by XIO_DEFINE_PACKET().
◆ mTCP_Port
| uint16_t WsfXIO_HeartbeatPkt::mTCP_Port |
Port for connecting via TCP, 0 if N/A.
Referenced by XIO_DEFINE_PACKET().
The documentation for this class was generated from the following file: