RTI Connext Java API  Version 5.1.0
KeyedBytesDataWriter Class Reference

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

Inheritance diagram for KeyedBytesDataWriter:
DataWriter DomainEntity Entity

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.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance.
 
void unregister_instance (String key, InstanceHandle_t handle)
 <<eXtension>> Reverses the action of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.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.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.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.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.
 
- Public Member Functions inherited from DataWriter
void set_qos (DataWriterQos qos)
 Sets the writer QoS.
 
void set_qos_with_profile (String library_name, String profile_name)
 <<eXtension>> Change the QoS of this writer using the input XML QoS profile.
 
void get_qos (DataWriterQos qos)
 Gets the writer QoS.
 
void set_listener (DataWriterListener l, int mask)
 Sets the writer listener.
 
DataWriterListener get_listener ()
 Get the writer listener.
 
void get_liveliness_lost_status (LivelinessLostStatus status)
 Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS_LOST_STATUS communication status.
 
void get_offered_deadline_missed_status (OfferedDeadlineMissedStatus status)
 Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_DEADLINE_MISSED_STATUS communication status.
 
void get_offered_incompatible_qos_status (OfferedIncompatibleQosStatus status)
 Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED_INCOMPATIBLE_QOS_STATUS communication status.
 
void get_publication_matched_status (PublicationMatchedStatus status)
 Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION_MATCHED_STATUS communication status.
 
void get_reliable_writer_cache_changed_status (ReliableWriterCacheChangedStatus status)
 <<eXtension>> Get the reliable cache status for this writer.
 
void get_reliable_reader_activity_changed_status (ReliableReaderActivityChangedStatus status)
 <<eXtension>> Get the reliable reader activity changed status for this writer.
 
void get_datawriter_cache_status (DataWriterCacheStatus status)
 <<eXtension>> Get the datawriter cache status for this writer.
 
void get_datawriter_protocol_status (DataWriterProtocolStatus status)
 <<eXtension>> Get the datawriter protocol status for this writer.
 
void get_matched_subscription_datawriter_protocol_status (DataWriterProtocolStatus status, InstanceHandle_t subscription_handle)
 <<eXtension>> Get the datawriter protocol status for this writer, per matched subscription identified by the subscription_handle.
 
void get_matched_subscription_datawriter_protocol_status_by_locator (DataWriterProtocolStatus status, Locator_t locator)
 <<eXtension>> Get the datawriter protocol status for this writer, per matched subscription identified by the locator.
 
void get_matched_subscription_locators (LocatorSeq locators)
 <<eXtension>> Retrieve the list of locators for subscriptions currently "associated" with this com.rti.dds.publication.DataWriter.
 
void get_matched_subscriptions (InstanceHandleSeq subscription_handles)
 Retrieve the list of subscriptions currently "associated" with this com.rti.dds.publication.DataWriter.
 
void get_matched_subscription_data (SubscriptionBuiltinTopicData subscription_data, InstanceHandle_t subscription_handle)
 This operation retrieves the information on a subscription that is currently "associated" with the com.rti.dds.publication.DataWriter.
 
void get_matched_subscription_participant_data (ParticipantBuiltinTopicData participant_data, InstanceHandle_t subscription_handle)
 This operation retrieves the information on the discovered com.rti.dds.domain.DomainParticipant associated with the subscription that is currently matching with the com.rti.dds.publication.DataWriter.
 
Topic get_topic ()
 This operation returns the com.rti.dds.topic.Topic associated with the com.rti.dds.publication.DataWriter.
 
Publisher get_publisher ()
 This operation returns the com.rti.dds.publication.Publisher to which the com.rti.dds.publication.DataWriter belongs.
 
void wait_for_acknowledgments (Duration_t max_wait)
 Blocks the calling thread until all data written by reliable com.rti.dds.publication.DataWriter entity is acknowledged, or until timeout expires.
 
void wait_for_asynchronous_publishing (Duration_t max_wait)
 <<eXtension>> Blocks the calling thread until asynchronous sending is complete.
 
void assert_liveliness ()
 This operation manually asserts the liveliness of this com.rti.dds.publication.DataWriter.
 
void flush ()
 <<eXtension>> Flushes the batch in progress in the context of the calling thread.
 
InstanceHandle_t register_instance_untyped (Object instance_data)
 Register a new instance with this writer.
 
InstanceHandle_t register_instance_w_timestamp_untyped (Object instance_data, Time_t source_timestamp)
 Register a new instance with this writer using the given time instead of the current time.
 
void unregister_instance_untyped (Object instance_data, InstanceHandle_t handle)
 Unregister a new instance from this writer.
 
void unregister_instance_w_timestamp_untyped (Object instance_data, InstanceHandle_t handle, Time_t source_timestamp)
 Unregister a new instance from this writer using the given time instead of the current time.
 
void write_untyped (Object instance_data, InstanceHandle_t handle)
 Publish a data sample.
 
void write_w_timestamp_untyped (Object instance_data, InstanceHandle_t handle, Time_t source_timestamp)
 Publish a data sample using the given time instead of the current time.
 
void dispose_untyped (Object instance_data, InstanceHandle_t handle)
 Dispose a data sample.
 
void dispose_w_timestamp_untyped (Object instance_data, InstanceHandle_t handle, Time_t source_timestamp)
 Dispose a data sample using the given time instead of the current time.
 
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)
 Given a sample with the given key field values, return the handle corresponding to its instance.
 

Detailed Description

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

See Also
com.rti.ndds.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.ndds.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.ndds.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance except that the application provides the value for the source_timestamp.

See Also
com.rti.ndds.example.FooDataWriter.register_instance_w_timestamp
InstanceHandle_t register_instance_w_timestamp ( String  key,
Time_t  source_timestamp 
)

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

See Also
com.rti.ndds.example.FooDataWriter.register_instance_w_timestamp
void unregister_instance ( KeyedBytes  instance_data,
InstanceHandle_t  handle 
)

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

See Also
com.rti.ndds.example.FooDataWriter.unregister_instance
void unregister_instance ( String  key,
InstanceHandle_t  handle 
)

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

See Also
com.rti.ndds.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.unregister_instance except that it also provides the value for the source_timestamp.

See Also
com.rti.ndds.example.FooDataWriter.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.unregister_instance except that it also provides the value for the source_timestamp.

See Also
com.rti.ndds.example.FooDataWriter.FooDataWriter.unregister_instance_w_timestamp
void write ( KeyedBytes  instance_data,
InstanceHandle_t  handle 
)

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

See Also
com.rti.ndds.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.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL. See com.rti.ndds.example.FooDataWriter.write.
See Also
com.rti.ndds.example.FooDataWriter.write
void write ( String  key,
ByteSeq  octets,
InstanceHandle_t  handle 
)

<<eXtension>> Modifies the value of a com.rti.dds.type.builtin.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL. See com.rti.ndds.example.FooDataWriter.write.
See Also
com.rti.ndds.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.write except that it also provides the value for the source_timestamp.

See Also
com.rti.ndds.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL. See com.rti.ndds.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.ndds.example.FooDataWriter.write_w_timestamp. Cannot be NULL.
See Also
com.rti.ndds.example.FooDataWriter.write
void write_w_timestamp ( String  key,
ByteSeq  octets,
InstanceHandle_t  handle,
Time_t  source_timestamp 
)

Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.com.rti.dds.type.builtin.KeyedBytesDataWriter.register_instance, or else the special value com.rti.dds.infrastructure.InstanceHandle_t.InstanceHandle_t.HANDLE_NIL. See com.rti.ndds.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.ndds.example.FooDataWriter.write_w_timestamp. Cannot be NULL.
See Also
com.rti.ndds.example.FooDataWriter.write
void dispose ( KeyedBytes  instance_data,
InstanceHandle_t  instance_handle 
)

Requests the middleware to delete the data.

See Also
com.rti.ndds.example.FooDataWriter.dispose
void dispose ( String  key,
InstanceHandle_t  instance_handle 
)

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

See Also
com.rti.ndds.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.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.ndds.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.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.ndds.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.ndds.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.ndds.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.ndds.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.ndds.example.FooDataWriter.lookup_instance

RTI Connext Java API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc