DDS::KeyedBytesDataWriter Class Reference
[KeyedOctets Built-in Type]

<<interface>> Instantiates DataWriter < DDS::KeyedBytes >. More...

#include <managed_keyedbytesSupport.h>

Inheritance diagram for DDS::KeyedBytesDataWriter:

DDS::TypedDataWriter< T > DDS::DataWriter DDS::DomainEntity DDS::Entity

List of all members.

Public Member Functions

InstanceHandle_t register_instance (System::String^ key)
 <<eXtension>> Informs RTI Data Distribution Service that the application will be modifying a particular instance.
InstanceHandle_t register_instance_w_timestamp (System::String^ key, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same functions as DDS::KeyedBytesDataWriter::register_instance except that the application provides the value for the source_timestamp.
void unregister_instance (System::String^ key, DDS::InstanceHandle_t% handle)
 <<eXtension>> Reverses the action of DDS::KeyedBytesDataWriter::register_instance.
void unregister_instance_w_timestamp (System::String^ key, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same function as DDS::KeyedBytesDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
void write (System::String^ key, array< System::Byte >^octets, System::Int32 offset, System::Int32 length, DDS::InstanceHandle_t% handle)
 <<eXtension>> Modifies the value of a DDS::KeyedBytes data instance.
void write (System::String^ key, ByteSeq^ octets, DDS::InstanceHandle_t% handle)
 <<eXtension>> Modifies the value of a DDS::KeyedBytes data instance.
void write_w_timestamp (System::String^ key, array< System::Byte >^octets, System::Int32 offset, System::Int32 length, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 Performs the same function as DDS::KeyedBytesDataWriter::write except that it also provides the value for the source_timestamp.
void write_w_timestamp (System::String^ key, ByteSeq^ octets, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 Performs the same function as DDS::KeyedBytesDataWriter::write except that it also provides the value for the source_timestamp.
void dispose (System::String^ key, DDS::InstanceHandle_t% instance_handle)
 <<eXtension>> Requests the middleware to delete the data.
void dispose_w_timestamp (System::String^ key, DDS::InstanceHandle_t% instance_handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same functions as DDS::KeyedBytesDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDS::DataReader objects by means of the source_timestamp attribute inside the DDS::SampleInfo.
System::String^ get_key_value (DDS::InstanceHandle_t% handle)
 <<eXtension>> Retrieve the instance key that corresponds to an instance handle.
InstanceHandle_t lookup_instance (System::String^ key)
 <<eXtension>> Retrieve the instance handle that corresponds to an instance key.


Detailed Description

<<interface>> Instantiates DataWriter < DDS::KeyedBytes >.

See also:
DDS::TypedDataWriter

DDS::DataWriter


Member Function Documentation

InstanceHandle_t DDS::KeyedBytesDataWriter::register_instance ( System::String^   key  ) 

<<eXtension>> Informs RTI Data Distribution Service that the application will be modifying a particular instance.

See also:
DDS::TypedDataWriter::register_instance

InstanceHandle_t DDS::KeyedBytesDataWriter::register_instance_w_timestamp ( System::String^   key,
DDS::Time_t%   source_timestamp 
)

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

See also:
DDS::TypedDataWriter::register_instance_w_timestamp

void DDS::KeyedBytesDataWriter::unregister_instance ( System::String^   key,
DDS::InstanceHandle_t%   handle 
)

void DDS::KeyedBytesDataWriter::unregister_instance_w_timestamp ( System::String^   key,
DDS::InstanceHandle_t%   handle,
DDS::Time_t%   source_timestamp 
)

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

See also:
DDS::TypedDataWriter::unregister_instance_w_timestamp

void DDS::KeyedBytesDataWriter::write ( System::String^   key,
array< System::Byte >^  octets,
System::Int32  offset,
System::Int32  length,
DDS::InstanceHandle_t%   handle 
)

<<eXtension>> Modifies the value of a DDS::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 DDS::KeyedOctetsDataWriter::register_instance, or else the special value DDS::InstanceHandle_t::HANDLE_NIL. See DDS::TypedDataWriter::write.
See also:
DDS::TypedDataWriter::write

void DDS::KeyedBytesDataWriter::write ( System::String^   key,
ByteSeq^   octets,
DDS::InstanceHandle_t%   handle 
)

<<eXtension>> Modifies the value of a DDS::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 DDS::KeyedOctetsDataWriter::register_instance, or else the special value DDS::InstanceHandle_t::HANDLE_NIL. See DDS::TypedDataWriter::write.
See also:
DDS::TypedDataWriter::write

void DDS::KeyedBytesDataWriter::write_w_timestamp ( System::String^   key,
array< System::Byte >^  octets,
System::Int32  offset,
System::Int32  length,
DDS::InstanceHandle_t%   handle,
DDS::Time_t%   source_timestamp 
)

Performs the same function as DDS::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 DDS::KeyedOctetsDataWriter::register_instance, or else the special value DDS::InstanceHandle_t::HANDLE_NIL. See DDS::TypedDataWriter::write.
source_timestamp <<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See DDS::TypedDataWriter::write_w_timestamp. Cannot be NULL.
See also:
DDS::TypedDataWriter::write

void DDS::KeyedBytesDataWriter::write_w_timestamp ( System::String^   key,
ByteSeq^   octets,
DDS::InstanceHandle_t%   handle,
DDS::Time_t%   source_timestamp 
)

Performs the same function as DDS::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 DDS::KeyedOctetsDataWriter::register_instance, or else the special value DDS::InstanceHandle_t::HANDLE_NIL. See DDS::TypedDataWriter::write.
source_timestamp <<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See DDS::TypedDataWriter::write_w_timestamp. Cannot be NULL.
See also:
DDS::TypedDataWriter::write

void DDS::KeyedBytesDataWriter::dispose ( System::String^   key,
DDS::InstanceHandle_t%   instance_handle 
)

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

See also:
DDS::TypedDataWriter::dispose

void DDS::KeyedBytesDataWriter::dispose_w_timestamp ( System::String^   key,
DDS::InstanceHandle_t%   instance_handle,
DDS::Time_t%   source_timestamp 
)

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

See also:
DDS::TypedDataWriter::dispose_w_timestamp

System::String ^ DDS::KeyedBytesDataWriter::get_key_value ( DDS::InstanceHandle_t%   handle  ) 

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

See also:
DDS::TypedDataWriter::get_key_value

InstanceHandle_t DDS::KeyedBytesDataWriter::lookup_instance ( System::String^   key  ) 

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

See also:
DDS::TypedDataWriter::lookup_instance


RTI Data Distribution Service .Net APIs Version 4.5c Copyright © 9 Jun 2010 Real-Time Innovations, Inc