RTI Connext Traditional C++ API  Version 5.3.0
 All Classes Functions Variables Typedefs Enumerations Enumerator Groups Pages
DDSTopicQueryHelper Class Reference

Helpers to provide utility operations related to DDSTopicQuery. More...

Static Public Member Functions

static DDS_Boolean topic_query_data_from_service_request (DDS_TopicQueryData &topic_query_data, const DDS_ServiceRequest &service_request)
 Retrieves the DDS_TopicQueryData data contained in the specified DDS_ServiceRequest.
 

Detailed Description

Helpers to provide utility operations related to DDSTopicQuery.

Member Function Documentation

static DDS_Boolean DDSTopicQueryHelper::topic_query_data_from_service_request ( DDS_TopicQueryData topic_query_data,
const DDS_ServiceRequest service_request 
)
static

Retrieves the DDS_TopicQueryData data contained in the specified DDS_ServiceRequest.

This operation will extract the content from the request body of the DDS_ServiceRequest and place it into the specified DDS_TopicQueryData object.

The specified DDS_ServiceRequest must be a valid sample associated with the service id DDS_TOPIC_QUERY_SERVICE_REQUEST_ID. Otherwise this operation will return DDS_BOOLEAN_FALSE.

This operation can be called within the context of a DDSDataWriterListener::on_service_request_accepted to retrieve the DDS_TopicQueryData of a DDS_ServiceRequest that has been received with service id DDS_TOPIC_QUERY_SERVICE_REQUEST_ID

Parameters
topic_query_data<<inout>> A DDS_TopicQueryData object where the content from the service request is extracted.
service_request<<in>> Input DDS_ServiceRequest that contains the DDS_TopicQueryData as part of its request body.
Returns
DDS_BOOLEAN_TRUE on success.

RTI Connext Traditional C++ API Version 5.3.0 Copyright © Sun Jun 25 2017 Real-Time Innovations, Inc