Overview

Macros
#define	PW_VARIABLE_LENGTH_ENTRY_QUEUE_DECLARE(variable, max_size_bytes)

Typedefs
typedef uint32_t *	pw_InlineVarLenEntryQueue_Handle

typedef const uint32_t *	pw_InlineVarLenEntryQueue_ConstHandle

Functions
void	pw_InlineVarLenEntryQueue_Init (uint32_t array[], size_t array_size_uint32)

pw_InlineVarLenEntryQueue_Iterator	pw_InlineVarLenEntryQueue_Begin (pw_InlineVarLenEntryQueue_Handle queue)

pw_InlineVarLenEntryQueue_ConstIterator	pw_InlineVarLenEntryQueue_ConstBegin (pw_InlineVarLenEntryQueue_ConstHandle queue)

pw_InlineVarLenEntryQueue_Iterator	pw_InlineVarLenEntryQueue_End (pw_InlineVarLenEntryQueue_Handle queue)

pw_InlineVarLenEntryQueue_ConstIterator	pw_InlineVarLenEntryQueue_ConstEnd (pw_InlineVarLenEntryQueue_ConstHandle queue)

bool	pw_InlineVarLenEntryQueue_Empty (pw_InlineVarLenEntryQueue_ConstHandle queue)

uint32_t	pw_InlineVarLenEntryQueue_Size (pw_InlineVarLenEntryQueue_ConstHandle queue)

uint32_t	pw_InlineVarLenEntryQueue_MaxSize (pw_InlineVarLenEntryQueue_ConstHandle queue)

uint32_t	pw_InlineVarLenEntryQueue_SizeBytes (pw_InlineVarLenEntryQueue_ConstHandle queue)

uint32_t	pw_InlineVarLenEntryQueue_MaxSizeBytes (pw_InlineVarLenEntryQueue_ConstHandle queue)

void	pw_InlineVarLenEntryQueue_Push (pw_InlineVarLenEntryQueue_Handle queue, const void *data, uint32_t data_size_bytes)

bool	pw_InlineVarLenEntryQueue_TryPush (pw_InlineVarLenEntryQueue_Handle queue, const void *data, const uint32_t data_size_bytes)

void	pw_InlineVarLenEntryQueue_PushOverwrite (pw_InlineVarLenEntryQueue_Handle queue, const void *data, uint32_t data_size_bytes)

void	pw_InlineVarLenEntryQueue_Pop (pw_InlineVarLenEntryQueue_Handle queue)

void	pw_InlineVarLenEntryQueue_Clear (pw_InlineVarLenEntryQueue_Handle queue)

uint32_t	pw_InlineVarLenEntryQueue_RawStorageSizeBytes (pw_InlineVarLenEntryQueue_ConstHandle queue)

void	pw_InlineVarLenEntryQueue_CopyEntries (pw_InlineVarLenEntryQueue_ConstHandle from, pw_InlineVarLenEntryQueue_Handle to)

void	pw_InlineVarLenEntryQueue_CopyEntriesOverwrite (pw_InlineVarLenEntryQueue_ConstHandle from, pw_InlineVarLenEntryQueue_Handle to)

void	pw_InlineVarLenEntryQueue_MoveEntries (pw_InlineVarLenEntryQueue_Handle from, pw_InlineVarLenEntryQueue_Handle to)

void	pw_InlineVarLenEntryQueue_MoveEntriesOverwrite (pw_InlineVarLenEntryQueue_Handle from, pw_InlineVarLenEntryQueue_Handle to)

Macro Definition Documentation

◆ PW_VARIABLE_LENGTH_ENTRY_QUEUE_DECLARE

#define PW_VARIABLE_LENGTH_ENTRY_QUEUE_DECLARE	(	variable,
		max_size_bytes
	)

Value:

  _PW_VAR_QUEUE_CHECK_SIZE(max_size_bytes)                               \
  uint32_t variable[_PW_VAR_QUEUE_SIZE_UINT32(max_size_bytes)] = {       \
      PW_VAR_QUEUE_DATA_SIZE_BYTES(max_size_bytes), /*head=*/0u, /*tail=*/0u}

Declares and initializes an array that can back an InlineVarLenEntryQueue that can hold up to max_size_bytes bytes when using the C API. max_size_bytes is the largest supported size for a single entry; attempting to store larger entries is invalid and will fail an assertion.

See also pw_InlineVarLenEntryQueue_Init.

Parameters

variable	variable name for the queue
max_size_bytes	the capacity of the queue

Function Documentation

◆ pw_InlineVarLenEntryQueue_Begin()

pw_InlineVarLenEntryQueue_Iterator pw_InlineVarLenEntryQueue_Begin ( pw_InlineVarLenEntryQueue_Handle queue )

◆ pw_InlineVarLenEntryQueue_Clear()

void pw_InlineVarLenEntryQueue_Clear ( pw_InlineVarLenEntryQueue_Handle queue )

◆ pw_InlineVarLenEntryQueue_ConstBegin()

pw_InlineVarLenEntryQueue_ConstIterator pw_InlineVarLenEntryQueue_ConstBegin ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_ConstEnd()

pw_InlineVarLenEntryQueue_ConstIterator pw_InlineVarLenEntryQueue_ConstEnd ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_CopyEntries()

void pw_InlineVarLenEntryQueue_CopyEntries	(	pw_InlineVarLenEntryQueue_ConstHandle	from,
		pw_InlineVarLenEntryQueue_Handle	to
	)

◆ pw_InlineVarLenEntryQueue_CopyEntriesOverwrite()

void pw_InlineVarLenEntryQueue_CopyEntriesOverwrite	(	pw_InlineVarLenEntryQueue_ConstHandle	from,
		pw_InlineVarLenEntryQueue_Handle	to
	)

◆ pw_InlineVarLenEntryQueue_Empty()

bool pw_InlineVarLenEntryQueue_Empty ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_End()

pw_InlineVarLenEntryQueue_Iterator pw_InlineVarLenEntryQueue_End ( pw_InlineVarLenEntryQueue_Handle queue )

◆ pw_InlineVarLenEntryQueue_Init()

void pw_InlineVarLenEntryQueue_Init	(	uint32_t	array[],
		size_t	array_size_uint32
	)

◆ pw_InlineVarLenEntryQueue_MaxSize()

uint32_t pw_InlineVarLenEntryQueue_MaxSize ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_MaxSizeBytes()

uint32_t pw_InlineVarLenEntryQueue_MaxSizeBytes ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_MoveEntries()

void pw_InlineVarLenEntryQueue_MoveEntries	(	pw_InlineVarLenEntryQueue_Handle	from,
		pw_InlineVarLenEntryQueue_Handle	to
	)

◆ pw_InlineVarLenEntryQueue_MoveEntriesOverwrite()

void pw_InlineVarLenEntryQueue_MoveEntriesOverwrite	(	pw_InlineVarLenEntryQueue_Handle	from,
		pw_InlineVarLenEntryQueue_Handle	to
	)

◆ pw_InlineVarLenEntryQueue_Pop()

void pw_InlineVarLenEntryQueue_Pop ( pw_InlineVarLenEntryQueue_Handle queue )

◆ pw_InlineVarLenEntryQueue_Push()

void pw_InlineVarLenEntryQueue_Push	(	pw_InlineVarLenEntryQueue_Handle	queue,
		const void *	data,
		uint32_t	data_size_bytes
	)

◆ pw_InlineVarLenEntryQueue_PushOverwrite()

void pw_InlineVarLenEntryQueue_PushOverwrite	(	pw_InlineVarLenEntryQueue_Handle	queue,
		const void *	data,
		uint32_t	data_size_bytes
	)

◆ pw_InlineVarLenEntryQueue_RawStorageSizeBytes()

uint32_t pw_InlineVarLenEntryQueue_RawStorageSizeBytes ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_Size()

uint32_t pw_InlineVarLenEntryQueue_Size ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_SizeBytes()

uint32_t pw_InlineVarLenEntryQueue_SizeBytes ( pw_InlineVarLenEntryQueue_ConstHandle queue )

◆ pw_InlineVarLenEntryQueue_TryPush()

bool pw_InlineVarLenEntryQueue_TryPush	(	pw_InlineVarLenEntryQueue_Handle	queue,
		const void *	data,
		const uint32_t	data_size_bytes
	)