DDSKeyedOctetsDataReader Class Reference
[KeyedOctets Built-in Type]

<<interface>> Instantiates DataReader < DDS_KeyedOctets >. More...

Inheritance diagram for DDSKeyedOctetsDataReader:

DDSDataReader DDSDomainEntity DDSEntity

List of all members.

Public Member Functions

virtual DDS_ReturnCode_t read (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
 Access a collection of data samples from the DDSDataReader.
virtual DDS_ReturnCode_t take (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
 Access a collection of data-samples from the DDSDataReader.
virtual DDS_ReturnCode_t read_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
 Accesses via DDSKeyedOctetsDataReader::read the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t take_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
 Analogous to DDSKeyedOctetsDataReader::read_w_condition except it accesses samples via the DDSKeyedOctetsDataReader::take operation.
virtual DDS_ReturnCode_t read_next_sample (DDS_KeyedOctets &received_data, DDS_SampleInfo &sample_info)
 Copies the next not-previously-accessed data value from the DDSDataReader.
virtual DDS_ReturnCode_t take_next_sample (DDS_KeyedOctets &received_data, DDS_SampleInfo &sample_info)
 Copies the next not-previously-accessed data value from the DDSDataReader.
virtual DDS_ReturnCode_t read_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
 Access a collection of data samples from the DDSDataReader.
virtual DDS_ReturnCode_t take_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
 Access a collection of data samples from the DDSDataReader.
virtual DDS_ReturnCode_t read_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL)
 Accesses via DDSKeyedOctetsDataReader::read_instance the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t take_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL)
 Accesses via the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t read_next_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
 Access a collection of data samples from the DDSDataReader.
virtual DDS_ReturnCode_t take_next_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
 Access a collection of data samples from the DDSDataReader.
virtual DDS_ReturnCode_t read_next_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL)
 Accesses via DDSKeyedOctetsDataReader::read_next_instance the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t take_next_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL)
 Accesses via DDSKeyedOctetsDataReader::take_next_instance the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t return_loan (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq)
 Indicates to the DDSDataReader that the application is done accessing the collection of received_data and info_seq obtained by some earlier invocation of read or take on the DDSDataReader.
virtual DDS_ReturnCode_t get_key_value (DDS_KeyedOctets &key_holder, const DDS_InstanceHandle_t &handle)
 Retrieve the instance key that corresponds to an instance handle.
virtual DDS_ReturnCode_t get_key_value (char *key, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Retrieve the instance key that corresponds to an instance handle.
virtual DDS_InstanceHandle_t lookup_instance (const DDS_KeyedOctets &key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder.
virtual DDS_InstanceHandle_t lookup_instance (const char *key)
 <<eXtension>> Retrieve the instance handle that corresponds to an instance key.

Static Public Member Functions

static DDSKeyedOctetsDataReader * narrow (DDSDataReader *reader)
 Narrow the given DDSDataReader pointer to a DDSKeyedOctetsDataReader pointer.

Detailed Description

<<interface>> Instantiates DataReader < DDS_KeyedOctets >.

When reading or taking data with this reader, if you request a copy of the samples instead of a loan, and a string or byte array in a destination data sample is NULL, the middleware will allocate a new string or array for you of sufficient length to hold the received data. New strings will be allocated with DDS_String_alloc; new arrays will be allocated with DDS_OctetBuffer_alloc. The sample's destructor will delete them.

A non- NULL string or array is assumed to be allocated to sufficient length to store the incoming data. It will not be reallocated.

See also:
FooDataReader

DDSDataReader

Member Function Documentation

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
DDS_SampleStateMask  sample_states = DDS_ANY_SAMPLE_STATE,
DDS_ViewStateMask  view_states = DDS_ANY_VIEW_STATE,
DDS_InstanceStateMask  instance_states = DDS_ANY_INSTANCE_STATE 
) [virtual]

Access a collection of data samples from the DDSDataReader.

See also:
FooDataReader::read

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
DDS_SampleStateMask  sample_states = DDS_ANY_SAMPLE_STATE,
DDS_ViewStateMask  view_states = DDS_ANY_VIEW_STATE,
DDS_InstanceStateMask  instance_states = DDS_ANY_INSTANCE_STATE 
) [virtual]

Access a collection of data-samples from the DDSDataReader.

See also:
FooDataReader::take

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read_w_condition ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples,
DDSReadCondition *  condition 
) [virtual]

Accesses via DDSKeyedOctetsDataReader::read the samples that match the criteria specified in the DDSReadCondition.

See also:
FooDataReader::read_w_condition

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take_w_condition ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples,
DDSReadCondition *  condition 
) [virtual]

Analogous to DDSKeyedOctetsDataReader::read_w_condition except it accesses samples via the DDSKeyedOctetsDataReader::take operation.

See also:
FooDataReader::take_w_condition

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read_next_sample ( DDS_KeyedOctets &  received_data,
DDS_SampleInfo &  sample_info 
) [virtual]

Copies the next not-previously-accessed data value from the DDSDataReader.

See also:
FooDataReader::read_next_sample

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take_next_sample ( DDS_KeyedOctets &  received_data,
DDS_SampleInfo &  sample_info 
) [virtual]

Copies the next not-previously-accessed data value from the DDSDataReader.

See also:
FooDataReader::take_next_sample

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read_instance ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  a_handle = DDS_HANDLE_NIL,
DDS_SampleStateMask  sample_states = DDS_ANY_SAMPLE_STATE,
DDS_ViewStateMask  view_states = DDS_ANY_VIEW_STATE,
DDS_InstanceStateMask  instance_states = DDS_ANY_INSTANCE_STATE 
) [virtual]

Access a collection of data samples from the DDSDataReader.

See also:
FooDataReader::read_instance

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take_instance ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  a_handle = DDS_HANDLE_NIL,
DDS_SampleStateMask  sample_states = DDS_ANY_SAMPLE_STATE,
DDS_ViewStateMask  view_states = DDS_ANY_VIEW_STATE,
DDS_InstanceStateMask  instance_states = DDS_ANY_INSTANCE_STATE 
) [virtual]

Access a collection of data samples from the DDSDataReader.

See also:
FooDataReader::take_instance

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read_instance_w_condition ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  a_handle = DDS_HANDLE_NIL,
DDSReadCondition *  condition = NULL 
) [virtual]

Accesses via DDSKeyedOctetsDataReader::read_instance the samples that match the criteria specified in the DDSReadCondition.

See also:
FooDataReader::read_instance_w_condition

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take_instance_w_condition ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  a_handle = DDS_HANDLE_NIL,
DDSReadCondition *  condition = NULL 
) [virtual]

Accesses via the samples that match the criteria specified in the DDSReadCondition.

See also:
FooDataReader::take_instance_w_condition

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read_next_instance ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  previous_handle = DDS_HANDLE_NIL,
DDS_SampleStateMask  sample_states = DDS_ANY_SAMPLE_STATE,
DDS_ViewStateMask  view_states = DDS_ANY_VIEW_STATE,
DDS_InstanceStateMask  instance_states = DDS_ANY_INSTANCE_STATE 
) [virtual]

Access a collection of data samples from the DDSDataReader.

See also:
FooDataReader::read_next_instance

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take_next_instance ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  previous_handle = DDS_HANDLE_NIL,
DDS_SampleStateMask  sample_states = DDS_ANY_SAMPLE_STATE,
DDS_ViewStateMask  view_states = DDS_ANY_VIEW_STATE,
DDS_InstanceStateMask  instance_states = DDS_ANY_INSTANCE_STATE 
) [virtual]

Access a collection of data samples from the DDSDataReader.

See also:
FooDataReader::take_next_instance

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::read_next_instance_w_condition ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  previous_handle = DDS_HANDLE_NIL,
DDSReadCondition *  condition = NULL 
) [virtual]

Accesses via DDSKeyedOctetsDataReader::read_next_instance the samples that match the criteria specified in the DDSReadCondition.

See also:
FooDataReader::read_next_instance_w_condition

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::take_next_instance_w_condition ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq,
DDS_Long  max_samples = DDS_LENGTH_UNLIMITED,
const DDS_InstanceHandle_t &  previous_handle = DDS_HANDLE_NIL,
DDSReadCondition *  condition = NULL 
) [virtual]

Accesses via DDSKeyedOctetsDataReader::take_next_instance the samples that match the criteria specified in the DDSReadCondition.

See also:
FooDataReader::take_next_instance_w_condition

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::return_loan ( DDS_KeyedOctetsSeq &  received_data,
DDS_SampleInfoSeq &  info_seq 
) [virtual]

Indicates to the DDSDataReader that the application is done accessing the collection of received_data and info_seq obtained by some earlier invocation of read or take on the DDSDataReader.

See also:
FooDataReader::return_loan

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::get_key_value ( DDS_KeyedOctets &  key_holder,
const DDS_InstanceHandle_t &  handle 
) [virtual]

Retrieve the instance key that corresponds to an instance handle.

See also:
FooDataReader::get_key_value

virtual DDS_ReturnCode_t DDSKeyedOctetsDataReader::get_key_value ( char *  key,
const DDS_InstanceHandle_t &  handle 
) [virtual]

<<eXtension>> Retrieve the instance key that corresponds to an instance handle.

See also:
FooDataReader::get_key_value

virtual DDS_InstanceHandle_t DDSKeyedOctetsDataReader::lookup_instance ( const DDS_KeyedOctets &  key_holder  )  [virtual]

Retrieve the instance handle that corresponds to an instance key_holder.

See also:
FooDataReader::lookup_instance

virtual DDS_InstanceHandle_t DDSKeyedOctetsDataReader::lookup_instance ( const char *  key  )  [virtual]

<<eXtension>> Retrieve the instance handle that corresponds to an instance key.

See also:
FooDataReader::lookup_instance

static DDSKeyedOctetsDataReader* DDSKeyedOctetsDataReader::narrow ( DDSDataReader *  reader  )  [static]

Narrow the given DDSDataReader pointer to a DDSKeyedOctetsDataReader pointer.

See also:
FooDataReader::narrow

RTI Data Distribution Service C++ API Version 4.5e Copyright © 23 Oct 2011 Real-Time Innovations, Inc