Thu Apr 16 06:48:21 2015

Asterisk developer's documentation

ao2_container Struct Reference

Collaboration diagram for ao2_container:

Collaboration graph

Data Fields

struct bucket buckets [0]
int elements
int n_buckets
int version

Detailed Description

A container; stores the hash and callback functions, information on the size, the hash bucket heads, and a version number, starting at 0 (for a newly created, empty container) and incremented every time an object is inserted or deleted. The assumption is that an object is never moved in a container, but removed and readded with the new number. The version number is especially useful when implementing iterators. In fact, we can associate a unique, monotonically increasing number to each object, which means that, within an iterator, we can store the version number of the current object, and easily look for the next one, which is the next one in the list with a higher number. Since all objects have a version >0, we can use 0 as a marker for 'we need the first object in the bucket'.

Linking and unlink objects is typically expensive, as it involves a malloc() of a small object which is very inefficient. To optimize this, we allocate larger arrays of bucket_entry's when we run out of them, and then manage our own freelist. This will be more efficient as we can do the freelist management while we hold the lock (that we need anyways).

Definition at line 391 of file astobj2.c.

Field Documentation

struct bucket buckets[0] [read]

Definition at line 393 of file astobj2.c.

Referenced by __ao2_find(), __ao2_find_debug(), and internal_ao2_container_alloc().

int elements

Number of elements in the container

Definition at line 396 of file astobj2.c.

Referenced by ao2_container_count(), internal_ao2_callback(), and internal_ao2_iterator_next().

Definition at line 392 of file astobj2.c.

Referenced by internal_ao2_callback(), and internal_ao2_container_alloc().

int n_buckets

int version

described above

Definition at line 398 of file astobj2.c.

Referenced by internal_ao2_callback(), internal_ao2_container_alloc(), and internal_ao2_iterator_next().

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

Generated on Thu Apr 16 06:48:21 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6