ck_array_init(3)

Usage

#include <ck_array.h>

bool

ck_array_init(ck_array_t *array, unsigned int mode, struct ck_malloc *allocator, unsigned int initial_length);

Library

Concurrency Kit (libck, -lck)

Overview

The ck_array_init(3) function initializes the array pointed to by the argument array. The mode value must be CK_ARRAY_MODE_SPMC. The allocator argument must point to a ck_malloc data structure with valid non-NULL function pointers initialized for malloc, free and realloc. The initial_length specifies the initial length of the array. The value of initial_length must be greater than or equal to 2. An array allows for one concurrent put or remove operations in the presence of any number of concurrent CK_ARRAY_FOREACH operations.

Return values

This function returns true if the array was successfully created. It returns false if the creation failed. Failure may occur due to internal memory allocation failures or invalid arguments.

Releases

Unchanged in 5 releases since Debian 8 (Jessie).

8–13

ck_array_commit(3) linearization point for mutations before commit call ck_array_put(3) attempt immediate or deferred insertion of a pointer into array ck_array_put_unique(3) attempt immediate or deferred insertion of a unique pointer into array ck_array_remove(3) attempt immediate or deferred removal of a pointer from an array ck_array_deinit(3) destroy and deinitialize a pointer array ck_array_length(3) returns the number of pointers committed to an array ck_array_buffer(3) return length and pointer to array of reader-visible pointers ck_array_initialized(3) indicates whether an array was recently initialized or deinitialized CK_ARRAY_FOREACH(3) iterate through an array

Referred to by

ck_array_put(3) attempt immediate or deferred insertion of a pointer into array ck_array_buffer(3) return length and pointer to array of reader-visible pointers ck_array_commit(3) linearization point for mutations before commit call ck_array_deinit(3) destroy and deinitialize a pointer array ck_array_length(3) returns the number of pointers committed to an array ck_array_remove(3) attempt immediate or deferred removal of a pointer from an array CK_ARRAY_FOREACH(3) iterate through an array ck_array_put_unique(3) attempt immediate or deferred insertion of a unique pointer into array ck_array_initialized(3) indicates whether an array was recently initialized or deinitialized