RTI Connext C API  Version 5.1.0
WriteParams

<<eXtension>> More...

Data Structures

struct  DDS_SampleIdentity_t
 Type definition for a Sample Identity. More...
 
struct  DDS_WriteParams_t
 <<eXtension>> Input parameters for writing with FooDataWriter_write_w_params, FooDataWriter_dispose_w_params, FooDataWriter_register_instance_w_params, FooDataWriter_unregister_instance_w_params More...
 

Functions

DDS_Boolean DDS_SampleIdentity_equals (const struct DDS_SampleIdentity_t *self, const struct DDS_SampleIdentity_t *other)
 Compares this sample identity with another sample identity for equality.
 
void DDS_WriteParams_reset (struct DDS_WriteParams_t *self)
 Resets all the fields to their default values.
 

Variables

struct DDS_GUID_t DDS_SampleIdentity_t::writer_guid
 16-byte identifier identifying the virtual GUID.
 
struct DDS_SequenceNumber_t DDS_SampleIdentity_t::sequence_number
 monotonically increasing 64-bit integer that identifies the sample in the data source.
 
struct DDS_SampleIdentity_t DDS_AUTO_SAMPLE_IDENTITY
 The AUTO sample identity.
 
struct DDS_SampleIdentity_t DDS_UNKNOWN_SAMPLE_IDENTITY
 An invalid or unknown sample identity.
 
struct DDS_WriteParams_t DDS_WRITEPARAMS_DEFAULT
 Initializer for DDS_WriteParams_t.
 

Detailed Description

<<eXtension>>

Function Documentation

DDS_Boolean DDS_SampleIdentity_equals ( const struct DDS_SampleIdentity_t self,
const struct DDS_SampleIdentity_t other 
)

Compares this sample identity with another sample identity for equality.

Parameters
self<<in>> This sample identity.
other<<in>> The other sample identity to be compared with this sample identity.
Returns
DDS_BOOLEAN_TRUE if the two sample identities have equal values, or DDS_BOOLEAN_FALSE otherwise.
void DDS_WriteParams_reset ( struct DDS_WriteParams_t self)

Resets all the fields to their default values.

This operation is useful to reset all the fields to their automatic value when DDS_WriteParams_t::replace_auto is enabled and the same params instance is used in multiple calls to FooDataWriter_write_w_params

Variable Documentation

struct DDS_GUID_t DDS_SampleIdentity_t::writer_guid

16-byte identifier identifying the virtual GUID.

struct DDS_SequenceNumber_t DDS_SampleIdentity_t::sequence_number

monotonically increasing 64-bit integer that identifies the sample in the data source.

struct DDS_SampleIdentity_t DDS_AUTO_SAMPLE_IDENTITY

The AUTO sample identity.

Special DDS_AUTO_SAMPLE_IDENTITY value {DDS_GUID_AUTO, DDS_AUTO_SEQUENCE_NUMBER}

struct DDS_SampleIdentity_t DDS_UNKNOWN_SAMPLE_IDENTITY

An invalid or unknown sample identity.

Special DDS_UNKNOWN_SAMPLE_IDENTITY value {DDS_GUID_UNKNOWN, DDS_SEQUENCE_NUMBER_UNKNOWN}

struct DDS_WriteParams_t DDS_WRITEPARAMS_DEFAULT

Initializer for DDS_WriteParams_t.


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