fesa-core  4.2.0
fesa::AutomaticNotificationMessage Class Reference

A message type to automatically notify the server side via Notification ID. More...

#include <MessageTypes.h>

Inheritance diagram for fesa::AutomaticNotificationMessage:
fesa::AbstractMessage

Public Member Functions

 AutomaticNotificationMessage (uint32_t notificationID, boost::shared_ptr< MultiplexingContext > &muxContext, const std::string &className, uint32_t &prio)
 Constructor. Create a message from notification ID, multiplexing context, and priority. More...
 
 AutomaticNotificationMessage (std::istream &stream)
 Constructor. Create a message from serialized data. More...
 
void serialize (std::ostream &stream) const
 Serialize the contents of the multiplexing context and the notification ID into a stream. More...
 
std::string getClassName () const
 Get the name of the FESA class that sends/receives the message.
 
- 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...
 

Public Attributes

uint32_t notificationID_
 The notification ID.
 
boost::shared_ptr
< MultiplexingContext
muxContext_
 The multiplexing context for which the device properties are notified. Implemented as a shared pointer since the lifetime is unknown because the object is possibly stored in a notification thread.
 
- 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 to automatically notify the server side via Notification ID.

Constructor & Destructor Documentation

fesa::AutomaticNotificationMessage::AutomaticNotificationMessage ( uint32_t  notificationID,
boost::shared_ptr< MultiplexingContext > &  muxContext,
const std::string &  className,
uint32_t &  prio 
)

Constructor. Create a message from notification ID, multiplexing context, and priority.

Parameters
notificationIDThe identifier of the notification
muxContextThe multiplexing context className The name of the FESA class that sends the message
prioThe priority of the message
fesa::AutomaticNotificationMessage::AutomaticNotificationMessage ( std::istream &  stream)
explicit

Constructor. Create a message from serialized data.

Parameters
streamThe stream that contains the serialized data

Member Function Documentation

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

Serialize the contents of the multiplexing context and the notification ID into a stream.

Parameters
streamThe serialized message

Reimplemented from fesa::AbstractMessage.


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