fesa-core  7.0.0
fesa::OnDemandMessage Class Reference

A message type for on-demand events. More...

#include <MessageTypes.h>

Inheritance diagram for fesa::OnDemandMessage:
fesa::AbstractMessage

Public Member Functions

 OnDemandMessage (const std::string &cycleName, timestamp_ns cycleStamp, const char *payload, std::size_t payloadSize, uint32_t prio, uint32_t synchronizationId, const std::string &timingDomainName)
 Constructor. More...
 
 OnDemandMessage (std::istream &stream)
 Constructor. Create a message from serialized data. More...
 
 OnDemandMessage (const OnDemandMessage &msg)
 Copy constructor. Needed to properly copy the heap allocated payload. More...
 
 ~OnDemandMessage ()
 Destructor.
 
void serialize (std::ostream &stream) const
 Serialize the information in the message into a stream. More...
 
- Public Member Functions inherited from fesa::AbstractMessage
 AbstractMessage (uint32_t prio, MessageType msgType)
 Constructor.
 
 AbstractMessage (std::istream &stream, MessageType msgType)
 Constructor. Create a message from serialized data. More...
 
virtual ~AbstractMessage ()
 Destructor.
 
bool operator< (const AbstractMessage &msg) const
 Compare priorities (needed because this class is an element of a priority queue) More...
 

Additional Inherited Members

- Public Attributes inherited from fesa::AbstractMessage
uint32_t prio_
 The priority of the message.
 
MessageType msgType_
 The type of the message.
 

Detailed Description

A message type for on-demand events.

Constructor & Destructor Documentation

fesa::OnDemandMessage::OnDemandMessage ( const std::string &  cycleName,
timestamp_ns  cycleStamp,
const char *  payload,
std::size_t  payloadSize,
uint32_t  prio,
uint32_t  synchronizationId,
const std::string &  timingDomainName 
)

Constructor.

Parameters
cycleName
cycleStamp
payload
payloadSize
prioThe priority of the message
synchronizationIdthe id of the synchronization to wait for
timingDomainNameThe name of the timing domain of the original event
fesa::OnDemandMessage::OnDemandMessage ( std::istream &  stream)
explicit

Constructor. Create a message from serialized data.

Parameters
streamThe stream that contains the serialized data
fesa::OnDemandMessage::OnDemandMessage ( const OnDemandMessage msg)

Copy constructor. Needed to properly copy the heap allocated payload.

Parameters
msgThe message to be copied

Member Function Documentation

void fesa::OnDemandMessage::serialize ( std::ostream &  stream) const
virtual

Serialize the information in the message into a stream.

Parameters
streamThe serialized message

Reimplemented from fesa::AbstractMessage.


The documentation for this class was generated from the following files: