Read Conditions

DDS_ReadCondition and associated elements More...

Data Structures
struct	DDS_ReadConditionParams
	<<extension>> Input parameters for DDS_DataReader_create_readcondition_w_params More...

Typedefs
typedef struct DDS_ReadConditionImpl	DDS_ReadCondition
	<<interface>> Conditions specifically dedicated to read operations and attached to one DDS_DataReader. More...

Functions
DDS_Condition *	DDS_ReadCondition_as_condition (DDS_ReadCondition *read_condition)
	Accesses a DDS_ReadCondition's supertype instance. More...
DDS_SampleStateMask	DDS_ReadCondition_get_sample_state_mask (DDS_ReadCondition *self)
	Retrieves the set of sample_states for the condition. More...
DDS_ViewStateMask	DDS_ReadCondition_get_view_state_mask (DDS_ReadCondition *self)
	Retrieves the set of view_states for the condition. More...
DDS_InstanceStateMask	DDS_ReadCondition_get_instance_state_mask (DDS_ReadCondition *self)
	Retrieves the set of instance_states for the condition. More...
DDS_StreamKindMask	DDS_ReadCondition_get_stream_kind_mask (DDS_ReadCondition *self)
	Retrieves the set of stream kind mask for the condition. More...
DDS_DataReader *	DDS_ReadCondition_get_datareader (DDS_ReadCondition *self)
	Returns the DDS_DataReader associated with the DDS_ReadCondition. More...

Detailed Description

DDS_ReadCondition and associated elements

Typedef Documentation

DDS_ReadCondition

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.

Function Documentation

DDS_ReadCondition_as_condition()

DDS_Condition * DDS_ReadCondition_as_condition

(

DDS_ReadCondition *

read_condition

)

Accesses a DDS_ReadCondition's supertype instance.

Parameters

read_condition

<<in>> Cannot be NULL.

DDS_ReadCondition_get_sample_state_mask()

DDS_SampleStateMask DDS_ReadCondition_get_sample_state_mask

(

DDS_ReadCondition *

self

)

Retrieves the set of sample_states for the condition.

Parameters

self	<<in>> Cannot be NULL.

DDS_ReadCondition_get_view_state_mask()

DDS_ViewStateMask DDS_ReadCondition_get_view_state_mask

(

DDS_ReadCondition *

self

)

Retrieves the set of view_states for the condition.

Parameters

self	<<in>> Cannot be NULL.

DDS_ReadCondition_get_instance_state_mask()

DDS_InstanceStateMask DDS_ReadCondition_get_instance_state_mask

(

DDS_ReadCondition *

self

)

Retrieves the set of instance_states for the condition.

Parameters

self	<<in>> Cannot be NULL.

DDS_ReadCondition_get_stream_kind_mask()

DDS_StreamKindMask DDS_ReadCondition_get_stream_kind_mask

(

DDS_ReadCondition *

self

)

Retrieves the set of stream kind mask for the condition.

Parameters

self	<<in>> Cannot be NULL.

DDS_ReadCondition_get_datareader()

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.

Parameters

self	<<in>> Cannot be NULL.

Returns

DDS_DataReader associated with the DDS_ReadCondition.