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]

cdrs

Self

Returns:

The number of bytes between the stream buffer and the current stream pointer.

MT Safety:

This operation is not thread safe.

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]	cdrs	Self
[in]	num	Offset 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.

MT Safety:

This operation is not thread safe.

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]	me	Self
[in]	amount	Number of bytes to increase stream pointer

Returns:

RTI_TRUE on success with stream pointer incremented. RTI_FALSE on failure with stream pointer unchanged.

MT Safety:

This operation is not thread safe.

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]	me	Self
[in]	size	Number of bytes to check whether fits in stream

Returns:

RTI_TRUE if size fits within stream, otherwise RTI_FALSE.

MT Safety:

This operation is not thread safe.

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]

me

Self

Returns:

Pointer to current offset in stream on success, NULL on failure.

MT Safety:

This operation is not thread safe.

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]

me

Self

Returns:

RTI_TRUE if stream is byte-swapped

MT Safety:

This operation is not thread safe.