API Documentation

RnrSessionsMessage

The Record and Replay Message Class.

RnrSessionsMessage::RnrSessionsMessage ( )

A default constructor.

RnrSessionsMessage::RnrSessionsMessage ( … )

A copy constructor.

Parameters
in/out type description
in const RnrSessionsMessage & Instance being copied.

RnrSessionsMessage::RnrSessionsMessage ( … )

This will construct with a node to enable publishing.

Parameters
in/out type description
in Node & Reference to node.

RnrSessionsMessage::RnrSessionsMessage ( … )

This will construct with a node to enable publishing and message copying.

Parameters
in/out type description
in Node & Reference to node.
in ps_msg_ref Message to copy.

RnrSessionsMessage::RnrSessionsMessage ( … )

A convenience constructor from a related type.

Parameters
in/out type description
in const ps_rnr_sessions_msg & Instance of related type.

RnrSessionsMessage::~RnrSessionsMessage ( )

A default destructor.

RnrSessionsMessage::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream that defaults to std::cout.
Returns
  • void

RnrSessionsMessage::get_ps_rnr_sessions_msg ( ) const

This will provide convenient access to a related type.

Returns

RnrSessionsMessage::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const RnrSessionsMessage & Instance to copy.
Returns

static RnrSessionsMessage::getName ( )

This will get a message name.

It is useful in functions requiring message names, such as getMessageTypeByName.

Returns
  • std::string

RnrSessionsMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

RnrSessionsMessage::setHeader ( … )

Parameters
in/out type description
in MsgHeader & Message header.
Returns
  • void

RnrSessionsMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

RnrSessionsMessage::setHeaderType ( … )

This will set a message type identifier.

Parameters
in/out type description
in ps_msg_type Message type identifier.
Returns
  • void

RnrSessionsMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

RnrSessionsMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

Parameters
in/out type description
in ps_timestamp In microseconds.
Returns
  • void

RnrSessionsMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

RnrSessionsMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

Parameters
in/out type description
in ps_guid Message producer’s GUID.
Returns
  • void

RnrSessionsMessage::getHostAddress ( ) const

This will get the host address.

Returns

RnrSessionsMessage::setHostAddress ( … )

This will set the host address.

Parameters
in/out type description
in ps_interface_address The set interface address.
Returns
  • void

RnrSessionsMessage::getSessions ( ) const

This will get the available record and replay sessions.

Returns

RnrSessionsMessage::setSessions ( … )

This will set the available record and replay sessions.

Parameters
in/out type description
in const std::vector< datamodel::RnrSession > & The copied available session information.
Returns
  • void