RTI Connext DDS Micro C API  Version 3.0.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
CDR Stream API

Functions

RTI_UINT32 CDR_Stream_get_current_position_offset (struct CDR_Stream_t *cdrs)
 <<cert>> Return current offset of stream pointer relative to buffer
RTI_BOOL CDR_Stream_set_current_position_offset (struct CDR_Stream_t *cdrs, RTI_UINT32 num)
 <<cert>> Set current offset of stream pointer relative to buffer
RTI_BOOL CDR_Stream_increment_current_position (struct CDR_Stream_t *me, RTI_INT32 amount)
 <<cert>> Increase stream pointer by specified number of bytes
RTI_BOOL CDR_Stream_check_size (struct CDR_Stream_t *me, RTI_UINT32 size)
 <<cert>> Verifies whether remaining space in stream buffer is larger than specified size
char * CDR_Stream_get_current_position_ptr (struct CDR_Stream_t *me)
 <<cert>> Returns a pointer to the current offset in the stream
RTI_BOOL CDR_Stream_is_byte_swapped (struct CDR_Stream_t *me)
 <<cert>> Whether a stream is byte-swapped

Detailed Description

<<eXtension>> <<cert>> CDR Stream


Function Documentation

RTI_UINT32 CDR_Stream_get_current_position_offset ( struct CDR_Stream_t *  cdrs)

<<cert>> Return current offset of stream pointer relative to buffer

Parameters:
[in]cdrsSelf
Returns:
The number of bytes between the stream buffer and the current stream pointer.
RTI_BOOL CDR_Stream_set_current_position_offset ( struct CDR_Stream_t *  cdrs,
RTI_UINT32  num 
)

<<cert>> Set current offset of stream pointer relative to buffer

Parameters:
[in]cdrsSelf
[in]numOffset in bytes to set stream pointer ahead of buffer
Returns:
RTI_TRUE on success with stream pointer updated. Otherwise, RTI_FALSE on failure with stream pointer unchanged.
RTI_BOOL CDR_Stream_increment_current_position ( struct CDR_Stream_t *  me,
RTI_INT32  amount 
)

<<cert>> Increase stream pointer by specified number of bytes

Parameters:
[in]meSelf
[in]amountNumber of bytes to increase stream pointer
Returns:
RTI_TRUE on success with stream pointer incremented. RTI_FALSE on failure with stream pointer unchanged.
RTI_BOOL CDR_Stream_check_size ( struct CDR_Stream_t *  me,
RTI_UINT32  size 
)

<<cert>> Verifies whether remaining space in stream buffer is larger than specified size

Parameters:
[in]meSelf
[in]sizeNumber of bytes to check whether fits in stream
Returns:
RTI_TRUE if size fits within stream, otherwise RTI_FALSE.
char* CDR_Stream_get_current_position_ptr ( struct CDR_Stream_t *  me)

<<cert>> Returns a pointer to the current offset in the stream

Parameters:
[in]meSelf
Returns:
Pointer to current offset in stream on success, NULL on failure.
RTI_BOOL CDR_Stream_is_byte_swapped ( struct CDR_Stream_t *  me)

<<cert>> Whether a stream is byte-swapped

This function verifies whether a stream is set to serialize or deserialize in byte-swapped order, relative to its host endianess.

Parameters:
[in]meSelf
Returns:
RTI_TRUE if stream is byte-swapped

RTI Connext DDS Micro C API Version 3.0.3 Copyright © Wed Jun 24 2020 Real-Time Innovations, Inc