|
RTI Connext C API
Version 5.1.0
|
DDS_ReadCondition and associated elements More...
Typedefs | |
| typedef struct DDS_ReadConditionImpl | DDS_ReadCondition |
| <<interface>> Conditions specifically dedicated to read operations and attached to one DDS_DataReader. | |
Functions | |
| DDS_Condition * | DDS_ReadCondition_as_condition (DDS_ReadCondition *read_condition) |
| Accesses a DDS_ReadCondition's supertype instance. | |
| DDS_SampleStateMask | DDS_ReadCondition_get_sample_state_mask (DDS_ReadCondition *self) |
Retrieves the set of sample_states for the condition. | |
| DDS_ViewStateMask | DDS_ReadCondition_get_view_state_mask (DDS_ReadCondition *self) |
Retrieves the set of view_states for the condition. | |
| DDS_InstanceStateMask | DDS_ReadCondition_get_instance_state_mask (DDS_ReadCondition *self) |
Retrieves the set of instance_states for the condition. | |
| DDS_DataReader * | DDS_ReadCondition_get_datareader (DDS_ReadCondition *self) |
| Returns the DDS_DataReader associated with the DDS_ReadCondition. | |
DDS_ReadCondition and associated elements
| typedef struct DDS_ReadConditionImpl DDS_ReadCondition |
<<interface>> Conditions specifically dedicated to read operations and attached to one DDS_DataReader.
DDS_ReadCondition objects allow an application to specify the data samples it is interested in (by specifying the desired sample_states, view_states as well as instance_states in FooDataReader_read and FooDataReader_take variants.
This allows RTI Connext to enable the condition only when suitable information is available. They are to be used in conjunction with a WaitSet as normal conditions.
More than one DDS_ReadCondition may be attached to the same DDS_DataReader.
Note: If you are using a ReadCondition simply to detect the presence of new data, consider using a DDS_StatusCondition with the DATA_AVAILABLE_STATUS instead, which will perform better in this situation.
| DDS_Condition* DDS_ReadCondition_as_condition | ( | DDS_ReadCondition * | read_condition | ) |
Accesses a DDS_ReadCondition's supertype instance.
| read_condition | <<in>> Cannot be NULL. |
| DDS_SampleStateMask DDS_ReadCondition_get_sample_state_mask | ( | DDS_ReadCondition * | self | ) |
Retrieves the set of sample_states for the condition.
| self | <<in>> Cannot be NULL. |
| DDS_ViewStateMask DDS_ReadCondition_get_view_state_mask | ( | DDS_ReadCondition * | self | ) |
Retrieves the set of view_states for the condition.
| self | <<in>> Cannot be NULL. |
| DDS_InstanceStateMask DDS_ReadCondition_get_instance_state_mask | ( | DDS_ReadCondition * | self | ) |
Retrieves the set of instance_states for the condition.
| self | <<in>> Cannot be NULL. |
| DDS_DataReader* DDS_ReadCondition_get_datareader | ( | DDS_ReadCondition * | self | ) |
Returns the DDS_DataReader associated with the DDS_ReadCondition.
There is exactly one DDS_DataReader assicated with each DDS_ReadCondition.
| self | <<in>> Cannot be NULL. |
RTI Connext C API Version 5.1.0
Copyright © Mon Feb 3 2014
Real-Time Innovations, Inc