DDS_KeyedOctets Struct Reference
[KeyedOctets Built-in Type]

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

List of all members.

Public Member Functions

 DDS_KeyedOctets ()
 Constructor.
 DDS_KeyedOctets (int key_size, int size)
 Constructor that specifies the allocated sizes.
 ~DDS_KeyedOctets ()
 Destructor.

Public Attributes

char * key
 Instance key associated with the specified value.
int length
 Number of octets to serialize.
unsigned char * 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.

Constructor & Destructor Documentation

DDS_KeyedOctets::DDS_KeyedOctets (  )  [inline]

Constructor.

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

DDS_KeyedOctets::DDS_KeyedOctets ( int  key_size,
int  size 
) [inline]

Constructor that specifies the allocated sizes.

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

If a memory allocation failure occurs, and the DDS_KeyedOctets structure is allocated but the array and/or key string inside of it cannot be, the unallocated member will be NULL.

Parameters:
key_size <<in>> Size of the allocated key (with NULL-terminated character).
size <<in>> Size of the allocated octets array.

DDS_KeyedOctets::~DDS_KeyedOctets (  )  [inline]

Destructor.


Member Data Documentation

Instance key associated with the specified value.

Number of octets to serialize.

unsigned char* DDS_KeyedOctets::value

DDS_Octets array value.


RTI Data Distribution Service C++ API Version 4.5e Copyright © 23 Oct 2011 Real-Time Innovations, Inc