KeyedBytesDataWriter Class Reference
[KeyedOctets Built-in Type]

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

Inheritance diagram for KeyedBytesDataWriter:

List of all members.

Public Member Functions
InstanceHandle_t	register_instance (KeyedBytes instance_data)
	Informs RTI Connext that the application will be modifying a particular instance.
InstanceHandle_t	register_instance (String key)
	<<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.
InstanceHandle_t	register_instance_w_timestamp (KeyedBytes instance_data, Time_t source_timestamp)
	Performs the same functions as com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance except that the application provides the value for the source_timestamp.
InstanceHandle_t	register_instance_w_timestamp (String key, Time_t source_timestamp)
	<<eXtension>> Performs the same functions as KeyedBytesDataWriter.register_instance except that the application provides the value for the source_timestamp.
void	unregister_instance (KeyedBytes instance_data, InstanceHandle_t handle)
	Reverses the action of com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance.
void	unregister_instance (String key, InstanceHandle_t handle)
	<<eXtension>> Reverses the action of KeyedBytesDataWriter.register_instance.
void	unregister_instance_w_timestamp (KeyedBytes instance_data, InstanceHandle_t handle, Time_t source_timestamp)
	Performs the same function as com.rti.dds.type.builtin.KeyedBytesDataWriter.unregister_instance except that it also provides the value for the source_timestamp.
void	unregister_instance_w_timestamp (String key, InstanceHandle_t handle, Time_t source_timestamp)
	<<eXtension>> Performs the same function as KeyedBytesDataWriter.unregister_instance except that it also provides the value for the source_timestamp.
void	write (KeyedBytes instance_data, InstanceHandle_t handle)
	Modifies the value of a com.rti.dds.type.builtin.KeyedBytes data instance.
void	write (String key, byte[] octets, int offset, int length, InstanceHandle_t handle)
	<<eXtension>> Modifies the value of a com.rti.dds.type.builtin.KeyedBytes data instance.
void	write (String key, ByteSeq octets, InstanceHandle_t handle)
	<<eXtension>> Modifies the value of a com.rti.dds.type.builtin.KeyedBytes data instance.
void	write_w_timestamp (KeyedBytes instance_data, InstanceHandle_t handle, Time_t source_timestamp)
	Performs the same function as com.rti.dds.type.builtin.KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.
void	write_w_timestamp (String key, byte[] octets, int offset, int length, InstanceHandle_t handle, Time_t source_timestamp)
	Performs the same function as KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.
void	write_w_timestamp (String key, ByteSeq octets, InstanceHandle_t handle, Time_t source_timestamp)
	Performs the same function as KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.
void	dispose (KeyedBytes instance_data, InstanceHandle_t instance_handle)
	Requests the middleware to delete the data.
void	dispose (String key, InstanceHandle_t instance_handle)
	<<eXtension>> Requests the middleware to delete the data.
void	dispose_w_timestamp (KeyedBytes instance_data, InstanceHandle_t instance_handle, Time_t source_timestamp)
	Performs the same functions as com.rti.dds.type.builtin.KeyedBytesDataWriter.dispose except that the application provides the value for the source_timestamp that is made available to com.rti.dds.subscription.DataReader objects by means of the source_timestamp attribute inside the com.rti.dds.subscription.SampleInfo.
void	dispose_w_timestamp (String key, InstanceHandle_t instance_handle, Time_t source_timestamp)
	<<eXtension>> Performs the same functions as KeyedBytesDataWriter.dispose except that the application provides the value for the source_timestamp that is made available to com.rti.dds.subscription.DataReader objects by means of the source_timestamp attribute inside the com.rti.dds.subscription.SampleInfo.
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.

---

Detailed Description

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

See also:

com.rti.dds.topic.example.FooDataWriter

com.rti.dds.publication.DataWriter

---

Member Function Documentation

InstanceHandle_t register_instance

(

KeyedBytes

instance_data

)

Informs RTI Connext that the application will be modifying a particular instance.

See also:

com.rti.dds.topic.example.FooDataWriter.register_instance

InstanceHandle_t register_instance

(

String

key

)

<<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.

See also:

com.rti.dds.topic.example.FooDataWriter.register_instance

InstanceHandle_t register_instance_w_timestamp	(	KeyedBytes	instance_data,
		Time_t	source_timestamp
	)

Performs the same functions as com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance except that the application provides the value for the source_timestamp.

See also:

com.rti.dds.topic.example.FooDataWriter.register_instance_w_timestamp

InstanceHandle_t register_instance_w_timestamp	(	String	key,
		Time_t	source_timestamp
	)

<<eXtension>> Performs the same functions as KeyedBytesDataWriter.register_instance except that the application provides the value for the source_timestamp.

See also:

com.rti.dds.topic.example.FooDataWriter.register_instance_w_timestamp

void unregister_instance	(	KeyedBytes	instance_data,
		InstanceHandle_t	handle
	)

Reverses the action of com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance.

See also:

com.rti.dds.topic.example.FooDataWriter.unregister_instance

void unregister_instance	(	String	key,
		InstanceHandle_t	handle
	)

<<eXtension>> Reverses the action of KeyedBytesDataWriter.register_instance.

See also:

com.rti.dds.topic.example.FooDataWriter.unregister_instance

void unregister_instance_w_timestamp	(	KeyedBytes	instance_data,
		InstanceHandle_t	handle,
		Time_t	source_timestamp
	)

Performs the same function as com.rti.dds.type.builtin.KeyedBytesDataWriter.unregister_instance except that it also provides the value for the source_timestamp.

See also:

FooDataWriter.unregister_instance_w_timestamp

void unregister_instance_w_timestamp	(	String	key,
		InstanceHandle_t	handle,
		Time_t	source_timestamp
	)

<<eXtension>> Performs the same function as KeyedBytesDataWriter.unregister_instance except that it also provides the value for the source_timestamp.

See also:

FooDataWriter.unregister_instance_w_timestamp

void write	(	KeyedBytes	instance_data,
		InstanceHandle_t	handle
	)

Modifies the value of a com.rti.dds.type.builtin.KeyedBytes data instance.

See also:

com.rti.dds.topic.example.FooDataWriter.write

void write	(	String	key,
		byte[]	octets,
		int	offset,
		int	length,
		InstanceHandle_t	handle
	)

<<eXtension>> Modifies the value of a com.rti.dds.type.builtin.KeyedBytes data instance.

Parameters:

	key	<<in>> Instance key.
	octets	<<in>> Array of bytes to be published.
	offset	<<in>> Offset from which to start publishing.
	length	<<in>> Number of bytes to be published.
	handle	<<in>> Either the handle returned by a previous call to com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value InstanceHandle_t.HANDLE_NIL. See com.rti.dds.topic.example.FooDataWriter.write.

See also:

com.rti.dds.topic.example.FooDataWriter.write

void write	(	String	key,
		ByteSeq	octets,
		InstanceHandle_t	handle
	)

<<eXtension>> Modifies the value of a com.rti.dds.type.builtin.KeyedBytes data instance.

Parameters:

	key	<<in>> Instance key.
	octets	<<in>> Sequence of bytes to be published.
	handle	<<in>> Either the handle returned by a previous call to com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value InstanceHandle_t.HANDLE_NIL. See com.rti.dds.topic.example.FooDataWriter.write.

See also:

com.rti.dds.topic.example.FooDataWriter.write

void write_w_timestamp	(	KeyedBytes	instance_data,
		InstanceHandle_t	handle,
		Time_t	source_timestamp
	)

Performs the same function as com.rti.dds.type.builtin.KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.

See also:

com.rti.dds.topic.example.FooDataWriter.write_w_timestamp

void write_w_timestamp	(	String	key,
		byte[]	octets,
		int	offset,
		int	length,
		InstanceHandle_t	handle,
		Time_t	source_timestamp
	)

Performs the same function as KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.

Parameters:

	key	<<in>> Instance key.
	octets	<<in>> Array of bytes to be published.
	offset	<<in>> Offset from which to start publishing.
	length	<<in>> Number of bytes to be published.
	handle	<<in>> Either the handle returned by a previous call to com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value InstanceHandle_t.HANDLE_NIL. See com.rti.dds.topic.example.FooDataWriter.write.
	source_timestamp	<<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See com.rti.dds.topic.example.FooDataWriter.write_w_timestamp. Cannot be NULL.

See also:

com.rti.dds.topic.example.FooDataWriter.write

void write_w_timestamp	(	String	key,
		ByteSeq	octets,
		InstanceHandle_t	handle,
		Time_t	source_timestamp
	)

Performs the same function as KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.

Parameters:

	key	<<in>> Instance key.
	octets	<<in>> Sequence of bytes to be published.
	handle	<<in>> Either the handle returned by a previous call to com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value InstanceHandle_t.HANDLE_NIL. See com.rti.dds.topic.example.FooDataWriter.write.
	source_timestamp	<<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See com.rti.dds.topic.example.FooDataWriter.write_w_timestamp. Cannot be NULL.

See also:

com.rti.dds.topic.example.FooDataWriter.write

void dispose	(	KeyedBytes	instance_data,
		InstanceHandle_t	instance_handle
	)

Requests the middleware to delete the data.

See also:

com.rti.dds.topic.example.FooDataWriter.dispose

void dispose	(	String	key,
		InstanceHandle_t	instance_handle
	)

<<eXtension>> Requests the middleware to delete the data.

See also:

com.rti.dds.topic.example.FooDataWriter.dispose

void dispose_w_timestamp	(	KeyedBytes	instance_data,
		InstanceHandle_t	instance_handle,
		Time_t	source_timestamp
	)

Performs the same functions as com.rti.dds.type.builtin.KeyedBytesDataWriter.dispose except that the application provides the value for the source_timestamp that is made available to com.rti.dds.subscription.DataReader objects by means of the source_timestamp attribute inside the com.rti.dds.subscription.SampleInfo.

See also:

com.rti.dds.topic.example.FooDataWriter.dispose_w_timestamp

void dispose_w_timestamp	(	String	key,
		InstanceHandle_t	instance_handle,
		Time_t	source_timestamp
	)

<<eXtension>> Performs the same functions as KeyedBytesDataWriter.dispose except that the application provides the value for the source_timestamp that is made available to com.rti.dds.subscription.DataReader objects by means of the source_timestamp attribute inside the com.rti.dds.subscription.SampleInfo.

See also:

com.rti.dds.topic.example.FooDataWriter.dispose_w_timestamp

void get_key_value	(	KeyedBytes	key_holder,
		InstanceHandle_t	handle
	)

Retrieve the instance key that corresponds to an instance handle.

See also:

com.rti.dds.topic.example.FooDataWriter.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.dds.topic.example.FooDataWriter.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.dds.topic.example.FooDataWriter.lookup_instance

InstanceHandle_t lookup_instance

(

String

key

)

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

See also:

com.rti.dds.topic.example.FooDataWriter.lookup_instance