Base

Functions
enum cdc_stat	cdc_circular_array_ctor (struct cdc_circular_array **d, struct cdc_data_info *info)
	Constructs an empty circular array. More...
enum cdc_stat	cdc_circular_array_ctorl (struct cdc_circular_array **d, struct cdc_data_info *info,...)
	Constructs a circular array, initialized by an variable number of pointers. The last pointer must be CDC_END. More...
enum cdc_stat	cdc_circular_array_ctorv (struct cdc_circular_array **d, struct cdc_data_info *info, va_list args)
	Constructs a circular array, initialized by args. The last pointer must be CDC_END. More...
void	cdc_circular_array_dtor (struct cdc_circular_array *d)
	Destroys the circular array. More...

Detailed Description

Function Documentation

cdc_circular_array_ctor()

enum cdc_stat cdc_circular_array_ctor	(	struct cdc_circular_array **	d,
		struct cdc_data_info *	info
	)

Constructs an empty circular array.

Parameters

[out]	d	- cdc_circular_array
[in]	info	- cdc_data_info

Returns

CDC_STATUS_OK in a successful case or other value indicating an error.

cdc_circular_array_ctorl()

enum cdc_stat cdc_circular_array_ctorl	(	struct cdc_circular_array **	d,
		struct cdc_data_info *	info,
			...
	)

Constructs a circular array, initialized by an variable number of pointers. The last pointer must be CDC_END.

Parameters

[out]	d	- cdc_circular_array
[in]	info	- cdc_data_info

Returns

CDC_STATUS_OK in a successful case or other value indicating an error.

Example:

struct cdc_circular_array *carr = NULL;
if (cdc_circular_array_ctorl(&carr, NULL, CDC_FROM_INT(1),
                             CDC_FROM_INT(2), CDC_END) != CDC_STATUS_OK) {
  // handle error
}

cdc_circular_array_ctorv()

enum cdc_stat cdc_circular_array_ctorv	(	struct cdc_circular_array **	d,
		struct cdc_data_info *	info,
		va_list	args
	)

Constructs a circular array, initialized by args. The last pointer must be CDC_END.

Parameters

[out]	d	- cdc_circular_array
[in]	info	- cdc_data_info

Returns

CDC_STATUS_OK in a successful case or other value indicating an error.

cdc_circular_array_dtor()

void cdc_circular_array_dtor

(

struct cdc_circular_array *

d

)

Destroys the circular array.

Parameters

[in]

d

- cdc_circular_array