Structure for data control block. More...

#include <ustream_base.h>

Data Fields
const AZ_USTREAM_INTERFACE *	api

AZ_USTREAM_DATA *	ptr

volatile uint32_t	ref_count

AZ_RELEASE_CALLBACK	data_release

AZ_RELEASE_CALLBACK	control_block_release

Detailed Description

Structure for data control block.

For any given ustream that is created, one control block is created and initialized.

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 392 of file ustream_base.h.

Field Documentation

◆ api

const AZ_USTREAM_INTERFACE* AZ_USTREAM_DATA_CB_TAG::api

The AZ_USTREAM_INTERFACE* for this ustream instance type

Definition at line 394 of file ustream_base.h.

◆ control_block_release

AZ_RELEASE_CALLBACK AZ_USTREAM_DATA_CB_TAG::control_block_release

The AZ_RELEASE_CALLBACK to call to release the AZ_USTREAM_DATA_CB once the ref_count goes to zero

Definition at line 404 of file ustream_base.h.

◆ data_release

AZ_RELEASE_CALLBACK AZ_USTREAM_DATA_CB_TAG::data_release

The AZ_RELEASE_CALLBACK to call to release ptr once the ref_count goes to zero

Definition at line 402 of file ustream_base.h.

◆ ptr

AZ_USTREAM_DATA* AZ_USTREAM_DATA_CB_TAG::ptr

The AZ_USTREAM_DATA* pointing to the data to read. It can be anything that a given ustream implementation needs to access the data, whether it be a memory address to a buffer, another struct with more controls, etc

Definition at line 396 of file ustream_base.h.

◆ ref_count

volatile uint32_t AZ_USTREAM_DATA_CB_TAG::ref_count

The volatile uint32_t with the number of references taken for this memory

Definition at line 400 of file ustream_base.h.

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

inc/ustream_base.h