RTI Connext C API  Version 6.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
KeyedOctets Built-in Type

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...

Data Structures

struct  DDS_KeyedOctets
 Built-in type consisting of a variable-length array of opaque bytes and a string that is the key. More...
 
struct  DDS_KeyedOctetsSeq
 Instantiates FooSeq < DDS_KeyedOctets >. More...
 
struct  DDS_KeyedOctetsTypeSupport
 <<interface>> DDS_KeyedOctets type support. More...
 

Typedefs

typedef struct DDS_KeyedOctets DDS_KeyedOctets
 Built-in type consisting of a variable-length array of opaque bytes and a string that is the key.
 
typedef struct
DDS_KeyedOctetsDataWriter 
DDS_KeyedOctetsDataWriter
 <<interface>> Instantiates DataWriter < DDS_KeyedOctets >.
 
typedef struct
DDS_KeyedOctetsDataReader 
DDS_KeyedOctetsDataReader
 <<interface>> Instantiates DataReader < DDS_KeyedOctets >.
 

Functions

DDS_KeyedOctetsDDS_KeyedOctets_new ()
 Constructor.
 
DDS_KeyedOctetsDDS_KeyedOctets_new_w_size (int key_size, int size)
 Constructor that specifies the allocated sizes.
 
void DDS_KeyedOctets_delete (DDS_KeyedOctets *self)
 Destructor.
 
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_register_type (DDS_DomainParticipant *participant, const char *type_name)
 Allows an application to communicate to RTI Connext the existence of the DDS_KeyedOctets data type.
 
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_unregister_type (DDS_DomainParticipant *participant, const char *type_name)
 Allows an application to unregister the DDS_KeyedOctets data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.
 
const char * DDS_KeyedOctetsTypeSupport_get_type_name ()
 Get the default name for the DDS_KeyedOctets type.
 
void DDS_KeyedOctetsTypeSupport_print_data (const DDS_KeyedOctets *a_data)
 <<extension>> Print value of data type to standard out.
 
DDS_TypeCodeDDS_KeyedOctetsTypeSupport_get_typecode ()
 <<extension>> Retrieves the TypeCode for the Type.
 
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_serialize_data_to_cdr_buffer (char *buffer, unsigned int *length, const DDS_KeyedOctets *a_data)
 <<extension>> Serializes the input sample into a CDR buffer of octets.
 
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_serialize_data_to_cdr_buffer_ex (char *buffer, unsigned int *length, const DDS_KeyedOctets *a_data, DDS_DataRepresentationId_t representation)
 <<extension>> Serializes the input sample into a buffer of octets.
 
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_deserialize_data_from_cdr_buffer (DDS_KeyedOctets *a_data, const char *buffer, unsigned int length)
 <<extension>> Deserializes a sample from a buffer of octets.
 
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_data_to_string (const DDS_KeyedOctets *sample, char *str, DDS_UnsignedLong *str_size, DDS_PrintFormatProperty *property)
 <<extension>> Get the string representation of an input sample.
 
DDS_KeyedOctetsDataWriterDDS_KeyedOctetsDataWriter_narrow (DDS_DataWriter *writer)
 Narrow the given DDS_DataWriter pointer to a DDS_KeyedOctetsDataWriter pointer.
 
DDS_DataWriterDDS_KeyedOctetsDataWriter_as_datawriter (DDS_KeyedOctetsDataWriter *writer)
 Widen the given DDS_KeyedOctetsDataWriter pointer to a DDS_DataWriter pointer.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data)
 Informs RTI Connext that the application will be modifying a particular instance.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance_w_key (DDS_KeyedOctetsDataWriter *self, const char *key)
 <<extension>> Informs RTI Connext that the application will be modifying a particular instance.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance_w_timestamp (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const struct DDS_Time_t *source_timestamp)
 Performs the same functions as DDS_KeyedOctetsDataWriter_register_instance except that the application provides the value for the source_timestamp.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance_w_key_w_timestamp (DDS_KeyedOctetsDataWriter *self, const char *key, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same functions as DDS_KeyedOctetsDataWriter_register_instance_w_key except that the application provides the value for the source_timestamp.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const DDS_InstanceHandle_t *handle)
 Reverses the action of DDS_KeyedOctetsDataWriter_register_instance.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance_w_key (DDS_KeyedOctetsDataWriter *self, const char *key, const DDS_InstanceHandle_t *handle)
 <<extension>> Reverses the action of DDS_KeyedOctetsDataWriter_register_instance_w_key.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance_w_timestamp (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 Performs the same function as DDS_KeyedOctetsDataWriter_unregister_instance except that it also provides the value for the source_timestamp.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance_w_key_w_timestamp (DDS_KeyedOctetsDataWriter *self, const char *key, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same function as DDS_KeyedOctetsDataWriter_unregister_instance_w_key except that it also provides the value for the source_timestamp.
 
DDS_KeyedOctetsDDS_KeyedOctetsDataWriter_create_data (DDS_KeyedOctetsDataWriter *self)
 Creates a keyed octet sequence.
 
DDS_Boolean DDS_KeyedOctetsDataWriter_delete_data (DDS_KeyedOctetsDataWriter *self, DDS_KeyedOctets *sample)
 Destroys a string data instance created by DDS_StringDataWriter_create_data.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const DDS_InstanceHandle_t *handle)
 Modifies the value of a DDS_KeyedOctets data instance.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_w_key (DDS_KeyedOctetsDataWriter *self, const char *key, const unsigned char *octets, int length, const DDS_InstanceHandle_t *handle)
 <<extension>> Modifies the value of a DDS_KeyedOctets data instance.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_seq_w_key (DDS_KeyedOctetsDataWriter *self, const char *key, const struct DDS_OctetSeq *octets, const DDS_InstanceHandle_t *handle)
 <<extension>> Modifies the value of a DDS_KeyedOctets data instance.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_w_timestamp (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 Performs the same function as DDS_KeyedOctetsDataWriter_write except that it also provides the value for the source_timestamp.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_w_key_w_timestamp (DDS_KeyedOctetsDataWriter *self, const char *key, const unsigned char *octets, int length, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 Performs the same function as DDS_KeyedOctetsDataWriter_write_octets_w_key except that it also provides the value for the source_timestamp.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_seq_w_key_w_timestamp (DDS_KeyedOctetsDataWriter *self, const char *key, const struct DDS_OctetSeq *octets, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 Performs the same function as DDS_KeyedOctetsDataWriter_write_octets_seq_w_key except that it also provides the value for the source_timestamp.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_w_params (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, struct DDS_WriteParams_t *params)
 Performs the same function as DDS_KeyedOctetsDataWriter_write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_w_key_w_params (DDS_KeyedOctetsDataWriter *self, const char *key, const unsigned char *octets, int length, struct DDS_WriteParams_t *params)
 Performs the same function as DDS_KeyedOctetsDataWriter_write_octets_w_key except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_seq_w_key_w_params (DDS_KeyedOctetsDataWriter *self, const char *key, const struct DDS_OctetSeq *octets, struct DDS_WriteParams_t *params)
 Performs the same function as DDS_KeyedOctetsDataWriter_write_octets_seq_w_key except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const DDS_InstanceHandle_t *instance_handle)
 Requests the middleware to delete the data.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose_w_key (DDS_KeyedOctetsDataWriter *self, const char *key, const DDS_InstanceHandle_t *instance_handle)
 <<extension>> Requests the middleware to delete the data.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose_w_timestamp (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *instance_data, const DDS_InstanceHandle_t *instance_handle, const struct DDS_Time_t *source_timestamp)
 Performs the same functions as DDS_KeyedOctetsDataWriter_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.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose_w_key_w_timestamp (DDS_KeyedOctetsDataWriter *self, const char *key, const DDS_InstanceHandle_t *instance_handle, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same functions as DDS_KeyedOctetsDataWriter_dispose_w_key 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.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_get_key_value (DDS_KeyedOctetsDataWriter *self, DDS_KeyedOctets *key_holder, const DDS_InstanceHandle_t *handle)
 Retrieve the instance key that corresponds to an instance handle.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_get_key_value_w_key (DDS_KeyedOctetsDataWriter *self, char *key, const DDS_InstanceHandle_t *handle)
 <<extension>> Retrieve the instance key that corresponds to an instance handle.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_lookup_instance (DDS_KeyedOctetsDataWriter *self, const DDS_KeyedOctets *key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_lookup_instance_w_key (DDS_KeyedOctetsDataWriter *self, const char *key)
 <<extension>> Retrieve the instance handle that corresponds to an instance key.
 
DDS_KeyedOctetsDataReaderDDS_KeyedOctetsDataReader_narrow (DDS_DataReader *reader)
 Narrow the given DDS_DataReader pointer to a DDS_KeyedOctetsDataReader pointer.
 
DDS_DataReaderDDS_KeyedOctetsDataReader_as_datareader (DDS_KeyedOctetsDataReader *reader)
 Widen the given DDS_KeyedOctetsDataReader pointer to a DDS_DataReader pointer.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
 Access a collection of data samples from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, DDS_SampleStateMask sample_mask, DDS_ViewStateMask view_mask, DDS_InstanceStateMask instance_mask)
 Access a collection of data-samples from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_w_condition (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedOctetsDataReader_read the samples that match the criteria specified in the DDS_ReadCondition.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_w_condition (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, DDS_ReadCondition *condition)
 Analogous to DDS_KeyedOctetsDataReader_read_w_condition except it accesses samples via the DDS_KeyedOctetsDataReader_take operation.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_next_sample (DDS_KeyedOctetsDataReader *self, DDS_KeyedOctets *received_data, struct DDS_SampleInfo *sample_info)
 Copies the next not-previously-accessed data value from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_next_sample (DDS_KeyedOctetsDataReader *self, DDS_KeyedOctets *received_data, struct DDS_SampleInfo *sample_info)
 Copies the next not-previously-accessed data value from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_instance (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *a_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
 Access a collection of data samples from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_instance (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *a_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
 Access a collection of data samples from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_instance_w_condition (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *a_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedOctetsDataReader_read_instance the samples that match the criteria specified in the DDS_ReadCondition.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_instance_w_condition (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *a_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedOctetsDataReader_take_instance the samples that match the criteria specified in the DDS_ReadCondition.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_next_instance (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *previous_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
 Access a collection of data samples from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_next_instance (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *previous_handle, DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
 Access a collection of data samples from the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_next_instance_w_condition (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *previous_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedOctetsDataReader_read_next_instance the samples that match the criteria specified in the DDS_ReadCondition.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_next_instance_w_condition (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *previous_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedOctetsDataReader_take_next_instance the samples that match the criteria specified in the DDS_ReadCondition.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_return_loan (DDS_KeyedOctetsDataReader *self, struct DDS_KeyedOctetsSeq *received_data, struct DDS_SampleInfoSeq *info_seq)
 Indicates to the DDS_DataReader that the application is done accessing the collection of received_data and info_seq obtained by some earlier invocation of read or take on the DDS_DataReader.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_get_key_value (DDS_KeyedOctetsDataReader *self, DDS_KeyedOctets *key_holder, const DDS_InstanceHandle_t *handle)
 Retrieve the instance key that corresponds to an instance handle.
 
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_get_key_value_w_key (DDS_KeyedOctetsDataReader *self, char *key, const DDS_InstanceHandle_t *handle)
 <<extension>> Retrieve the instance key that corresponds to an instance handle.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataReader_lookup_instance (DDS_KeyedOctetsDataReader *self, const DDS_KeyedOctets *key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder.
 
DDS_InstanceHandle_t DDS_KeyedOctetsDataReader_lookup_instance_w_key (DDS_KeyedOctetsDataReader *self, const char *key)
 <<extension>> Retrieve the instance handle that corresponds to an instance key.
 

Variables

char * DDS_KeyedOctets::key
 Instance key associated with the specified value.
 
int DDS_KeyedOctets::length
 Number of octets to serialize.
 
unsigned char * DDS_KeyedOctets::value
 DDS_Octets array value.
 

Detailed Description

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key.

Typedef Documentation

Built-in type consisting of a variable-length array of opaque bytes and a string that is the key.

<<interface>> Instantiates DataReader < DDS_KeyedOctets >.

When reading or taking data with this reader, if you request a copy of the samples instead of a loan, and a string or byte array in a destination data sample is NULL, the middleware will allocate a new string or array for you of sufficient length to hold the received data. New strings will be allocated with DDS_String_alloc; new arrays will be allocated with DDS_OctetBuffer_alloc. The sample's destructor will delete them.

A non- NULL string or array is assumed to be allocated to sufficient length to store the incoming data. It will not be reallocated.

See Also
FooDataReader
DDS_DataReader

Function Documentation

DDS_KeyedOctets* DDS_KeyedOctets_new ( )

Constructor.

The default constructor initializes the newly created object with NULL key, NULL value, and zero length.

Returns
A new DDS_KeyedOctets or NULL if failure.
DDS_KeyedOctets* DDS_KeyedOctets_new_w_size ( int  key_size,
int  size 
)

Constructor that specifies the allocated sizes.

After this function is called, key is initialized with the empty string and length is set to zero.

Parameters
key_size<<in>> Size of the allocated key (with NULL-terminated character). Cannot be smaller than zero.
size<<in>> Size of the allocated octets array. Cannot be smaller than zero.
Returns
A new DDS_KeyedOctets or NULL if failure.
void DDS_KeyedOctets_delete ( DDS_KeyedOctets self)

Destructor.

DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_register_type ( DDS_DomainParticipant participant,
const char *  type_name 
)

Allows an application to communicate to RTI Connext the existence of the DDS_KeyedOctets data type.

By default, The DDS_KeyedOctets built-in type is automatically registered when a DomainParticipant is created using the type_name returned by DDS_KeyedOctetsTypeSupport_get_type_name. Therefore, the usage of this function is optional and it is only required when the automatic built-in type registration is disabled using the participant property "dds.builtin_type.auto_register".

This function can also be used to register the same DDS_KeyedOctetsTypeSupport with a DDS_DomainParticipant using different values for the type_name.

If register_type is called multiple times with the same DDS_DomainParticipant and type_name, the second (and subsequent) registrations are ignored by the operation.

Parameters
participant<<in>> the DDS_DomainParticipant to register the data type DDS_Octets with. Cannot be NULL.
type_name<<in>> the type name under with the data type DDS_KeyedOctets is registered with the participant; this type name is used when creating a new DDS_Topic. (See DDS_DomainParticipant_create_topic.) The name may not be NULL or longer than 255 characters.
Returns
One of the Standard Return Codes, DDS_RETCODE_PRECONDITION_NOT_MET or DDS_RETCODE_OUT_OF_RESOURCES.
MT Safety:
UNSAFE on the FIRST call. It is not safe for two threads to simultaneously make the first call to register a type. Subsequent calls are thread safe.
See Also
DDS_DomainParticipant_create_topic
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_unregister_type ( DDS_DomainParticipant participant,
const char *  type_name 
)

Allows an application to unregister the DDS_KeyedOctets data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.

Precondition
The DDS_KeyedOctets type with type_name is registered with the participant and all DDS_Topic objects referencing the type have been destroyed. If the type is not registered with the participant, or if any DDS_Topic is associated with the type, the operation will fail with DDS_RETCODE_ERROR.
Postcondition
All information about the type is removed from RTI Connext. No further communication using this type is possible.
Parameters
participant<<in>> the DDS_DomainParticipant to unregister the data type DDS_KeyedOctets from. Cannot be NULL.
type_name<<in>> the type name under with the data type DDS_KeyedOctets is registered with the participant. The name should match a name that has been previously used to register a type with the participant. Cannot be NULL.
Returns
One of the Standard Return Codes, DDS_RETCODE_BAD_PARAMETER or DDS_RETCODE_ERROR
MT Safety:
SAFE.
See Also
DDS_KeyedOctetsTypeSupport_register_type
const char* DDS_KeyedOctetsTypeSupport_get_type_name ( )

Get the default name for the DDS_KeyedOctets type.

Can be used for calling DDS_KeyedOctetsTypeSupport_register_type or creating DDS_Topic.

Returns
default name for the DDS_KeyedOctets type.
See Also
DDS_KeyedOctetsTypeSupport_register_type
DDS_DomainParticipant_create_topic
void DDS_KeyedOctetsTypeSupport_print_data ( const DDS_KeyedOctets a_data)

<<extension>> Print value of data type to standard out.

The generated implementation of the operation knows how to print value of a data type.

Parameters
a_data<<in>> DDS_KeyedOctets to be printed.
DDS_TypeCode* DDS_KeyedOctetsTypeSupport_get_typecode ( )

<<extension>> Retrieves the TypeCode for the Type.

See Also
FooTypeSupport_get_typecode();
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_serialize_data_to_cdr_buffer ( char *  buffer,
unsigned int *  length,
const DDS_KeyedOctets a_data 
)

<<extension>> Serializes the input sample into a CDR buffer of octets.

See Also
FooTypeSupport_serialize_data_to_cdr_buffer
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_serialize_data_to_cdr_buffer_ex ( char *  buffer,
unsigned int *  length,
const DDS_KeyedOctets a_data,
DDS_DataRepresentationId_t  representation 
)

<<extension>> Serializes the input sample into a buffer of octets.

See Also
FooTypeSupport_serialize_data_to_cdr_buffer
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_deserialize_data_from_cdr_buffer ( DDS_KeyedOctets a_data,
const char *  buffer,
unsigned int  length 
)

<<extension>> Deserializes a sample from a buffer of octets.

See Also
FooTypeSupport_deserialize_data_from_cdr_buffer
DDS_ReturnCode_t DDS_KeyedOctetsTypeSupport_data_to_string ( const DDS_KeyedOctets sample,
char *  str,
DDS_UnsignedLong str_size,
DDS_PrintFormatProperty property 
)

<<extension>> Get the string representation of an input sample.

See Also
FooTypeSupport_data_to_string
DDS_KeyedOctetsDataWriter* DDS_KeyedOctetsDataWriter_narrow ( DDS_DataWriter writer)

Narrow the given DDS_DataWriter pointer to a DDS_KeyedOctetsDataWriter pointer.

See Also
FooDataWriter_narrow
DDS_DataWriter* DDS_KeyedOctetsDataWriter_as_datawriter ( DDS_KeyedOctetsDataWriter writer)

Widen the given DDS_KeyedOctetsDataWriter pointer to a DDS_DataWriter pointer.

See Also
FooDataWriter_as_datawriter
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data 
)

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

See Also
FooDataWriter_register_instance
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance_w_key ( DDS_KeyedOctetsDataWriter self,
const char *  key 
)

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

See Also
FooDataWriter_register_instance
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const struct DDS_Time_t source_timestamp 
)

Performs the same functions as DDS_KeyedOctetsDataWriter_register_instance except that the application provides the value for the source_timestamp.

See Also
FooDataWriter_register_instance_w_timestamp
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_register_instance_w_key_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const struct DDS_Time_t source_timestamp 
)

<<extension>> Performs the same functions as DDS_KeyedOctetsDataWriter_register_instance_w_key except that the application provides the value for the source_timestamp.

See Also
FooDataWriter_register_instance_w_timestamp
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle 
)
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance_w_key ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const DDS_InstanceHandle_t handle 
)
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

See Also
FooDataWriter_unregister_instance_w_timestamp
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_unregister_instance_w_key_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

<<extension>> Performs the same function as DDS_KeyedOctetsDataWriter_unregister_instance_w_key except that it also provides the value for the source_timestamp.

See Also
FooDataWriter_unregister_instance_w_timestamp
DDS_KeyedOctets* DDS_KeyedOctetsDataWriter_create_data ( DDS_KeyedOctetsDataWriter self)

Creates a keyed octet sequence.

The size of the instance is determined by the DataWriter property dds.builtin_type.keyed_octets.alloc_size.

Default size: dds.builtin_type.keyed_octets.max_size property of DomainParticipant if defined. Otherwise 2048.

Created instances must be deleted with DDS_KeyedOctetsDataWriter_delete_data.

Returns
Newly created keyed octet sequence, or NULL on failure.
See Also
BuiltinTypeMemoryManagement section of Built-in Types.
DDS_Boolean DDS_KeyedOctetsDataWriter_delete_data ( DDS_KeyedOctetsDataWriter self,
DDS_KeyedOctets sample 
)

Destroys a string data instance created by DDS_StringDataWriter_create_data.

Returns
DDS_BOOLEAN_TRUE upon successful deletion.
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle 
)

Modifies the value of a DDS_KeyedOctets data instance.

See Also
FooDataWriter_write
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_w_key ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const unsigned char *  octets,
int  length,
const DDS_InstanceHandle_t handle 
)

<<extension>> Modifies the value of a DDS_KeyedOctets data instance.

Parameters
self<<in>> Cannot be NULL.
key<<in>> Instance key.
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDS_KeyedOctetsDataWriter_register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter_write.
See Also
FooDataWriter_write
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_seq_w_key ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const struct DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle 
)

<<extension>> Modifies the value of a DDS_KeyedOctets data instance.

Parameters
self<<in>> Cannot be NULL.
key<<in>> Instance key.
octets<<in>> Sequence of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDS_KeyedOctetsDataWriter_register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter_write.
See Also
FooDataWriter_write
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

See Also
FooDataWriter_write_w_timestamp
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_w_key_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const unsigned char *  octets,
int  length,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

Parameters
self<<in>> Cannot be NULL.
key<<in>> Instance key.
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDS_KeyedOctetsDataWriter_register_instance, or else the special value DDS_HANDLE_NIL. See 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 FooDataWriter_write_w_timestamp. Cannot be NULL.
See Also
FooDataWriter_write
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_seq_w_key_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const struct DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

Parameters
self<<in>> Cannot be NULL.
key<<in>> Instance key.
octets<<in>> Sequence of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDS_KeyedOctetsDataWriter_register_instance, or else the special value DDS_HANDLE_NIL. See 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 FooDataWriter_write_w_timestamp. Cannot be NULL.
See Also
FooDataWriter_write
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_w_params ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
struct DDS_WriteParams_t params 
)

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

See Also
FooDataWriter_write_w_params
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_w_key_w_params ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const unsigned char *  octets,
int  length,
struct DDS_WriteParams_t params 
)

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

Parameters
self<<in>> Cannot be NULL.
key<<in>> Instance key.
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
params<<in>> The DDS_WriteParams_t parameter containing the instance handle, source timestamp, publication priority, and cookie to be used in write operation. See FooDataWriter_write_w_params. Cannot be NULL.
See Also
FooDataWriter_write_w_params
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_write_octets_seq_w_key_w_params ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const struct DDS_OctetSeq octets,
struct DDS_WriteParams_t params 
)

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

Parameters
self<<in>> Cannot be NULL.
key<<in>> Instance key.
octets<<in>> Sequence of octets to be published.
params<<in>> The DDS_WriteParams_t parameter containing the instance handle, source timestamp, publication priority, and cookie to be used in write operation. See FooDataWriter_write_w_params. Cannot be NULL.
See Also
FooDataWriter_write_w_params
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t instance_handle 
)

Requests the middleware to delete the data.

See Also
FooDataWriter_dispose
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose_w_key ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const DDS_InstanceHandle_t instance_handle 
)

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

See Also
FooDataWriter_dispose
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t instance_handle,
const struct DDS_Time_t source_timestamp 
)

Performs the same functions as DDS_KeyedOctetsDataWriter_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
FooDataWriter_dispose_w_timestamp
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_dispose_w_key_w_timestamp ( DDS_KeyedOctetsDataWriter self,
const char *  key,
const DDS_InstanceHandle_t instance_handle,
const struct DDS_Time_t source_timestamp 
)

<<extension>> Performs the same functions as DDS_KeyedOctetsDataWriter_dispose_w_key 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
FooDataWriter_dispose_w_timestamp
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_get_key_value ( DDS_KeyedOctetsDataWriter self,
DDS_KeyedOctets key_holder,
const DDS_InstanceHandle_t handle 
)

Retrieve the instance key that corresponds to an instance handle.

See Also
FooDataWriter_get_key_value
DDS_ReturnCode_t DDS_KeyedOctetsDataWriter_get_key_value_w_key ( DDS_KeyedOctetsDataWriter self,
char *  key,
const DDS_InstanceHandle_t handle 
)

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

See Also
FooDataWriter_get_key_value
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_lookup_instance ( DDS_KeyedOctetsDataWriter self,
const DDS_KeyedOctets key_holder 
)

Retrieve the instance handle that corresponds to an instance key_holder.

See Also
FooDataWriter_lookup_instance
DDS_InstanceHandle_t DDS_KeyedOctetsDataWriter_lookup_instance_w_key ( DDS_KeyedOctetsDataWriter self,
const char *  key 
)

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

See Also
FooDataWriter_lookup_instance
DDS_KeyedOctetsDataReader* DDS_KeyedOctetsDataReader_narrow ( DDS_DataReader reader)

Narrow the given DDS_DataReader pointer to a DDS_KeyedOctetsDataReader pointer.

See Also
FooDataReader_narrow
DDS_DataReader* DDS_KeyedOctetsDataReader_as_datareader ( DDS_KeyedOctetsDataReader reader)

Widen the given DDS_KeyedOctetsDataReader pointer to a DDS_DataReader pointer.

See Also
FooDataReader_as_datareader
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
DDS_SampleStateMask  sample_states,
DDS_ViewStateMask  view_states,
DDS_InstanceStateMask  instance_states 
)

Access a collection of data samples from the DDS_DataReader.

See Also
FooDataReader_read
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
DDS_SampleStateMask  sample_mask,
DDS_ViewStateMask  view_mask,
DDS_InstanceStateMask  instance_mask 
)

Access a collection of data-samples from the DDS_DataReader.

See Also
FooDataReader_take
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_w_condition ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
DDS_ReadCondition condition 
)

Accesses via DDS_KeyedOctetsDataReader_read the samples that match the criteria specified in the DDS_ReadCondition.

See Also
FooDataReader_read_w_condition
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_w_condition ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
DDS_ReadCondition condition 
)

Analogous to DDS_KeyedOctetsDataReader_read_w_condition except it accesses samples via the DDS_KeyedOctetsDataReader_take operation.

See Also
FooDataReader_take_w_condition
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_next_sample ( DDS_KeyedOctetsDataReader self,
DDS_KeyedOctets received_data,
struct DDS_SampleInfo sample_info 
)

Copies the next not-previously-accessed data value from the DDS_DataReader.

See Also
FooDataReader_read_next_sample
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_next_sample ( DDS_KeyedOctetsDataReader self,
DDS_KeyedOctets received_data,
struct DDS_SampleInfo sample_info 
)

Copies the next not-previously-accessed data value from the DDS_DataReader.

See Also
FooDataReader_take_next_sample
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_instance ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t a_handle,
DDS_SampleStateMask  sample_states,
DDS_ViewStateMask  view_states,
DDS_InstanceStateMask  instance_states 
)

Access a collection of data samples from the DDS_DataReader.

See Also
FooDataReader_read_instance
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_instance ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t a_handle,
DDS_SampleStateMask  sample_states,
DDS_ViewStateMask  view_states,
DDS_InstanceStateMask  instance_states 
)

Access a collection of data samples from the DDS_DataReader.

See Also
FooDataReader_take_instance
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_instance_w_condition ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t a_handle,
DDS_ReadCondition condition 
)

Accesses via DDS_KeyedOctetsDataReader_read_instance the samples that match the criteria specified in the DDS_ReadCondition.

See Also
FooDataReader_read_instance_w_condition
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_instance_w_condition ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t a_handle,
DDS_ReadCondition condition 
)

Accesses via DDS_KeyedOctetsDataReader_take_instance the samples that match the criteria specified in the DDS_ReadCondition.

See Also
FooDataReader_take_instance_w_condition
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_next_instance ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t previous_handle,
DDS_SampleStateMask  sample_states,
DDS_ViewStateMask  view_states,
DDS_InstanceStateMask  instance_states 
)

Access a collection of data samples from the DDS_DataReader.

See Also
FooDataReader_read_next_instance
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_next_instance ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t previous_handle,
DDS_SampleStateMask  sample_states,
DDS_ViewStateMask  view_states,
DDS_InstanceStateMask  instance_states 
)

Access a collection of data samples from the DDS_DataReader.

See Also
FooDataReader_take_next_instance
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_read_next_instance_w_condition ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t previous_handle,
DDS_ReadCondition condition 
)

Accesses via DDS_KeyedOctetsDataReader_read_next_instance the samples that match the criteria specified in the DDS_ReadCondition.

See Also
FooDataReader_read_next_instance_w_condition
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_take_next_instance_w_condition ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t previous_handle,
DDS_ReadCondition condition 
)

Accesses via DDS_KeyedOctetsDataReader_take_next_instance the samples that match the criteria specified in the DDS_ReadCondition.

See Also
FooDataReader_take_next_instance_w_condition
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_return_loan ( DDS_KeyedOctetsDataReader self,
struct DDS_KeyedOctetsSeq received_data,
struct DDS_SampleInfoSeq info_seq 
)

Indicates to the DDS_DataReader that the application is done accessing the collection of received_data and info_seq obtained by some earlier invocation of read or take on the DDS_DataReader.

See Also
FooDataReader_return_loan
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_get_key_value ( DDS_KeyedOctetsDataReader self,
DDS_KeyedOctets key_holder,
const DDS_InstanceHandle_t handle 
)

Retrieve the instance key that corresponds to an instance handle.

See Also
FooDataReader_get_key_value
DDS_ReturnCode_t DDS_KeyedOctetsDataReader_get_key_value_w_key ( DDS_KeyedOctetsDataReader self,
char *  key,
const DDS_InstanceHandle_t handle 
)

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

See Also
FooDataReader_get_key_value
DDS_InstanceHandle_t DDS_KeyedOctetsDataReader_lookup_instance ( DDS_KeyedOctetsDataReader self,
const DDS_KeyedOctets key_holder 
)

Retrieve the instance handle that corresponds to an instance key_holder.

See Also
FooDataReader_lookup_instance
DDS_InstanceHandle_t DDS_KeyedOctetsDataReader_lookup_instance_w_key ( DDS_KeyedOctetsDataReader self,
const char *  key 
)

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

See Also
FooDataReader_lookup_instance

Variable Documentation

char* DDS_KeyedOctets::key

Instance key associated with the specified value.

int DDS_KeyedOctets::length

Number of octets to serialize.

unsigned char* DDS_KeyedOctets::value

DDS_Octets array value.


RTI Connext C API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc