DDSOctetsDataReader Class Reference
[Octets Built-in Type]

<<interface>> Instantiates DataReader < DDS_Octets >. More...

Inheritance diagram for DDSOctetsDataReader:

List of all members.

Public Member Functions
virtual DDS_ReturnCode_t	read (DDS_OctetsSeq &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_OctetsSeq &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_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
	Accesses via DDSOctetsDataReader::read the samples that match the criteria specified in the DDSReadCondition.
virtual DDS_ReturnCode_t	take_w_condition (DDS_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
	Analogous to DDSOctetsDataReader::read_w_condition except it accesses samples via the DDSOctetsDataReader::take operation.
virtual DDS_ReturnCode_t	read_next_sample (DDS_Octets &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_Octets &received_data, DDS_SampleInfo &sample_info)
	Copies the next not-previously-accessed data value from the DDSDataReader.
virtual DDS_ReturnCode_t	return_loan (DDS_OctetsSeq &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.
Static Public Member Functions
static DDSOctetsDataReader *	narrow (DDSDataReader *reader)
	Narrow the given DDSDataReader pointer to a DDSOctetsDataReader pointer.

---

Detailed Description

<<interface>> Instantiates DataReader < DDS_Octets >.

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

A non- NULL 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 DDSOctetsDataReader::read	(	DDS_OctetsSeq &	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 DDSOctetsDataReader::take	(	DDS_OctetsSeq &	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 DDSOctetsDataReader::read_w_condition	(	DDS_OctetsSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples,
		DDSReadCondition *	condition
	)			[virtual]

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

See also:

FooDataReader::read_w_condition

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

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

See also:

FooDataReader::take_w_condition

virtual DDS_ReturnCode_t DDSOctetsDataReader::read_next_sample	(	DDS_Octets &	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 DDSOctetsDataReader::take_next_sample	(	DDS_Octets &	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 DDSOctetsDataReader::return_loan	(	DDS_OctetsSeq &	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

static DDSOctetsDataReader* DDSOctetsDataReader::narrow

(

DDSDataReader *

reader

)

[static]

Narrow the given DDSDataReader pointer to a DDSOctetsDataReader pointer.

See also:

FooDataReader::narrow