DDSOctetsDataWriter Class Reference
[Octets Built-in Type]

<<interface>> Instantiates DataWriter < DDS_Octets >. More...

Inheritance diagram for DDSOctetsDataWriter:

DDSDataWriter DDSDomainEntity DDSEntity

List of all members.

Public Member Functions

virtual DDS_ReturnCode_t write (const DDS_Octets &instance_data, const DDS_InstanceHandle_t &handle)
 Modifies the value of a DDS_Octets data instance.
virtual DDS_ReturnCode_t write (const unsigned char *octets, int length, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Modifies the value of a DDS_Octets data instance.
virtual DDS_ReturnCode_t write (const DDS_OctetSeq &octets, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Modifies the value of a DDS_Octets data instance.
virtual DDS_ReturnCode_t write_w_timestamp (const DDS_Octets &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t write_w_timestamp (const unsigned char *octets, int length, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 <<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t write_w_timestamp (const DDS_OctetSeq &octets, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 <<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t write_w_params (const DDS_Octets &instance_data, const DDS_WriteParams_t &params)
 Performs the same function as DDSOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
virtual DDS_ReturnCode_t write_w_params (const unsigned char *octets, int length, const DDS_WriteParams_t &params)
 <<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
virtual DDS_ReturnCode_t write_w_params (const DDS_OctetSeq &octets, const DDS_WriteParams_t &params)
 <<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

Static Public Member Functions

static DDSOctetsDataWriternarrow (DDSDataWriter *writer)
 Narrow the given DDSDataWriter pointer to a DDSOctetsDataWriter pointer.


Detailed Description

<<interface>> Instantiates DataWriter < DDS_Octets >.

See also:
FooDataWriter

DDSDataWriter


Member Function Documentation

static DDSOctetsDataWriter* DDSOctetsDataWriter::narrow ( DDSDataWriter writer  )  [static]

Narrow the given DDSDataWriter pointer to a DDSOctetsDataWriter pointer.

See also:
FooDataWriter::narrow

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write ( const DDS_Octets instance_data,
const DDS_InstanceHandle_t handle 
) [virtual]

Modifies the value of a DDS_Octets data instance.

See also:
FooDataWriter::write

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write ( const unsigned char *  octets,
int  length,
const DDS_InstanceHandle_t handle 
) [virtual]

<<eXtension>> Modifies the value of a DDS_Octets data instance.

Parameters:
octets <<in>> Array of octets to be published.
length <<in>> Number of octets to be published.
handle <<in>> The special value DDS_HANDLE_NIL should be used always.
See also:
FooDataWriter::write

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write ( const DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle 
) [virtual]

<<eXtension>> Modifies the value of a DDS_Octets data instance.

Parameters:
octets <<in>> Sequence of octets to be published.
handle <<in>> The special value DDS_HANDLE_NIL should be used always.
See also:
FooDataWriter::write

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_timestamp ( const DDS_Octets instance_data,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
) [virtual]

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

See also:
FooDataWriter::write_w_timestamp

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_timestamp ( const unsigned char *  octets,
int  length,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
) [virtual]

<<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.

Parameters:
octets <<in>> Array of octets to be published.
length <<in>> Number of octets to be published.
handle <<in>> The special value DDS_HANDLE_NIL should be used always.
source_timestamp <<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See FooDataWriter::write_w_timestamp.
See also:
FooDataWriter::write_w_timestamp

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_timestamp ( const DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
) [virtual]

<<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.

Parameters:
octets <<in>> Sequence of octets to be published.
handle <<in>> The special value DDS_HANDLE_NIL should be used always.
source_timestamp <<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See FooDataWriter::write_w_timestamp.
See also:
FooDataWriter::write_w_timestamp

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_params ( const DDS_Octets instance_data,
const DDS_WriteParams_t params 
) [virtual]

Performs the same function as DDSOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

See also:
FooDataWriter::write_w_params

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_params ( const unsigned char *  octets,
int  length,
const DDS_WriteParams_t params 
) [virtual]

<<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

Parameters:
octets <<in>> Array of octets to be published.
length <<in>> Number of octets to be published.
params <<in>> The DDS_WriteParams parameter containing the instance handle, source timestamp, publication priority, and cookie to be used in write operation. See FooDataWriter::write_w_params.
See also:
FooDataWriter::write_w_params

virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_params ( const DDS_OctetSeq octets,
const DDS_WriteParams_t params 
) [virtual]

<<eXtension>> Performs the same function as DDSOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

Parameters:
octets <<in>> Sequence of octets to be published.
params <<in>> The DDS_WriteParams parameter containing the instance handle, source timestamp, publication priority, and cookie to be used in write operation. See FooDataWriter::write_w_params.
See also:
FooDataWriter::write_w_params


RTI Connext C++ API Version 4.5f Copyright © 17 Mar 2012 Real-Time Innovations, Inc