Structure to keep track of concatenated ustreams. More...

#include <ustream_base.h>

Data Fields
AZ_USTREAM_DATA_CB	control_block

AZ_USTREAM	ustream_one

AZ_USTREAM	ustream_two

volatile uint32_t	ustream_one_ref_count

volatile uint32_t	ustream_two_ref_count

AZ_PAL_OS_LOCK	lock

Detailed Description

Structure to keep track of concatenated ustreams.

When concatenating a ustream to another ustream, the instances are placed into a AZ_USTREAM_MULTI_DATA_CB. The base ustream onto which you wish to concatenate will be copied into the ustream_one structure and the ustream to concatenate will be cloned into the ustream_two structure. The difference being that the first AZ_USTREAM*, when returned, will point to the newly populated multi instance and the ownership of the passed instance will be assumed by the multi instance. The second ustream which was passed will not be changed, only cloned into the AZ_USTREAM_MULTI_DATA_CB structure.

Note: This structure should be viewed and used as internal to the implementation of the ustream. Users should therefore not act on it directly and only allocate the memory necessary for it to be passed to the ustream.

Definition at line 447 of file ustream_base.h.

Field Documentation

◆ control_block

AZ_USTREAM_DATA_CB AZ_USTREAM_MULTI_DATA_CB_TAG::control_block

The AZ_USTREAM_DATA_CB to manage the multi data structure

Definition at line 449 of file ustream_base.h.

◆ lock

AZ_PAL_OS_LOCK AZ_USTREAM_MULTI_DATA_CB_TAG::lock

The AZ_PAL_OS_LOCK with controls the critical section of the read from the multi ustream

Definition at line 454 of file ustream_base.h.

◆ ustream_one

AZ_USTREAM AZ_USTREAM_MULTI_DATA_CB_TAG::ustream_one

The AZ_USTREAM with the first ustream instance

Definition at line 450 of file ustream_base.h.

◆ ustream_one_ref_count

volatile uint32_t AZ_USTREAM_MULTI_DATA_CB_TAG::ustream_one_ref_count

The uint32_t with the number of references to the first ustream

Definition at line 452 of file ustream_base.h.

◆ ustream_two

AZ_USTREAM AZ_USTREAM_MULTI_DATA_CB_TAG::ustream_two

The AZ_USTREAM with the second ustream instance

Definition at line 451 of file ustream_base.h.

◆ ustream_two_ref_count

volatile uint32_t AZ_USTREAM_MULTI_DATA_CB_TAG::ustream_two_ref_count

The uint32_t with the number of references to the second ustream

Definition at line 453 of file ustream_base.h.

The documentation for this struct was generated from the following file:

inc/ustream_base.h

Data Fields