Element access

Functions
static void *	cdc_circular_array_get (struct cdc_circular_array *d, size_t index)
	Returns an element at index position in the circular array. More...
enum cdc_stat	cdc_circular_array_at (struct cdc_circular_array *d, size_t index, void **elem)
	Writes to pointer an element from specified position in the circular array. Bounds checking is performed. More...
static void *	cdc_circular_array_front (struct cdc_circular_array *d)
	Returns a first element in the circular array. More...
static void *	cdc_circular_array_back (struct cdc_circular_array *d)
	Returns a last element in the circular array. More...

Detailed Description

Function Documentation

cdc_circular_array_get()

static void* cdc_circular_array_get ( struct cdc_circular_array *  d, size_t  index  )

inlinestatic

Returns an element at index position in the circular array.

Parameters

[in]	d	- cdc_circular_array
[in]	index	- index of an element to return

Returns

element from |index| position.

cdc_circular_array_at()

enum cdc_stat cdc_circular_array_at	(	struct cdc_circular_array *	d,
		size_t	index,
		void **	elem
	)

Writes to pointer an element from specified position in the circular array. Bounds checking is performed.

Parameters

[in]	d	- cdc_circular_array
[in]	index	- index of an element to write at elem
[out]	elem	- pointer where an element will be written

Returns

DC_STATUS_OK in a successful case or CDC_STATUS_OUT_OF_RANGE if the index is incorrect.

cdc_circular_array_front()

static void* cdc_circular_array_front ( struct cdc_circular_array *  d )

inlinestatic

Returns a first element in the circular array.

Parameters

[in]

d

- cdc_circular_array

Returns

first element in the circular array.

cdc_circular_array_back()

static void* cdc_circular_array_back ( struct cdc_circular_array *  d )

inlinestatic

Returns a last element in the circular array.

Parameters

[in]

d

- cdc_circular_array

Returns

last element in the circular array.