RTI::Foo::Read_Callback Class Reference

#include <Foo_TypedTS_Impl.hpp>

Inheritance diagram for RTI::Foo::Read_Callback:

Public Member Functions
	Read_Callback ()
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Default constructor for Read_Callback class.
	Read_Callback (const Read_Callback &read_callback)
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Make a copy of another Read_Callback object
Read_Callback &	operator= (const Read_Callback &read_callback)
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Assigne another Read_Callback object to this Read_Callback
	~Read_Callback ()
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Default destructor for Read_Callback class
void	Callback_Handler (FACE::TSS::CONNECTION_ID_TYPE connection_id, FACE::TSS::TRANSACTION_ID_TYPE transaction_id, const FACE::DM::RTI::Foo &message, const FACE::TSS::HEADER_TYPE &header, const FACE::TSS::QoS_EVENT_TYPE &qos_parameters, FACE::RETURN_CODE_TYPE::Value &return_code)
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This function is a user defined handler for receiving data via callback instead of polling.

---

Detailed Description

The Read_Callback interface provides a callback prototype for DDS and is used to support receiving data without the DDS having to poll for the data. If a callback is used it is registered using the Register_Callback.

---

Constructor & Destructor Documentation

RTI::Foo::Read_Callback::Read_Callback

(

)

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Default constructor for Read_Callback class.

Reimplemented from FACE::TSS::RTI::Foo::Read_Callback.

RTI::Foo::Read_Callback::Read_Callback

(

const Read_Callback &

read_callback

)

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Make a copy of another Read_Callback object

Parameters:

[in]

read_callback

A reference of Read_Callback object to copy

RTI::Foo::Read_Callback::~Read_Callback ( )

virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Default destructor for Read_Callback class

Reimplemented from FACE::TSS::RTI::Foo::Read_Callback.

---

Member Function Documentation

Read_Callback& RTI::Foo::Read_Callback::operator=

(

const Read_Callback &

read_callback

)

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Assigne another Read_Callback object to this Read_Callback

Parameters:

[in]

read_callback

A reference of Read_Callback object to assign

• A reference to newly assign Read_Callback

void RTI::Foo::Read_Callback::Callback_Handler ( FACE::TSS::CONNECTION_ID_TYPE  connection_id, FACE::TSS::TRANSACTION_ID_TYPE  transaction_id, const FACE::DM::RTI::Foo &  message, const FACE::TSS::HEADER_TYPE &  header, const FACE::TSS::QoS_EVENT_TYPE &  qos_parameters, FACE::RETURN_CODE_TYPE::Value &  return_code  )

virtual

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This function is a user defined handler for receiving data via callback instead of polling.

Parameters:

[in]	connection_id	The ID of the connection on which the message was received.
[in]	transaction_id	The transaction_id parameter is used in the request/reply communication pattern, which is not currently available in Connext TSS.
[in]	message	The strongly typed message that was received. An implementer will substitute their type for DATATYPE_TYPE.
[out]	header	The header parameter is not currently set or supported by Connext TSS.
[out]	qos_parameters	The qos_parameters parameter is not currently set or supported by Connext TSS.
[out]	return_code	The return code for the call to FACE::TS::Receive_Message. Upon return of the call, this parameter will be populated with a value that will indicate either success or a reason for failure.

Note:

The type of the message must correspond to the type specified in the connection configuration for the given connection_id.

Implements FACE::TSS::RTI::Foo::Read_Callback.