RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rsb::protocol Namespace Reference

Classes

class  ProtocolException
 

Typedefs

typedef boost::shared_ptr
< rsb::protocol::FragmentedNotification > 
FragmentedNotificationPtr
 
typedef boost::shared_ptr
< rsb::protocol::Notification > 
NotificationPtr
 

Functions

void fillEventId (protocol::EventId &id, const rsb::EventId &realId)
 Utility function to fill a protocol::EventId. More...
 
void fillNotificationId (protocol::Notification &notification, const EventPtr &event)
 Fills the notification with minimal information required to identify it along several notifications sent on a wire. More...
 
void fillNotificationHeader (protocol::Notification &notification, const EventPtr &event, const std::string &wireSchema)
 Fills a protocol::Notification with header contents. More...
 
void fillEvent (EventPtr event, const protocol::Notification &notification, VoidPtr data, const string &dataType)
 
RSB_EXPORT void fillEvent (EventPtr event, const rsb::protocol::Notification &notification, boost::shared_ptr< void > data, const std::string &dataType)
 Parses the data from a protocol::Notification and fills an event with these data. More...
 

Typedef Documentation

typedef boost::shared_ptr<rsb::protocol::FragmentedNotification> rsb::protocol::FragmentedNotificationPtr

Definition at line 38 of file FragmentedNotification.h.

typedef boost::shared_ptr<rsb::protocol::Notification> rsb::protocol::NotificationPtr

Definition at line 43 of file Notification.h.

Function Documentation

RSB_EXPORT void rsb::protocol::fillEvent ( EventPtr  event,
const rsb::protocol::Notification &  notification,
boost::shared_ptr< void >  data,
const std::string &  dataType 
)

Parses the data from a protocol::Notification and fills an event with these data.

Parameters
eventevent to fill
notificationnotification to read data from
datathe decoded event data, probably generated by a Converter
dataTypethe string identifier of the data type
void rsb::protocol::fillEvent ( EventPtr  event,
const protocol::Notification &  notification,
VoidPtr  data,
const string &  dataType 
)

Definition at line 91 of file Notification.cpp.

Referenced by rsb::converter::EventsByScopeMapConverter::deserialize().

Here is the caller graph for this function:

RSB_EXPORT void rsb::protocol::fillEventId ( protocol::EventId &  id,
const rsb::EventId realId 
)

Utility function to fill a protocol::EventId.

Parameters
idthe id to fill
realIdthe source id

Definition at line 39 of file Notification.cpp.

References rsb::EventId::getParticipantId(), and rsb::EventId::getSequenceNumber().

Referenced by fillNotificationHeader(), and fillNotificationId().

Here is the call graph for this function:

Here is the caller graph for this function:

RSB_EXPORT void rsb::protocol::fillNotificationHeader ( protocol::Notification &  notification,
const EventPtr &  event,
const std::string &  wireSchema 
)

Fills a protocol::Notification with header contents.

This includes meta data and causal vector but excludes the id information. These can be set with fillNotificationId.

Parameters
notificationnotification to fill
eventthe event that generated the notification
wireSchemawire schema of the serialized data

Definition at line 50 of file Notification.cpp.

References fillEventId().

Referenced by rsb::converter::EventsByScopeMapConverter::serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

RSB_EXPORT void rsb::protocol::fillNotificationId ( protocol::Notification &  notification,
const EventPtr &  event 
)

Fills the notification with minimal information required to identify it along several notifications sent on a wire.

Namely, this is the EventId contained in the notification.

Parameters
notificationthe notification to fill
eventthe event to take then information from

Definition at line 45 of file Notification.cpp.

References fillEventId().

Referenced by rsb::converter::EventsByScopeMapConverter::serialize().

Here is the call graph for this function:

Here is the caller graph for this function: