KeyedBytesDataReader Class Reference

<<interface>> Instantiates DataReader < com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes >. More...

Inheritance diagram for KeyedBytesDataReader:

Public Member Functions
void	read (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader.
void	take (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Access a collection of data-samples from the com.rti.dds.subscription.DataReader.
void	read_w_condition (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
void	take_w_condition (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition condition)
	Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read_w_condition except it accesses samples via the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take operation.
void	read_next_sample (KeyedBytes received_data, SampleInfo sample_info)
	Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader.
void	take_next_sample (KeyedBytes received_data, SampleInfo sample_info)
	Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader.
void	read_instance (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader.
void	take_instance (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader.
void	read_instance_w_condition (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
void	take_instance_w_condition (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
void	read_next_instance (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader.
void	take_next_instance (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Access a collection of data samples from the com.rti.dds.subscription.DataReader.
void	read_next_instance_w_condition (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
void	take_next_instance_w_condition (KeyedBytesSeq received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition condition)
	Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.
void	return_loan (KeyedBytesSeq received_data, SampleInfoSeq info_seq)
	Indicates to the com.rti.dds.subscription.DataReader 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 com.rti.dds.subscription.DataReader.
void	get_key_value (KeyedBytes key_holder, InstanceHandle_t handle)
	Retrieve the instance key that corresponds to an instance handle.
String	get_key_value (InstanceHandle_t handle)
	<<eXtension>> Retrieve the instance key that corresponds to an instance handle.
InstanceHandle_t	lookup_instance (KeyedBytes key_holder)
	Retrieve the instance handle that corresponds to an instance key_holder.
InstanceHandle_t	lookup_instance (String key)
	<<eXtension>> Retrieve the instance handle that corresponds to an instance key.
Public Member Functions inherited from DataReader
ReadCondition	create_readcondition (int sample_states, int view_states, int instance_states)
	Creates a com.rti.dds.subscription.ReadCondition.
QueryCondition	create_querycondition (int sample_states, int view_states, int instance_states, String query_expression, StringSeq query_parameters)
	Creates a com.rti.dds.subscription.QueryCondition.
void	delete_readcondition (ReadCondition condition)
	Deletes a com.rti.dds.subscription.ReadCondition or com.rti.dds.subscription.QueryCondition attached to the com.rti.dds.subscription.DataReader.
void	set_qos (DataReaderQos qos)
	Sets the reader QoS.
void	set_qos_with_profile (String library_name, String profile_name)
	<<eXtension>> Change the QoS of this reader using the input XML QoS profile.
void	get_qos (DataReaderQos qos)
	Gets the reader QoS.
void	set_listener (DataReaderListener l, int mask)
	Sets the reader listener.
DataReaderListener	get_listener ()
	Get the reader listener.
void	call_listenerT (int mask)
	Calls the reader listener.
void	get_sample_rejected_status (SampleRejectedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE_REJECTED_STATUS communication status.
void	get_liveliness_changed_status (LivelinessChangedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS_CHANGED_STATUS communication status.
void	get_requested_deadline_missed_status (RequestedDeadlineMissedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED_DEADLINE_MISSED_STATUS communication status.
void	get_requested_incompatible_qos_status (RequestedIncompatibleQosStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED_INCOMPATIBLE_QOS_STATUS communication status.
void	get_sample_lost_status (SampleLostStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE_LOST_STATUS_STATUS communication status.
void	get_subscription_matched_status (SubscriptionMatchedStatus status)
	Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION_MATCHED_STATUS communication status.
void	get_datareader_cache_status (DataReaderCacheStatus status)
	<<eXtension>> Get the datareader cache status for this reader.
void	get_datareader_protocol_status (DataReaderProtocolStatus status)
	<<eXtension>> Get the datareader protocol status for this reader.
void	get_matched_publication_datareader_protocol_status (DataReaderProtocolStatus status, InstanceHandle_t publication_handle)
	<<eXtension>> Get the datareader protocol status for this reader, per matched publication identified by the publication_handle.
void	get_matched_publications (InstanceHandleSeq publication_handles)
	Retrieve the list of publications currently "associated" with this com.rti.dds.subscription.DataReader.
void	get_matched_publication_data (PublicationBuiltinTopicData publication_data, InstanceHandle_t publication_handle)
	This operation retrieves the information on a publication that is currently "associated" with the com.rti.dds.subscription.DataReader.
TopicDescription	get_topicdescription ()
	Returns the com.rti.dds.topic.TopicDescription associated with the com.rti.dds.subscription.DataReader.
Subscriber	get_subscriber ()
	Returns the com.rti.dds.subscription.Subscriber to which the com.rti.dds.subscription.DataReader belongs.
void	delete_contained_entities ()
	Deletes all the entities that were created by means of the "create" operations on the com.rti.dds.subscription.DataReader.
void	wait_for_historical_data (Duration_t max_wait)
	Waits until all "historical" data is received for com.rti.dds.subscription.DataReader entities that have a non-VOLATILE Durability Qos kind.
void	acknowledge_sample (SampleInfo sample_info)
	Acknowledge a single sample explicitly.
void	acknowledge_all ()
	Acknowledge all previously accessed samples.
void	acknowledge_sample (SampleInfo sample_info, AckResponseData_t response_data)
	[Not supported.] Acknowledge a single sample explicitly
void	acknowledge_all (AckResponseData_t response_data)
	[Not supported.] Acknowledge all previously accessed samples
void	read_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Read data samples, if any are available.
void	take_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, int sample_states, int view_states, int instance_states)
	Take data samples, if any are available.
void	read_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition read_condition)
	Read data samples, if any are available.
void	take_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, ReadCondition read_condition)
	Take data samples, if any are available.
void	read_next_sample_untyped (Object received_data, SampleInfo sample_info)
	Read data samples, if any are available.
void	take_next_sample_untyped (Object received_data, SampleInfo sample_info)
	Take data samples, if any are available.
void	read_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Read data samples, if any are available.
void	take_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Take data samples, if any are available.
void	read_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Read data samples, if any are available.
void	take_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Take data samples, if any are available.
void	read_next_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Read data samples, if any are available.
void	take_next_instance_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, int sample_states, int view_states, int instance_states)
	Take data samples, if any are available.
void	read_next_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Read data samples, if any are available.
void	take_next_instance_w_condition_untyped (List received_data, SampleInfoSeq info_seq, int max_samples, InstanceHandle_t a_handle, ReadCondition read_condition)
	Take data samples, if any are available.
void	return_loan_untyped (List received_data, SampleInfoSeq info_seq)
	Return loaned sample data and meta-data.
void	get_key_value_untyped (Object key_holder, InstanceHandle_t handle)
	Fill in the key fields of the given data sample.
InstanceHandle_t	lookup_instance_untyped (Object key_value)

Detailed Description

<<interface>> Instantiates DataReader < com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes >.

See Also

com.rti.ndds.example.FooDataReader

com.rti.dds.subscription.DataReader

Member Function Documentation

void read	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.read

void take	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data-samples from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.take

void read_w_condition	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See Also

com.rti.ndds.example.FooDataReader.read_w_condition

void take_w_condition	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		ReadCondition	condition
	)

Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read_w_condition except it accesses samples via the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take operation.

See Also

com.rti.ndds.example.FooDataReader.take_w_condition

void read_next_sample	(	KeyedBytes	received_data,
		SampleInfo	sample_info
	)

Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.read_next_sample

void take_next_sample	(	KeyedBytes	received_data,
		SampleInfo	sample_info
	)

Copies the next not-previously-accessed data value from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.take_next_sample

void read_instance	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.read_instance

void take_instance	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.take_instance

void read_instance_w_condition	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See Also

com.rti.ndds.example.FooDataReader.read_instance_w_condition

void take_instance_w_condition	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See Also

com.rti.ndds.example.FooDataReader.take_instance_w_condition

void read_next_instance	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.read_next_instance

void take_next_instance	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		int	sample_states,
		int	view_states,
		int	instance_states
	)

Access a collection of data samples from the com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.take_next_instance

void read_next_instance_w_condition	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See Also

com.rti.ndds.example.FooDataReader.read_next_instance_w_condition

void take_next_instance_w_condition	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq,
		int	max_samples,
		InstanceHandle_t	a_handle,
		ReadCondition	condition
	)

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take_next_instance the samples that match the criteria specified in the com.rti.dds.subscription.ReadCondition.

See Also

com.rti.ndds.example.FooDataReader.take_next_instance_w_condition

void return_loan	(	KeyedBytesSeq	received_data,
		SampleInfoSeq	info_seq
	)

Indicates to the com.rti.dds.subscription.DataReader 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 com.rti.dds.subscription.DataReader.

See Also

com.rti.ndds.example.FooDataReader.return_loan

void get_key_value	(	KeyedBytes	key_holder,
		InstanceHandle_t	handle
	)

Retrieve the instance key that corresponds to an instance handle.

See Also

com.rti.ndds.example.FooDataReader.get_key_value

String get_key_value

(

InstanceHandle_t

handle

)

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

See Also

com.rti.ndds.example.FooDataReader.get_key_value

InstanceHandle_t lookup_instance

(

KeyedBytes

key_holder

)

Retrieve the instance handle that corresponds to an instance key_holder.

See Also

com.rti.ndds.example.FooDataReader.lookup_instance

InstanceHandle_t lookup_instance

(

String

key

)

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

See Also

com.rti.ndds.example.FooDataReader.lookup_instance