RTI Connext C API Version 7.3.0

Built-in type consisting of a string payload and a second string that is the key. More...

Data Structures

struct  DDS_KeyedString
 Keyed string built-in type. More...
 
struct  DDS_KeyedStringSeq
 Instantiates FooSeq < DDS_KeyedString > . More...
 
struct  DDS_KeyedStringTypeSupport
 <<interface>> Keyed string type support. More...
 

Typedefs

typedef struct DDS_KeyedString DDS_KeyedString
 Keyed string built-in type. More...
 
typedef struct DDS_KeyedStringDataWriter DDS_KeyedStringDataWriter
 <<interface>> Instantiates DataWriter < DDS_KeyedString >. More...
 
typedef struct DDS_KeyedStringDataReader DDS_KeyedStringDataReader
 <<interface>> Instantiates DataReader < DDS_KeyedString >. More...
 

Functions

DDS_KeyedStringDDS_KeyedString_new (void)
 Constructor. More...
 
DDS_KeyedStringDDS_KeyedString_new_w_size (int key_size, int size)
 Constructor that specifies the allocated sizes. More...
 
void DDS_KeyedString_delete (DDS_KeyedString *self)
 Destructor. More...
 
DDS_ReturnCode_t DDS_KeyedStringTypeSupport_register_type (DDS_DomainParticipant *participant, const char *type_name)
 Allows an application to communicate to RTI Connext the existence of the DDS_KeyedString data type. More...
 
DDS_ReturnCode_t DDS_KeyedStringTypeSupport_unregister_type (DDS_DomainParticipant *participant, const char *type_name)
 Allows an application to unregister the DDS_KeyedString data type from RTI Connext. After calling unregister_type, no further communication using this type is possible. More...
 
const char * DDS_KeyedStringTypeSupport_get_type_name (void)
 Get the default name for the DDS_KeyedString type. More...
 
void DDS_KeyedStringTypeSupport_print_data (const DDS_KeyedString *a_data)
 <<extension>> Print value of data type to standard out. More...
 
DDS_TypeCodeDDS_KeyedStringTypeSupport_get_typecode (void)
 <<extension>> Retrieves the TypeCode for the Type. More...
 
DDS_ReturnCode_t DDS_KeyedStringTypeSupport_serialize_data_to_cdr_buffer (char *buffer, unsigned int *length, const DDS_KeyedString *a_data)
 <<extension>> Serializes the input sample into a CDR buffer of octets. More...
 
DDS_ReturnCode_t DDS_KeyedStringTypeSupport_serialize_data_to_cdr_buffer_ex (char *buffer, unsigned int *length, const DDS_KeyedString *a_data, DDS_DataRepresentationId_t representation)
 <<extension>> Serializes the input sample into a buffer of octets. More...
 
DDS_ReturnCode_t DDS_KeyedStringTypeSupport_deserialize_data_from_cdr_buffer (DDS_KeyedString *a_data, const char *buffer, unsigned int length)
 <<extension>> Deserializes a sample from a buffer of octets. More...
 
DDS_ReturnCode_t DDS_KeyedStringTypeSupport_data_to_string (const DDS_KeyedString *sample, char *str, DDS_UnsignedLong *str_size, DDS_PrintFormatProperty *property)
 <<extension>> Get the string representation of an input sample. More...
 
DDS_KeyedStringDataWriterDDS_KeyedStringDataWriter_narrow (DDS_DataWriter *writer)
 Narrow the given DDS_DataWriter pointer to a DDS_KeyedStringDataWriter pointer. More...
 
DDS_DataWriterDDS_KeyedStringDataWriter_as_datawriter (DDS_KeyedStringDataWriter *writer)
 Widen the given DDS_KeyedStringDataWriter pointer to a DDS_DataWriter pointer. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data)
 Informs RTI Connext that the application will be modifying a particular instance. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance_w_key (DDS_KeyedStringDataWriter *self, const char *key)
 <<extension>> Informs RTI Connext that the application will be modifying a particular instance. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance_w_timestamp (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const struct DDS_Time_t *source_timestamp)
 Performs the same functions as DDS_KeyedStringDataWriter_register_instance except that the application provides the value for the source_timestamp. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance_w_key_w_timestamp (DDS_KeyedStringDataWriter *self, const char *key, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same functions as DDS_KeyedStringDataWriter_register_instance_w_key except that the application provides the value for the source_timestamp. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const DDS_InstanceHandle_t *handle)
 Reverses the action of DDS_KeyedStringDataWriter_register_instance. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance_w_key (DDS_KeyedStringDataWriter *self, const char *key, const DDS_InstanceHandle_t *handle)
 <<extension>> Reverses the action of DDS_KeyedStringDataWriter_register_instance_w_key. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance_w_timestamp (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 Performs the same function as DDS_KeyedStringDataWriter_unregister_instance except that it also provides the value for the source_timestamp. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance_w_key_w_timestamp (DDS_KeyedStringDataWriter *self, const char *key, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same function as DDS_KeyedStringDataWriter_unregister_instance_w_key except that it also provides the value for the source_timestamp. More...
 
DDS_KeyedStringDDS_KeyedStringDataWriter_create_data (DDS_KeyedStringDataWriter *self)
 Creates a keyed string data instance. More...
 
DDS_Boolean DDS_KeyedStringDataWriter_delete_data (DDS_KeyedStringDataWriter *self, DDS_KeyedString *sample)
 Destroys a keyed string data instance created by DDS_KeyedStringDataWriter_create_data. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_write (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const DDS_InstanceHandle_t *handle)
 Modifies the value of a DDS_KeyedString data instance. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_string_w_key (DDS_KeyedStringDataWriter *self, const char *key, const char *str, const DDS_InstanceHandle_t *handle)
 <<extension>> Modifies the value of a DDS_KeyedString data instance. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_w_timestamp (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 Performs the same function as DDS_KeyedStringDataWriter_write except that it also provides the value for the source_timestamp. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_string_w_key_w_timestamp (DDS_KeyedStringDataWriter *self, const char *key, const char *str, const DDS_InstanceHandle_t *handle, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same function as DDS_KeyedStringDataWriter_write_string_w_key except that it also provides the value for the source_timestamp. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_w_params (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, struct DDS_WriteParams_t *params)
 Performs the same function as DDS_KeyedStringDataWriter_write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_string_w_key_w_params (DDS_KeyedStringDataWriter *self, const char *key, const char *str, struct DDS_WriteParams_t *params)
 <<extension>> Performs the same function as DDS_KeyedStringDataWriter_write_string_w_key except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const DDS_InstanceHandle_t *instance_handle)
 Requests the middleware to delete the data. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose_w_key (DDS_KeyedStringDataWriter *self, const char *key, const DDS_InstanceHandle_t *instance_handle)
 <<extension>> Requests the middleware to delete the data. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose_w_timestamp (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *instance_data, const DDS_InstanceHandle_t *instance_handle, const struct DDS_Time_t *source_timestamp)
 Performs the same functions as DDS_KeyedStringDataWriter_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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose_w_key_w_timestamp (DDS_KeyedStringDataWriter *self, const char *key, const DDS_InstanceHandle_t *instance_handle, const struct DDS_Time_t *source_timestamp)
 <<extension>> Performs the same functions as DDS_KeyedStringDataWriter_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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_get_key_value (DDS_KeyedStringDataWriter *self, DDS_KeyedString *key_holder, const DDS_InstanceHandle_t *handle)
 Retrieve the instance key that corresponds to an instance handle. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataWriter_get_key_value_w_key (DDS_KeyedStringDataWriter *self, char *key, const DDS_InstanceHandle_t *handle)
 <<extension>> Retrieve the instance key that corresponds to an instance handle. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataWriter_lookup_instance (DDS_KeyedStringDataWriter *self, const DDS_KeyedString *key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataWriter_lookup_instance_w_key (DDS_KeyedStringDataWriter *self, const char *key)
 <<extension>> Retrieve the instance handle that corresponds to an instance key. More...
 
DDS_KeyedStringDataReaderDDS_KeyedStringDataReader_narrow (DDS_DataReader *reader)
 Narrow the given DDS_DataReader pointer to a DDS_KeyedStringDataReader pointer. More...
 
DDS_DataReaderDDS_KeyedStringDataReader_as_datareader (DDS_KeyedStringDataReader *reader)
 Widen the given DDS_KeyedStringDataReader pointer to a DDS_DataReader pointer. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read_w_condition (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedStringDataReader_read the samples that match the criteria specified in the DDS_ReadCondition. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take_w_condition (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, DDS_ReadCondition *condition)
 Analogous to DDS_KeyedStringDataReader_read_w_condition except it accesses samples via the DDS_KeyedStringDataReader_take operation. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read_next_sample (DDS_KeyedStringDataReader *self, DDS_KeyedString *received_data, struct DDS_SampleInfo *sample_info)
 Copies the next not-previously-accessed data value from the DDS_DataReader. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take_next_sample (DDS_KeyedStringDataReader *self, DDS_KeyedString *received_data, struct DDS_SampleInfo *sample_info)
 Copies the next not-previously-accessed data value from the DDS_DataReader. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read_instance (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take_instance (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read_instance_w_condition (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *a_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedStringDataReader_read_instance the samples that match the criteria specified in the DDS_ReadCondition. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take_instance_w_condition (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *a_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedStringDataReader_take_instance the samples that match the criteria specified in the DDS_ReadCondition. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read_next_instance (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take_next_instance (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_read_next_instance_w_condition (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *previous_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedStringDataReader_read_next_instance the samples that match the criteria specified in the DDS_ReadCondition. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_take_next_instance_w_condition (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *received_data, struct DDS_SampleInfoSeq *info_seq, DDS_Long max_samples, const DDS_InstanceHandle_t *previous_handle, DDS_ReadCondition *condition)
 Accesses via DDS_KeyedStringDataReader_take_next_instance the samples that match the criteria specified in the DDS_ReadCondition. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_return_loan (DDS_KeyedStringDataReader *self, struct DDS_KeyedStringSeq *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. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_get_key_value (DDS_KeyedStringDataReader *self, DDS_KeyedString *key_holder, const DDS_InstanceHandle_t *handle)
 Retrieve the instance key that corresponds to an instance handle. More...
 
DDS_ReturnCode_t DDS_KeyedStringDataReader_get_key_value_w_key (DDS_KeyedStringDataReader *self, char *key, const DDS_InstanceHandle_t *handle)
 <<extension>> Retrieve the instance key that corresponds to an instance handle. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataReader_lookup_instance (DDS_KeyedStringDataReader *self, const DDS_KeyedString *key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder. More...
 
DDS_InstanceHandle_t DDS_KeyedStringDataReader_lookup_instance_w_key (DDS_KeyedStringDataReader *self, const char *key)
 <<extension>> Retrieve the instance handle that corresponds to an instance key. More...
 

Variables

char * DDS_KeyedString::key
 Instance key associated with the specified value. More...
 
char * DDS_KeyedString::value
 String value. More...
 

Detailed Description

Built-in type consisting of a string payload and a second string that is the key.

Typedef Documentation

◆ DDS_KeyedString

Keyed string built-in type.

◆ DDS_KeyedStringDataWriter

◆ DDS_KeyedStringDataReader

<<interface>> Instantiates DataReader < DDS_KeyedString >.

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

A non- NULL string 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_KeyedString_new()

DDS_KeyedString * DDS_KeyedString_new ( void  )

Constructor.

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

Returns
A new DDS_KeyedString or NULL if failure.

◆ DDS_KeyedString_new_w_size()

DDS_KeyedString * DDS_KeyedString_new_w_size ( int  key_size,
int  size 
)

Constructor that specifies the allocated sizes.

The allocated strings are initialized to empty ("").

Parameters
key_size<<in>> Size of the allocated key string (with NULL-terminated character). Cannot be smaller than zero.
size<<in>> Size of the allocated value string (with NULL-terminated character). Cannot be smaller than zero.
Returns
A new DDS_KeyedString or NULL if failure.

◆ DDS_KeyedString_delete()

void DDS_KeyedString_delete ( DDS_KeyedString self)

Destructor.

◆ DDS_KeyedStringTypeSupport_register_type()

DDS_ReturnCode_t DDS_KeyedStringTypeSupport_register_type ( DDS_DomainParticipant participant,
const char *  type_name 
)

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

By default, The DDS_KeyedString built-in type is automatically registered when a DomainParticipant is created using the type_name returned by DDS_KeyedStringTypeSupport_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_KeyedStringTypeSupport 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_KeyedString with. Cannot be NULL.
type_name<<in>> the type name under with the data type DDS_KeyedString 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_KeyedStringTypeSupport_unregister_type()

DDS_ReturnCode_t DDS_KeyedStringTypeSupport_unregister_type ( DDS_DomainParticipant participant,
const char *  type_name 
)

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

Precondition
The DDS_KeyedString 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_KeyedString from. Cannot be NULL.
type_name<<in>> the type name under with the data type DDS_KeyedString 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_KeyedStringTypeSupport_register_type

◆ DDS_KeyedStringTypeSupport_get_type_name()

const char * DDS_KeyedStringTypeSupport_get_type_name ( void  )

Get the default name for the DDS_KeyedString type.

Can be used for calling DDS_KeyedStringTypeSupport_register_type or creating DDS_Topic.

Returns
default name for the DDS_KeyedString type.
See also
DDS_KeyedStringTypeSupport_register_type
DDS_DomainParticipant_create_topic

◆ DDS_KeyedStringTypeSupport_print_data()

void DDS_KeyedStringTypeSupport_print_data ( const DDS_KeyedString 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_KeyedString to be printed.

◆ DDS_KeyedStringTypeSupport_get_typecode()

DDS_TypeCode * DDS_KeyedStringTypeSupport_get_typecode ( void  )

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

See also
FooTypeSupport_get_typecode

◆ DDS_KeyedStringTypeSupport_serialize_data_to_cdr_buffer()

DDS_ReturnCode_t DDS_KeyedStringTypeSupport_serialize_data_to_cdr_buffer ( char *  buffer,
unsigned int *  length,
const DDS_KeyedString a_data 
)

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

See also
FooTypeSupport_serialize_data_to_cdr_buffer

◆ DDS_KeyedStringTypeSupport_serialize_data_to_cdr_buffer_ex()

DDS_ReturnCode_t DDS_KeyedStringTypeSupport_serialize_data_to_cdr_buffer_ex ( char *  buffer,
unsigned int *  length,
const DDS_KeyedString 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_KeyedStringTypeSupport_deserialize_data_from_cdr_buffer()

DDS_ReturnCode_t DDS_KeyedStringTypeSupport_deserialize_data_from_cdr_buffer ( DDS_KeyedString 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_KeyedStringTypeSupport_data_to_string()

DDS_ReturnCode_t DDS_KeyedStringTypeSupport_data_to_string ( const DDS_KeyedString 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_KeyedStringDataWriter_narrow()

DDS_KeyedStringDataWriter * DDS_KeyedStringDataWriter_narrow ( DDS_DataWriter writer)

Narrow the given DDS_DataWriter pointer to a DDS_KeyedStringDataWriter pointer.

See also
FooDataWriter_narrow

◆ DDS_KeyedStringDataWriter_as_datawriter()

DDS_DataWriter * DDS_KeyedStringDataWriter_as_datawriter ( DDS_KeyedStringDataWriter writer)

Widen the given DDS_KeyedStringDataWriter pointer to a DDS_DataWriter pointer.

See also
FooDataWriter_as_datawriter

◆ DDS_KeyedStringDataWriter_register_instance()

DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data 
)

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

See also
FooDataWriter_register_instance

◆ DDS_KeyedStringDataWriter_register_instance_w_key()

DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance_w_key ( DDS_KeyedStringDataWriter self,
const char *  key 
)

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

See also
FooDataWriter_register_instance

◆ DDS_KeyedStringDataWriter_register_instance_w_timestamp()

DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance_w_timestamp ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const struct DDS_Time_t source_timestamp 
)

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

See also
FooDataWriter_register_instance_w_timestamp

◆ DDS_KeyedStringDataWriter_register_instance_w_key_w_timestamp()

DDS_InstanceHandle_t DDS_KeyedStringDataWriter_register_instance_w_key_w_timestamp ( DDS_KeyedStringDataWriter self,
const char *  key,
const struct DDS_Time_t source_timestamp 
)

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

See also
FooDataWriter_register_instance_w_timestamp

◆ DDS_KeyedStringDataWriter_unregister_instance()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const DDS_InstanceHandle_t handle 
)

◆ DDS_KeyedStringDataWriter_unregister_instance_w_key()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance_w_key ( DDS_KeyedStringDataWriter self,
const char *  key,
const DDS_InstanceHandle_t handle 
)

◆ DDS_KeyedStringDataWriter_unregister_instance_w_timestamp()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance_w_timestamp ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

See also
FooDataWriter_unregister_instance_w_timestamp

◆ DDS_KeyedStringDataWriter_unregister_instance_w_key_w_timestamp()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_unregister_instance_w_key_w_timestamp ( DDS_KeyedStringDataWriter self,
const char *  key,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

See also
FooDataWriter_unregister_instance_w_timestamp

◆ DDS_KeyedStringDataWriter_create_data()

DDS_KeyedString * DDS_KeyedStringDataWriter_create_data ( DDS_KeyedStringDataWriter self)

Creates a keyed string data instance.

The size of the instance including the NULL terminated character is determined by the DataWriter property dds.builtin_type.keyed_string.alloc_size.

Default size: dds.builtin_type.keyed_string.max_size property of DomainParticipant if defined. Otherwise 1024.

Created instances must be deleted with DDS_KeyedStringDataWriter_delete_data.

Returns
Newly created keyed string data, or NULL on failure.
See also
BuiltinTypeMemoryManagement section of Built-in Types

◆ DDS_KeyedStringDataWriter_delete_data()

DDS_Boolean DDS_KeyedStringDataWriter_delete_data ( DDS_KeyedStringDataWriter self,
DDS_KeyedString sample 
)

Destroys a keyed string data instance created by DDS_KeyedStringDataWriter_create_data.

Returns
DDS_BOOLEAN_TRUE upon successful deletion.

◆ DDS_KeyedStringDataWriter_write()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_write ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const DDS_InstanceHandle_t handle 
)

Modifies the value of a DDS_KeyedString data instance.

See also
FooDataWriter_write

◆ DDS_KeyedStringDataWriter_write_string_w_key()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_string_w_key ( DDS_KeyedStringDataWriter self,
const char *  key,
const char *  str,
const DDS_InstanceHandle_t handle 
)

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

See also
FooDataWriter_write

◆ DDS_KeyedStringDataWriter_write_w_timestamp()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_w_timestamp ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

See also
FooDataWriter_write_w_timestamp

◆ DDS_KeyedStringDataWriter_write_string_w_key_w_timestamp()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_string_w_key_w_timestamp ( DDS_KeyedStringDataWriter self,
const char *  key,
const char *  str,
const DDS_InstanceHandle_t handle,
const struct DDS_Time_t source_timestamp 
)

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

See also
FooDataWriter_write_w_timestamp

◆ DDS_KeyedStringDataWriter_write_w_params()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_w_params ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
struct DDS_WriteParams_t params 
)

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

See also
FooDataWriter_write_w_params

◆ DDS_KeyedStringDataWriter_write_string_w_key_w_params()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_write_string_w_key_w_params ( DDS_KeyedStringDataWriter self,
const char *  key,
const char *  str,
struct DDS_WriteParams_t params 
)

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

See also
FooDataWriter_write_w_params

◆ DDS_KeyedStringDataWriter_dispose()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const DDS_InstanceHandle_t instance_handle 
)

Requests the middleware to delete the data.

See also
FooDataWriter_dispose

◆ DDS_KeyedStringDataWriter_dispose_w_key()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose_w_key ( DDS_KeyedStringDataWriter self,
const char *  key,
const DDS_InstanceHandle_t instance_handle 
)

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

See also
FooDataWriter_dispose

◆ DDS_KeyedStringDataWriter_dispose_w_timestamp()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose_w_timestamp ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString instance_data,
const DDS_InstanceHandle_t instance_handle,
const struct DDS_Time_t source_timestamp 
)

Performs the same functions as DDS_KeyedStringDataWriter_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_KeyedStringDataWriter_dispose_w_key_w_timestamp()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_dispose_w_key_w_timestamp ( DDS_KeyedStringDataWriter self,
const char *  key,
const DDS_InstanceHandle_t instance_handle,
const struct DDS_Time_t source_timestamp 
)

<<extension>> Performs the same functions as DDS_KeyedStringDataWriter_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_KeyedStringDataWriter_get_key_value()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_get_key_value ( DDS_KeyedStringDataWriter self,
DDS_KeyedString key_holder,
const DDS_InstanceHandle_t handle 
)

Retrieve the instance key that corresponds to an instance handle.

See also
FooDataWriter_get_key_value

◆ DDS_KeyedStringDataWriter_get_key_value_w_key()

DDS_ReturnCode_t DDS_KeyedStringDataWriter_get_key_value_w_key ( DDS_KeyedStringDataWriter 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_KeyedStringDataWriter_lookup_instance()

DDS_InstanceHandle_t DDS_KeyedStringDataWriter_lookup_instance ( DDS_KeyedStringDataWriter self,
const DDS_KeyedString key_holder 
)

Retrieve the instance handle that corresponds to an instance key_holder.

See also
FooDataWriter_lookup_instance

◆ DDS_KeyedStringDataWriter_lookup_instance_w_key()

DDS_InstanceHandle_t DDS_KeyedStringDataWriter_lookup_instance_w_key ( DDS_KeyedStringDataWriter self,
const char *  key 
)

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

See also
FooDataWriter_lookup_instance

◆ DDS_KeyedStringDataReader_narrow()

DDS_KeyedStringDataReader * DDS_KeyedStringDataReader_narrow ( DDS_DataReader reader)

Narrow the given DDS_DataReader pointer to a DDS_KeyedStringDataReader pointer.

See also
FooDataReader_narrow

◆ DDS_KeyedStringDataReader_as_datareader()

DDS_DataReader * DDS_KeyedStringDataReader_as_datareader ( DDS_KeyedStringDataReader reader)

Widen the given DDS_KeyedStringDataReader pointer to a DDS_DataReader pointer.

See also
FooDataReader_as_datareader

◆ DDS_KeyedStringDataReader_read()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_take()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_read_w_condition()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read_w_condition ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
DDS_ReadCondition condition 
)

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

See also
FooDataReader_read_w_condition

◆ DDS_KeyedStringDataReader_take_w_condition()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take_w_condition ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
DDS_ReadCondition condition 
)

Analogous to DDS_KeyedStringDataReader_read_w_condition except it accesses samples via the DDS_KeyedStringDataReader_take operation.

See also
FooDataReader_take_w_condition

◆ DDS_KeyedStringDataReader_read_next_sample()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read_next_sample ( DDS_KeyedStringDataReader self,
DDS_KeyedString 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_KeyedStringDataReader_take_next_sample()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take_next_sample ( DDS_KeyedStringDataReader self,
DDS_KeyedString 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_KeyedStringDataReader_read_instance()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read_instance ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_take_instance()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take_instance ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_read_instance_w_condition()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read_instance_w_condition ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t a_handle,
DDS_ReadCondition condition 
)

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

See also
FooDataReader_read_instance_w_condition

◆ DDS_KeyedStringDataReader_take_instance_w_condition()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take_instance_w_condition ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t a_handle,
DDS_ReadCondition condition 
)

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

See also
FooDataReader_take_instance_w_condition

◆ DDS_KeyedStringDataReader_read_next_instance()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read_next_instance ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_take_next_instance()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take_next_instance ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_read_next_instance_w_condition()

DDS_ReturnCode_t DDS_KeyedStringDataReader_read_next_instance_w_condition ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t previous_handle,
DDS_ReadCondition condition 
)

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

See also
FooDataReader_read_next_instance_w_condition

◆ DDS_KeyedStringDataReader_take_next_instance_w_condition()

DDS_ReturnCode_t DDS_KeyedStringDataReader_take_next_instance_w_condition ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq received_data,
struct DDS_SampleInfoSeq info_seq,
DDS_Long  max_samples,
const DDS_InstanceHandle_t previous_handle,
DDS_ReadCondition condition 
)

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

See also
FooDataReader_take_next_instance_w_condition

◆ DDS_KeyedStringDataReader_return_loan()

DDS_ReturnCode_t DDS_KeyedStringDataReader_return_loan ( DDS_KeyedStringDataReader self,
struct DDS_KeyedStringSeq 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_KeyedStringDataReader_get_key_value()

DDS_ReturnCode_t DDS_KeyedStringDataReader_get_key_value ( DDS_KeyedStringDataReader self,
DDS_KeyedString key_holder,
const DDS_InstanceHandle_t handle 
)

Retrieve the instance key that corresponds to an instance handle.

See also
FooDataReader_get_key_value

◆ DDS_KeyedStringDataReader_get_key_value_w_key()

DDS_ReturnCode_t DDS_KeyedStringDataReader_get_key_value_w_key ( DDS_KeyedStringDataReader 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_KeyedStringDataReader_lookup_instance()

DDS_InstanceHandle_t DDS_KeyedStringDataReader_lookup_instance ( DDS_KeyedStringDataReader self,
const DDS_KeyedString key_holder 
)

Retrieve the instance handle that corresponds to an instance key_holder.

See also
FooDataReader_lookup_instance

◆ DDS_KeyedStringDataReader_lookup_instance_w_key()

DDS_InstanceHandle_t DDS_KeyedStringDataReader_lookup_instance_w_key ( DDS_KeyedStringDataReader self,
const char *  key 
)

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

See also
FooDataReader_lookup_instance

Variable Documentation

◆ key

char* DDS_KeyedString::key

Instance key associated with the specified value.

◆ value

char* DDS_KeyedString::value

String value.