#include "asterisk/compat.h"
#include "asterisk/lock.h"
#include "asterisk/linkedlists.h"
#include "asterisk/inline_api.h"

Data Structures
struct	ao2_global_obj

struct	ao2_iterator
	When we need to walk through a container, we use an ao2_iterator to keep track of the current position. More...

struct	ao2_weakproxy
	This struct should be opaque, but it's size is needed. More...

Macros
#define	ao2_alloc_with_lockobj(data_size, destructor_fn, lockobj, tag) __ao2_alloc_with_lockobj((data_size), (destructor_fn), (lockobj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Allocate and initialize an object with separate locking. More...

#define	ao2_callback_data(container, flags, cb_fn, arg, data) __ao2_callback_data((container), (flags), (cb_fn), (arg), (data), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_cleanup(obj) __ao2_cleanup_debug((obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	AO2_FIELD_CMP_FN(stype, fn_suffix, field, key_cmp, partial_key_cmp, transform, argconst)

#define	AO2_FIELD_HASH_FN(stype, field, hash_fn)
	Creates a hash function for a structure field. More...

#define	AO2_FIELD_TRANSFORM_CMP_FN(cmp) ((cmp) ? 0 : CMP_MATCH)

#define	AO2_FIELD_TRANSFORM_SORT_FN(cmp) (cmp)

#define	ao2_find(container, arg, flags) __ao2_find((container), (arg), (flags), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_global_obj_ref(holder) __ao2_global_obj_ref(&holder, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

#define	ao2_global_obj_release(holder) __ao2_global_obj_replace_unref(&holder, NULL, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

#define	ao2_global_obj_replace(holder, obj) __ao2_global_obj_replace(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

#define	ao2_global_obj_replace_unref(holder, obj) __ao2_global_obj_replace_unref(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

#define	AO2_GLOBAL_OBJ_STATIC(name)
	Define a global object holder to be used to hold an ao2 object, statically initialized. More...

#define	ao2_iterator_next(iter) __ao2_iterator_next((iter), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_lock(a) __ao2_lock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	ao2_rdlock(a) __ao2_lock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	AO2_STRING_FIELD_CASE_CMP_FN(stype, field) AO2_FIELD_CMP_FN(stype, _cmp_fn, field, strcasecmp, strncasecmp, AO2_FIELD_TRANSFORM_CMP_FN,)

#define	AO2_STRING_FIELD_CASE_HASH_FN(stype, field) AO2_FIELD_HASH_FN(stype, field, ast_str_case_hash)

#define	AO2_STRING_FIELD_CASE_SORT_FN(stype, field) AO2_FIELD_CMP_FN(stype, _sort_fn, field, strcasecmp, strncasecmp, AO2_FIELD_TRANSFORM_SORT_FN, const)

#define	AO2_STRING_FIELD_CMP_FN(stype, field) AO2_FIELD_CMP_FN(stype, _cmp_fn, field, strcmp, strncmp, AO2_FIELD_TRANSFORM_CMP_FN,)
	Creates a compare function for a structure string field. More...

#define	AO2_STRING_FIELD_HASH_FN(stype, field) AO2_FIELD_HASH_FN(stype, field, ast_str_hash)
	Creates a hash function for a structure string field. More...

#define	AO2_STRING_FIELD_SORT_FN(stype, field) AO2_FIELD_CMP_FN(stype, _sort_fn, field, strcmp, strncmp, AO2_FIELD_TRANSFORM_SORT_FN, const)
	Creates a sort function for a structure string field. More...

#define	ao2_t_callback_data(container, flags, cb_fn, arg, data, tag) __ao2_callback_data((container), (flags), (cb_fn), (arg), (data), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	ao2_callback_data() is a generic function that applies cb_fn() to all objects in a container. It is functionally identical to ao2_callback() except that instead of taking an ao2_callback_fn , it takes an ao2_callback_data_fn , and allows the caller to pass in arbitrary data. More...

#define	ao2_t_cleanup(obj, tag) __ao2_cleanup_debug((obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_find(container, arg, flags, tag) __ao2_find((container), (arg), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_global_obj_ref(holder, tag) __ao2_global_obj_ref(&holder, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
	Get a reference to the object stored in the global holder. More...

#define	ao2_t_global_obj_release(holder, tag) __ao2_global_obj_replace_unref(&holder, NULL, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
	Release the ao2 object held in the global holder. More...

#define	ao2_t_global_obj_replace(holder, obj, tag) __ao2_global_obj_replace(&holder, (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
	Replace an ao2 object in the global holder. More...

#define	ao2_t_global_obj_replace_unref(holder, obj, tag) __ao2_global_obj_replace_unref(&holder, (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)
	Replace an ao2 object in the global holder, throwing away any old object. More...

#define	ao2_t_iterator_next(iter, tag) __ao2_iterator_next((iter), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_trylock(a) __ao2_trylock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	ao2_tryrdlock(a) __ao2_trylock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	ao2_trywrlock(a) __ao2_trylock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	ao2_unlock(a) __ao2_unlock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	ao2_weakproxy_find(c, arg, flags, tag) __ao2_weakproxy_find(c, arg, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Perform an ao2_find on a container with ao2_weakproxy objects, returning the real object. More...

#define	ao2_wrlock(a) __ao2_lock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

#define	OBJ_KEY OBJ_SEARCH_KEY

#define	OBJ_PARTIAL_KEY OBJ_SEARCH_PARTIAL_KEY

#define	OBJ_POINTER OBJ_SEARCH_OBJECT

Typedefs
typedef int()	ao2_callback_data_fn(void obj, void arg, void *data, int flags)
	Type of a generic callback function. More...

typedef int()	ao2_callback_fn(void obj, void arg, int flags)
	Type of a generic callback function. More...

typedef void(*	ao2_destructor_fn) (void *vdoomed)
	Typedef for an object destructor. More...

typedef int()	ao2_hash_fn(const void *obj, int flags)

typedef int()	ao2_sort_fn(const void obj_left, const void obj_right, int flags)
	Type of generic container sort function. More...

Enumerations
enum	_cb_results { CMP_MATCH = 0x1, CMP_STOP = 0x2 }
	A callback function will return a combination of CMP_MATCH and CMP_STOP. The latter will terminate the search in a container. More...

enum	ao2_alloc_opts { AO2_ALLOC_OPT_LOCK_MUTEX = (0 << 0), AO2_ALLOC_OPT_LOCK_RWLOCK = (1 << 0), AO2_ALLOC_OPT_LOCK_NOLOCK = (2 << 0), AO2_ALLOC_OPT_LOCK_MASK = (3 << 0), AO2_ALLOC_OPT_LOCK_OBJ = AO2_ALLOC_OPT_LOCK_MASK, AO2_ALLOC_OPT_NO_REF_DEBUG = (1 << 2) }
	Options available when allocating an ao2 object. More...

enum	ao2_container_opts { AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN = (1 << 0), AO2_CONTAINER_ALLOC_OPT_DUPS_MASK = (3 << 1), AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW = (0 << 1), AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT = (1 << 1), AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT = (2 << 1), AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE = (3 << 1) }
	Options available when allocating an ao2 container object. More...

enum	ao2_iterator_flags { AO2_ITERATOR_DONTLOCK = (1 << 0), AO2_ITERATOR_MALLOCD = (1 << 1), AO2_ITERATOR_UNLINK = (1 << 2), AO2_ITERATOR_DESCENDING = (1 << 3) }

enum	ao2_lock_req { AO2_LOCK_REQ_MUTEX, AO2_LOCK_REQ_RDLOCK, AO2_LOCK_REQ_WRLOCK }
	Which lock to request. More...

enum	search_flags { OBJ_UNLINK = (1 << 0), OBJ_NODATA = (1 << 1), OBJ_MULTIPLE = (1 << 2), OBJ_NOLOCK = (1 << 4), OBJ_SEARCH_MASK = (0x07 << 5), OBJ_SEARCH_NONE = (0 << 5), OBJ_SEARCH_OBJECT = (1 << 5), OBJ_SEARCH_KEY = (2 << 5), OBJ_SEARCH_PARTIAL_KEY = (4 << 5), OBJ_ORDER_MASK = (0x03 << 8), OBJ_ORDER_ASCENDING = (0 << 8), OBJ_ORDER_DESCENDING = (1 << 8), OBJ_ORDER_PRE = (2 << 8), OBJ_ORDER_POST = (3 << 8) }
	Flags passed to ao2_callback_fn(), ao2_hash_fn(), and ao2_sort_fn() to modify behaviour. More...

Functions
void *	__ao2_alloc_with_lockobj (size_t data_size, ao2_destructor_fn destructor_fn, void lockobj, const char tag, const char file, int line, const char func) attribute_warn_unused_result

void *	__ao2_callback_data (struct ao2_container c, enum search_flags flags, ao2_callback_data_fn cb_fn, void arg, void data, const char tag, const char file, int line, const char *func)

void	__ao2_cleanup (void *obj)

void	__ao2_cleanup_debug (void obj, const char tag, const char file, int line, const char function)

void *	__ao2_find (struct ao2_container c, const void arg, enum search_flags flags, const char tag, const char file, int line, const char *func)

void *	__ao2_global_obj_ref (struct ao2_global_obj holder, const char tag, const char file, int line, const char func, const char *name) attribute_warn_unused_result

void *	__ao2_global_obj_replace (struct ao2_global_obj holder, void obj, const char tag, const char file, int line, const char func, const char name) attribute_warn_unused_result

int	__ao2_global_obj_replace_unref (struct ao2_global_obj holder, void obj, const char tag, const char file, int line, const char func, const char name)

void *	__ao2_iterator_next (struct ao2_iterator iter, const char tag, const char file, int line, const char func) attribute_warn_unused_result

int	__ao2_lock (void a, enum ao2_lock_req lock_how, const char file, const char func, int line, const char var)
	Lock an object. More...

int	__ao2_trylock (void a, enum ao2_lock_req lock_how, const char file, const char func, int line, const char var)
	Try locking– (don't block if fail) More...

int	__ao2_unlock (void a, const char file, const char func, int line, const char var)
	Unlock an object. More...

void *	__ao2_weakproxy_find (struct ao2_container c, const void arg, enum search_flags flags, const char tag, const char file, int line, const char *func)

void	ao2_iterator_cleanup (struct ao2_iterator *iter)

int	ao2_iterator_count (struct ao2_iterator *iter)
	Get a count of the iterated container objects. More...

void	ao2_iterator_destroy (struct ao2_iterator *iter)
	Destroy a container iterator. More...

struct ao2_iterator	ao2_iterator_init (struct ao2_container *c, int flags) attribute_warn_unused_result
	Create an iterator for a container. More...

void	ao2_iterator_restart (struct ao2_iterator *iter)
	Restart an iteration. More...

int	ao2_match_by_addr (void obj, void arg, int flags)
	A common ao2_callback is one that matches by address. More...

void *	ao2_object_get_lockaddr (void *obj)
	Return the mutex lock address of an object. More...

int	ao2_ref_and_lock (void *obj)
	Increment reference count on an object and lock it. More...

int	ao2_unlock_and_unref (void *obj)
	Unlock an object and decrement its reference count. More...

#define	ao2_t_alloc_options(data_size, destructor_fn, options, debug_msg) __ao2_alloc((data_size), (destructor_fn), (options), (debug_msg), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Allocate and initialize an object. More...

#define	ao2_alloc_options(data_size, destructor_fn, options) __ao2_alloc((data_size), (destructor_fn), (options), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_alloc(data_size, destructor_fn, debug_msg) __ao2_alloc((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, (debug_msg), __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_alloc(data_size, destructor_fn) __ao2_alloc((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

void *	__ao2_alloc (size_t data_size, ao2_destructor_fn destructor_fn, unsigned int options, const char tag, const char file, int line, const char *func) attribute_warn_unused_result

#define	ao2_t_ref(o, delta, tag) __ao2_ref((o), (delta), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Reference/unreference an object and return the old refcount. More...

#define	ao2_ref(o, delta) __ao2_ref((o), (delta), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_bump(obj, tag)
	Bump refcount on an AO2 object by one, returning the object. More...

#define	ao2_bump(obj) ao2_t_bump((obj), NULL)

#define	ao2_t_replace(dst, src, tag)
	Replace one object reference with another cleaning up the original. More...

#define	ao2_replace(dst, src) ao2_t_replace((dst), (src), NULL)

unsigned int	ao2_options_get (void *obj)
	Retrieve the ao2 options used to create the object. More...

int	__ao2_ref (void o, int delta, const char tag, const char file, int line, const char func)

#define	AO2_WEAKPROXY() struct ao2_weakproxy __weakproxy##__LINE__
	Macro which must be used at the beginning of weakproxy capable objects. More...

#define	ao2_weakproxy_alloc(data_size, destructor_fn) __ao2_weakproxy_alloc(data_size, destructor_fn, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_weakproxy_alloc(data_size, destructor_fn, tag) __ao2_weakproxy_alloc(data_size, destructor_fn, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_weakproxy_set_object(weakproxy, obj, flags) __ao2_weakproxy_set_object(weakproxy, obj, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_weakproxy_set_object(weakproxy, obj, flags, tag) __ao2_weakproxy_set_object(weakproxy, obj, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_weakproxy_ref_object(weakproxy, delta, flags, tag)

#define	ao2_weakproxy_ref_object(weakproxy, delta, flags) ao2_t_weakproxy_ref_object(weakproxy, delta, flags, NULL)

#define	ao2_weakproxy_get_object(weakproxy, flags) __ao2_weakproxy_get_object(weakproxy, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_weakproxy_get_object(weakproxy, flags, tag) __ao2_weakproxy_get_object(weakproxy, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_get_weakproxy(obj) __ao2_get_weakproxy(obj, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_get_weakproxy(obj, tag) __ao2_get_weakproxy(obj, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

typedef void(*	ao2_weakproxy_notification_cb) (void weakproxy, void data)

void *	__ao2_weakproxy_alloc (size_t data_size, ao2_destructor_fn destructor_fn, const char tag, const char file, int line, const char *func) attribute_warn_unused_result
	Allocate an ao2_weakproxy object. More...

int	__ao2_weakproxy_set_object (void weakproxy, void obj, int flags, const char tag, const char file, int line, const char *func)
	Associate weakproxy with obj. More...

int	__ao2_weakproxy_ref_object (void weakproxy, int delta, int flags, const char tag, const char file, int line, const char func)
	Run ao2_t_ref on the object associated with weakproxy. More...

void *	__ao2_weakproxy_get_object (void weakproxy, int flags, const char tag, const char file, int line, const char func) attribute_warn_unused_result
	Get the object associated with weakproxy. More...

int	ao2_weakproxy_subscribe (void weakproxy, ao2_weakproxy_notification_cb cb, void data, int flags)
	Request notification when weakproxy points to NULL. More...

int	ao2_weakproxy_unsubscribe (void weakproxy, ao2_weakproxy_notification_cb cb, void data, int flags)
	Remove notification of real object destruction. More...

void *	__ao2_get_weakproxy (void obj, const char tag, const char file, int line, const char func) attribute_warn_unused_result
	Get the weakproxy attached to obj. More...

Object Containers
Here start declarations of containers.
#define	ao2_t_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn, tag) __ao2_container_alloc_hash((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Allocate and initialize a hash container with the desired number of buckets. More...

#define	ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn) __ao2_container_alloc_hash((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn, tag) __ao2_container_alloc_list((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Allocate and initialize a list container. More...

#define	ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn) __ao2_container_alloc_list((ao2_options), (container_options), (sort_fn), (cmp_fn), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn, tag) __ao2_container_alloc_rbtree((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Allocate and initialize a red-black tree container. More...

#define	ao2_container_alloc_rbtree(ao2_options, container_options, sort_fn, cmp_fn) __ao2_container_alloc_rbtree((ao2_options), (container_options), (sort_fn), (cmp_fn), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_container_clone(orig, flags, tag) __ao2_container_clone(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_container_clone(orig, flags) __ao2_container_clone(orig, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

typedef void()	ao2_prnt_fn(void where, const char fmt,...)
	Print output. More...

typedef void()	ao2_prnt_obj_fn(void v_obj, void where, ao2_prnt_fn *prnt)
	Print object key. More...

struct ao2_container *	__ao2_container_alloc_hash (unsigned int ao2_options, unsigned int container_options, unsigned int n_buckets, ao2_hash_fn hash_fn, ao2_sort_fn sort_fn, ao2_callback_fn cmp_fn, const char tag, const char file, int line, const char func) attribute_warn_unused_result

struct ao2_container *	__ao2_container_alloc_list (unsigned int ao2_options, unsigned int container_options, ao2_sort_fn sort_fn, ao2_callback_fn cmp_fn, const char tag, const char file, int line, const char *func) attribute_warn_unused_result

struct ao2_container *	__ao2_container_alloc_rbtree (unsigned int ao2_options, unsigned int container_options, ao2_sort_fn sort_fn, ao2_callback_fn cmp_fn, const char tag, const char file, int line, const char *func) attribute_warn_unused_result

int	ao2_container_count (struct ao2_container *c)
	Returns the number of elements in a container. More...

int	ao2_container_dup (struct ao2_container dest, struct ao2_container src, enum search_flags flags)
	Copy all object references in the src container into the dest container. More...

int	ao2_container_dup_weakproxy_objs (struct ao2_container dest, struct ao2_container src, enum search_flags flags)
	Copy object references associated with src container weakproxies into the dest container. More...

struct ao2_container *	__ao2_container_clone (struct ao2_container orig, enum search_flags flags, const char tag, const char file, int line, const char func) attribute_warn_unused_result
	Create a clone/copy of the given container. More...

void	ao2_container_dump (struct ao2_container self, enum search_flags flags, const char name, void where, ao2_prnt_fn prnt, ao2_prnt_obj_fn *prnt_obj)
	Display contents of the specified container. More...

void	ao2_container_stats (struct ao2_container self, enum search_flags flags, const char name, void where, ao2_prnt_fn prnt)
	Display statistics of the specified container. More...

int	ao2_container_check (struct ao2_container *self, enum search_flags flags)
	Perform an integrity check on the specified container. More...

int	ao2_container_register (const char name, struct ao2_container self, ao2_prnt_obj_fn *prnt_obj)
	Register a container for CLI stats and integrity check. More...

void	ao2_container_unregister (const char *name)
	Unregister a container for CLI stats and integrity check. More...

Object Management
Here we have functions to manage objects. We can use the functions below on any kind of object defined by the user.
#define	ao2_t_link(container, obj, tag) __ao2_link((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Add an object to a container. More...

#define	ao2_link(container, obj) __ao2_link((container), (obj), 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_link_flags(container, obj, flags, tag) __ao2_link((container), (obj), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Add an object to a container. More...

#define	ao2_link_flags(container, obj, flags) __ao2_link((container), (obj), (flags), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_unlink(container, obj, tag) __ao2_unlink((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Remove an object from a container. More...

#define	ao2_unlink(container, obj) __ao2_unlink((container), (obj), 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

#define	ao2_t_unlink_flags(container, obj, flags, tag) __ao2_unlink((container), (obj), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Remove an object from a container. More...

#define	ao2_unlink_flags(container, obj, flags) __ao2_unlink((container), (obj), (flags), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

int	__ao2_link (struct ao2_container c, void obj_new, int flags, const char tag, const char file, int line, const char *func)

void *	__ao2_unlink (struct ao2_container c, void obj, int flags, const char tag, const char file, int line, const char *func)

#define	ao2_t_callback(c, flags, cb_fn, arg, tag) __ao2_callback((c), (flags), (cb_fn), (arg), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	ao2_callback() is a generic function that applies cb_fn() to all objects in a container, as described below. More...

#define	ao2_callback(c, flags, cb_fn, arg) __ao2_callback((c), (flags), (cb_fn), (arg), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

void *	__ao2_callback (struct ao2_container c, enum search_flags flags, ao2_callback_fn cb_fn, void arg, const char tag, const char file, int line, const char func)

Detailed Description

Object Model implementing objects and containers.

Definition in file astobj2.h.

Macro Definition Documentation

◆ ao2_alloc

#define ao2_alloc	(	data_size,
		destructor_fn
	)	__ao2_alloc((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 411 of file astobj2.h.

Referenced by __allocate_taskprocessor(), __ast_bucket_scheme_register(), __ast_sorcery_object_field_register(), __ast_sorcery_object_type_insert_wizard(), __ast_sorcery_wizard_register(), __features_config_alloc(), _ast_odbc_request_obj2(), add_calltoken_ignore(), add_column_name(), agent_pvt_new(), alias_mailbox_mapping_create(), alloc_new_parking_lot(), alloc_notify_task_data(), alloc_smdi_interface(), allocate_subscription_tree(), ao2_dup_event(), app_data_create(), applicationmap_item_alloc(), ast_add_hint(), ast_ari_add_handler(), ast_ari_remove_handler(), ast_ari_websocket_session_create(), ast_attended_transfer_message_create(), ast_blind_transfer_message_create(), ast_bridge_blob_create(), ast_bridge_blob_create_from_snapshots(), ast_bridge_transfer_blind(), ast_calendar_event_alloc(), ast_cdr_engine_term(), ast_cel_general_config_alloc(), ast_channel_dialed_causes_add(), ast_channel_get_vars(), ast_channel_suppress(), ast_config_hook_register(), ast_datastores_alloc_datastore(), ast_dns_resolve_recurring(), ast_endpoint_blob_create(), ast_json_payload_create(), ast_media_index_create(), ast_msg_alloc(), ast_multi_channel_blob_create(), ast_multi_object_blob_create(), ast_mwi_blob_create(), ast_parked_call_payload_create(), ast_parking_register_bridge_features(), ast_phoneprov_provider_register(), ast_res_pjsip_initialize_configuration(), ast_rtp_instance_new(), ast_rtp_publish_rtcp_message(), ast_rtp_rtcp_report_alloc(), ast_serializer_shutdown_group_alloc(), ast_sip_channel_pvt_alloc(), ast_sip_dialog_set_endpoint(), ast_sip_dialog_set_serializer(), ast_sip_initialize_sorcery_auth(), ast_sip_initialize_sorcery_location(), ast_sip_initialize_sorcery_transport(), ast_sip_publish_client_alloc_datastore(), ast_sip_schedule_task(), ast_sip_session_alloc(), ast_sip_session_alloc_datastore(), ast_sip_session_register_sdp_handler(), ast_sip_session_suspend(), ast_sorcery_global_observer_add(), ast_sorcery_instance_observer_add(), ast_sorcery_object_fields_register(), ast_sorcery_observer_add(), ast_sorcery_wizard_observer_add(), ast_taskprocessor_listener_alloc(), ast_tcptls_client_create(), ast_tcptls_server_root(), AST_TEST_DEFINE(), ast_threadpool_listener_alloc(), ast_tone_zone_alloc(), ast_unreal_alloc_stream_topology(), ast_uri_create_(), ast_websocket_sub_protocol_alloc(), ast_websocket_uri_cb(), ast_xmpp_client_config_alloc(), async_data_alloc(), attended_transfer_properties_alloc(), auth_create(), bridge_alloc(), bridge_basic_personality_alloc(), bridge_channel_internal_alloc(), bridge_manager_create(), bridge_merge_message_create(), bridge_profile_alloc(), bridge_profile_sounds_alloc(), bucket_metadata_alloc(), build_calendar(), build_callno_limits(), build_device(), build_entity_id(), build_mansession(), build_peer(), build_profile(), build_route(), build_user(), cache_test_message_create_full(), caldav_load_calendar(), calendar_query_exec(), cdr_object_alloc(), cdr_prop_write(), cdr_read(), cdr_write(), cel_config_alloc(), chan_list_init(), channel_get_external_vars(), command_create(), conf_alloc(), conf_run(), confbridge_cfg_alloc(), consumer_create(), control_create(), control_list_create(), create_channel_blob_message(), create_cts(), create_dsn(), create_esc_entry(), create_foo_type_message(), create_message_types(), create_queue_member(), create_trunk_ref(), device_state_subscription_create(), dial_masquerade_datastore_alloc(), dialgroup_write(), endpoint_internal_create(), endpt_send_request(), event_session_alloc(), ewscal_load_calendar(), exchangecal_load_calendar(), exten_state_data_alloc(), exten_state_subscription_alloc(), extension_state_add_destroy(), fax_detect_new(), fax_gateway_new(), fax_session_new(), fax_session_reserve(), featuregroup_alloc(), featuregroup_handler(), find_or_create_temporary_state(), forkcdr_exec(), generate_parked_user(), get_filestream(), global_config_alloc(), hangup_data_alloc(), hepv3_config_alloc(), hepv3_create_capture_info(), hepv3_data_alloc(), ht_new(), ical_load_calendar(), indicate_data_alloc(), info_dtmf_data_alloc(), inprocess_count(), insert_test_duplicates(), insert_test_vector(), internal_state_alloc(), jingle_alloc(), jingle_config_alloc(), jingle_endpoint_alloc(), jingle_endpoint_state_create(), join_conference_bridge(), kqueue_timer_open(), load_config(), load_module(), load_odbc_config(), menu_alloc(), module_config_alloc(), msg_data_alloc(), msg_data_create(), mwi_create_state(), mwi_get_notify_data(), mwi_stasis_subscription_alloc(), mwi_subscription_alloc(), named_acl_alloc(), named_acl_config_alloc(), new_iax(), new_realtime_sqlite3_db(), nocdr_exec(), notify_ami_data_create(), notify_ami_uri_data_create(), notify_cfg_alloc(), notify_cli_data_create(), notify_cli_uri_data_create(), notify_option_alloc(), notify_option_handler(), parking_config_alloc(), parking_lot_cfg_alloc(), pbx_outgoing_attempt(), peercnt_add(), pjsip_channel_cli_register(), playback_create(), presence_state_alloc(), prometheus_general_config_alloc(), proxy_from_config(), pthread_timer_open(), query_set_data_alloc(), queue_stasis_data_alloc(), realtime_common(), recording_alloc(), recurring_data_alloc(), refer_progress_alloc(), refer_progress_notification_alloc(), register_aor_core(), reload(), resetcdr_exec(), root_handler_create(), rtp_direct_media_data_create(), scheduler(), send_msg(), send_start_msg_snapshots(), sendtext_data_create(), session_details_new(), set_fn(), shutdown_data_create(), sip_create_publication(), sip_monitor_instance_init(), sip_options_endpoint_state_compositor_find_or_alloc(), sip_outbound_publish_state_alloc(), sip_outbound_publisher_alloc(), sip_outbound_registration_response_cb(), sip_outbound_registration_state_alloc(), sip_prepare_socket(), sip_tcptls_write(), sip_threadinfo_create(), skel_config_alloc(), skel_game_alloc(), skel_level_alloc(), skel_state_alloc(), sla_build_station(), sla_build_trunk(), sla_create_station_ref(), smdi_read(), sorcery_memory_cached_object_alloc(), sorcery_object_type_alloc(), stasis_app_control_record(), stasis_app_recording_options_create(), stasis_config_alloc(), stasis_message_sink_create(), stasis_subscription_cb_noop(), stasis_test_message_create(), t38_parameters_task_data_alloc(), task_data_create(), test_config_alloc(), test_item_alloc(), test_performance(), threadpool_alloc(), timerfd_timer_open(), topic_dtor(), transfer_data_alloc(), try_calling(), udptl_snapshot_alloc(), unbound_config_preapply_callback(), user_profile_alloc(), ustmtext(), websocket_client_args_create(), websocket_client_create(), websocket_server_create_impl(), worker_thread_alloc(), xml_translate(), xmpp_client_alloc(), xmpp_client_create_buddy(), xmpp_config_alloc(), and xmpp_pak_presence().

◆ ao2_alloc_options

#define ao2_alloc_options	(	data_size,
		destructor_fn,
		options
	)	__ao2_alloc((data_size), (destructor_fn), (options), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Examples:: /tmp/asterisk-shallow/main/app.c.

Definition at line 406 of file astobj2.h.

◆ ao2_alloc_with_lockobj

#define ao2_alloc_with_lockobj	(	data_size,
		destructor_fn,
		lockobj,
		tag
	)	__ao2_alloc_with_lockobj((data_size), (destructor_fn), (lockobj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Allocate and initialize an object with separate locking.

Since: 14.1.0

Parameters

data_size	The sizeof() of the user-defined structure.
destructor_fn	The destructor function (can be NULL)
lockobj	A separate ao2 object that will provide locking.
debug_msg	An ao2 object debug tracing message.

Returns: A pointer to user-data.

See also: ao2_alloc for additional details.

Note: lockobj must be a valid AO2 object.

Definition at line 433 of file astobj2.h.

Referenced by ast_sorcery_lockable_alloc().

◆ ao2_bump

#define ao2_bump ( obj ) ao2_t_bump((obj), NULL)

Examples:: /tmp/asterisk-shallow/main/app.c.

Definition at line 491 of file astobj2.h.

Referenced by __ast_frdup(), __ast_frisolate(), __ast_smoother_feed(), __ast_sorcery_object_type_insert_wizard(), _ast_odbc_request_obj2(), _moh_class_malloc(), adsi_transmit_message_full(), alloc_notify_task_data(), allocate_subscription(), allocate_subscription_tree(), aoc_publish_blob(), app_create(), app_send(), append_mailbox_mapping(), application_tuple_alloc(), apply_menu_to_user(), ast_ari_bridges_set_video_source(), ast_ari_channels_create(), ast_bridge_blob_create_from_snapshots(), ast_bridge_channel_get_chan(), ast_bridge_get_snapshot(), ast_bridge_get_snapshot_by_uniqueid(), ast_bridges(), ast_cdr_get_config(), ast_cdr_message_router(), ast_cel_set_config(), ast_channel_blob_create(), ast_channel_cache_all(), ast_channel_cache_by_name(), ast_channel_snapshot_create(), ast_channel_snapshot_set(), ast_channel_start_silence_generator(), ast_channel_yank(), ast_dns_query_set_resolve_async(), ast_dns_resolve_recurring(), ast_dns_resolver_set_data(), ast_format_attribute_set(), ast_format_create_named(), ast_format_get_codec(), ast_format_joint(), ast_format_parse_sdp_fmtp(), ast_local_lock_all(), ast_moh_files_next(), ast_openvstream(), ast_rtp_bundle(), ast_rtp_codecs_get_payload(), ast_rtp_codecs_get_payload_format(), ast_rtp_codecs_payloads_set_m_type(), ast_rtp_new(), ast_sip_create_response(), ast_sip_dialog_get_endpoint(), ast_sip_for_each_contact(), ast_sip_get_distributor_serializer(), ast_sip_get_transport_state(), ast_sip_location_create_contact(), ast_sip_schedule_task(), ast_sip_session_alloc(), ast_sip_session_create_outgoing(), ast_sip_session_media_state_clone(), ast_sip_subscription_get_endpoint(), ast_sip_transport_monitor_register_replace(), ast_slinfactory_init(), ast_slinfactory_init_with_format(), ast_sorcery_get_wizard_mapping(), ast_speech_new(), ast_stream_set_formats(), AST_TEST_DEFINE(), ast_unreal_indicate(), asterisk_start_devicestate_publishing(), asterisk_start_mwi_publishing(), audiosocket_exec(), auth_observer(), background_detect_exec(), begin_dial_prerun(), bridge_channel_internal_join(), bridge_publish_state_from_blob(), bridge_snapshot_update_create(), bucket_copy_handler(), bucket_file_copy_handler(), cache_entry_create(), cache_put(), cache_test_aggregate_calc_fn(), cache_udpate(), cancel_and_unpublish(), chan_pjsip_answer(), chan_pjsip_indicate(), channel_do_masquerade(), channel_snapshot_update_create(), chanspy_exec(), check_request_status(), cli_gather_contact(), command_prestart_get_container(), conf_set_menu_to_user(), control_create(), control_set_app(), create_jb(), create_out_of_dialog_request(), create_subscription_tree(), dahdi_translate(), dahdiscan_exec(), device_state_aggregate_calc(), dictate_exec(), dispatch_message(), distributor(), dns_query_alloc(), dns_query_recurring_resolution_callback(), dns_system_resolver_resolve(), do_waiting(), eagi_exec(), exten_state_pub_data_alloc(), exten_state_subscription_alloc(), extenspy_exec(), filter_history(), find_state_by_transport(), generic_fax_exec(), get_dial_bridge(), get_filestream(), get_log_mappings(), get_subscription(), handle_cli_moh_show_files(), handle_recordfile(), handle_stasis_state(), hangup(), ices_exec(), internal_state_alloc(), isAnsweringMachine(), linear_alloc(), link_topic_proxy(), make_silence(), measurenoise(), memory_cache_stale_check(), moh_alloc(), moh_files_write_format_change(), moh_parse_options(), mp3_exec(), mwi_contact_changed(), mwi_contact_deleted(), mwi_stasis_cb(), naptr_resolve(), native_rtp_bridge_framehook_attach(), NBScat_exec(), newpvt(), opus_clone(), opus_get(), opus_set(), payload_mapping_rx_clear_primary(), pjsip_acf_channel_read(), pjsip_show_history(), play_uri(), playtones_alloc(), prometheus_general_config_get(), publisher_client_send(), publisher_start(), pubsub_on_client_refresh(), pubsub_on_rx_refresh(), pubsub_on_rx_subscribe_request(), pubsub_on_server_timeout(), query_set_resolve(), record_exec(), recurring_resolve(), resamp_new(), ring_entry(), route_table_add(), rtp_direct_media_data_create(), rtp_payload_type_alloc(), schedule_cache_expiration(), schedule_notification(), schedule_publish_refresh(), send_contact_notify(), send_notify(), send_request_data_alloc(), send_start_msg_snapshots(), send_waveform_to_channel(), serializer_create(), set_next_mime_type(), set_read_to_slin(), sip_options_contact_callback_data_alloc(), sip_outbound_publish_callback(), sip_outbound_publish_state_alloc(), sip_outbound_publish_synchronize(), sip_outbound_publisher_alloc(), sip_outbound_publisher_init(), sip_outbound_registration_apply(), sip_outbound_registration_perform(), sip_outbound_registration_regc_alloc(), sip_outbound_registration_state_alloc(), sip_publisher_service_queue(), sip_session_refresh(), siren14_parse_sdp_fmtp(), siren7_parse_sdp_fmtp(), smdi_msg_retrieve_read(), softmix_bridge_stream_topology_changed(), softmix_translate_helper_entry_alloc(), sorcery_memory_cache_open(), sorcery_memory_cache_retrieve_fields(), sorcery_memory_cache_retrieve_id(), sorcery_memory_cached_object_alloc(), speech_background(), srv_resolve(), stale_cache_update_task_data_alloc(), stale_update_task_data_alloc(), stasis_app_control_play_uri(), stasis_app_control_record(), stasis_app_exec(), stasis_cache_get_by_eid(), stasis_forward_all(), stasis_message_router_publish_sync(), stasis_state_subscriber_data(), stasis_unsubscribe(), state_alloc(), stir_shaken_general_get(), sub_persistence_recreate(), subscribe_device_state(), test_resolve(), tonepair_alloc(), topology_change_refresh_data_alloc(), transmit_audio(), unbound_config_preapply_callback(), unbound_resolver_resolve(), unbound_resolver_start(), wait_for_answer(), and wrap_hook().

◆ ao2_callback

#define ao2_callback	(	c,
		flags,
		cb_fn,
		arg
	)	__ao2_callback((c), (flags), (cb_fn), (arg), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1716 of file astobj2.h.

Referenced by _ast_odbc_request_obj2(), _sip_show_peers(), acl_on_rx_msg(), aco_option_find(), actual_load_config(), admin_exec(), agents_mark(), agents_sweep(), ami_registrations_endpoints(), ami_show_aors(), ami_show_auths(), ami_show_contacts(), ami_show_endpoints(), ami_show_outbound_registrations(), ami_show_resource_lists(), anonymous_identify(), ao2_container_dup(), ao2_container_dup_weakproxy_objs(), ao2_container_unregister(), aor_apply_handler(), aor_deleted_observer(), ari_show_users(), ast_ari_applications_list(), ast_ari_websocket_events_event_websocket_dtor(), ast_bridge_features_merge(), ast_bucket_file_metadata_callback(), ast_calendar_clear_events(), ast_calendar_merge_events(), ast_calendar_unregister(), ast_cdr_setvar(), ast_channel_dialed_causes_channels(), ast_channel_dialed_causes_clear(), ast_codec_get_by_id(), ast_extension_state_del(), ast_get_chan_applicationmap(), ast_media_get_media(), ast_media_get_variants(), ast_merge_contexts_and_delete(), ast_multi_channel_blob_get_channels(), ast_namedgroups_intersect(), ast_odbc_get_max_connections(), ast_phoneprov_provider_unregister(), ast_sip_cli_traverse_objects(), ast_sip_get_transport_states(), ast_sip_location_prune_boot_contacts(), ast_sip_location_retrieve_aor_contacts_nolock_filtered(), ast_sip_location_retrieve_first_aor_contact_filtered(), ast_sip_persistent_endpoint_add_to_regcontext(), ast_sip_session_remove_datastore(), ast_sip_transport_monitor_unregister_all(), ast_softhangup_all(), ast_sorcery_force_reload(), ast_sorcery_global_observer_remove(), ast_sorcery_instance_observer_remove(), ast_sorcery_is_object_field_registered(), ast_sorcery_load(), ast_sorcery_observer_remove(), ast_sorcery_reload(), ast_sorcery_wizard_observer_remove(), AST_TEST_DEFINE(), ast_unregister_indication_country(), asterisk_publication_devicestate_refresh(), asterisk_publication_mwi_refresh(), asterisk_publication_send_refresh(), asterisk_start_devicestate_publishing(), asterisk_start_mwi_publishing(), build_user(), cache_cleanup(), caldav_destructor(), calendar_is_busy(), calltoken_required(), cc_handle_publish_error(), cdr_engine_shutdown(), cdr_object_get_by_name(), cel_report_event(), channel_admin_exec(), channel_replaced_cb(), channel_stolen_cb(), check_expiration_thread(), cleanup(), cleanup_module(), cli_contact_get_container(), cli_display_parking_lot(), cli_display_parking_lot_list(), cli_endpoint_iterate(), cli_iterator(), cli_unid_iterate(), common_identify(), complete_bridge_live(), conf_run(), context_table_create_autohints(), cpg_confchg_cb(), create_mwi_subscriptions(), create_sound_blob(), delete_users(), do_timing(), ewscal_destructor(), exchangecal_destructor(), find_endpoint(), gather_contacts_for_aor(), get_buddy_status(), get_container(), handle_bridge_show_specific(), handle_cc_notify(), handle_cli_sounds_show(), handle_feature_show(), handle_manager_show_events(), handle_registrations(), handle_response_subscribe(), hash_test_count(), hooks_remove_container(), icalendar_destructor(), line_identify(), load_config(), load_indications(), load_module(), mark_all_as_stale_in_cache(), mark_all_databases_dirty(), media_cache_handle_show_all(), meetme_menu_admin(), meetme_menu_admin_extended(), metermaidstate(), mwi_contact_changed(), mwi_get_notify_data(), mwi_subscription_shutdown(), notify_endpoint(), object_type_loaded_observer(), one_protocol(), parking_lot_inspect_parked_user(), parking_lot_retrieve_parked_user(), parking_lot_search_context_extension_inuse(), pjsip_contact_function_read(), print_featuregroups(), process_config(), process_nat(), prune_task(), queue_delme_members_decrement_followers(), queue_member_follower_removal(), queued_set_size(), queued_task_pushed(), register_aor_core(), registration_loaded_observer(), reload(), reload_config(), reload_queues(), reload_single_queue(), remove_all_from_cache(), remove_excess_contacts(), send_initial_notify_all(), send_mwi_notify(), send_unsolicited_mwi_notify(), session_media_dtor(), set_config_destroy(), set_peercnt_limit(), show_codec(), shrink(), sip_options_aor_dtor(), sip_options_aor_observer_modified_task(), sip_options_apply_aor_configuration(), sip_options_qualify_aor(), sip_options_synchronize_task(), sip_outbound_publish_state_destroy(), sip_outbound_publish_synchronize(), sip_outbound_publisher_reinit_all(), sip_tcp_locate(), sla_destroy(), sla_load_config(), smdi_msg_find(), sorcery_config_retrieve_fields(), sorcery_config_retrieve_multiple(), sorcery_config_retrieve_prefix(), sorcery_config_retrieve_regex(), sorcery_memory_cache_dump(), sorcery_memory_cache_retrieve_fields(), sorcery_memory_cache_retrieve_multiple(), sorcery_memory_cache_retrieve_prefix(), sorcery_memory_cache_retrieve_regex(), sorcery_memory_retrieve_fields(), sorcery_memory_retrieve_multiple(), sorcery_memory_retrieve_prefix(), sorcery_memory_retrieve_regex(), sorcery_observers_notify_create(), sorcery_observers_notify_delete(), sorcery_observers_notify_loaded(), sorcery_observers_notify_update(), stasis_app_get_all(), stasis_app_to_cli(), stasis_cache_dump_all(), stasis_cache_dump_by_eid(), stir_shaken_certificate_show_all(), subscription_persistence_load(), test_ao2_callback_traversal(), unlink_dirty_databases(), unlink_from_msg_q(), unload_module(), unregister_all(), unsubscribe(), xmpp_client_config_post_apply(), xmpp_client_service_discovery_result_hook(), xmpp_config_post_apply(), xmpp_init_event_distribution(), xmpp_pak_presence(), and xmpp_roster_hook().

◆ ao2_callback_data

#define ao2_callback_data	(	container,
		flags,
		cb_fn,
		arg,
		data
	)	__ao2_callback_data((container), (flags), (cb_fn), (arg), (data), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1743 of file astobj2.h.

Referenced by ast_ari_sounds_list(), ast_cdr_setuserfield(), ast_channel_callback(), ast_phoneprov_delete_extensions(), ast_sip_publish_client_send(), ast_sip_session_unregister_sdp_handler(), ast_sounds_get_index_for_file(), check_featuregroup(), complete_agent(), complete_agent_logoff(), complete_ari_app(), complete_ari_user(), complete_parking_lot(), create_mwi_subscriptions(), create_sound_blob(), devices_to_json(), features_pre_apply_config(), format_ami_endpoint_identify(), function_amiclient(), handle_bridge_leave_message(), handle_channel_snapshot_update_message(), handle_cli_sound_show(), handle_show_routes(), manager_bridge_info(), manager_bridges_list(), manager_parking_lot_list(), memory_cache_populate(), setup_bridge_features_dynamic(), shrink(), stale_cache_update(), stasis_state_callback_all(), and stasis_state_callback_subscribed().

◆ ao2_cleanup

#define ao2_cleanup ( obj ) __ao2_cleanup_debug((obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Examples:: /tmp/asterisk-shallow/main/app.c.

Definition at line 1958 of file astobj2.h.

◆ ao2_container_alloc_hash

#define ao2_container_alloc_hash	(	ao2_options,
		container_options,
		n_buckets,
		hash_fn,
		sort_fn,
		cmp_fn
	)	__ao2_container_alloc_hash((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1310 of file astobj2.h.

Referenced by __ast_channel_internal_alloc(), __ast_sorcery_open(), __features_config_alloc(), aco_option_container_alloc(), ast_ari_websocket_events_event_websocket_init(), ast_bridge_peers_nolock(), ast_bucket_init(), ast_calendar_event_container_alloc(), ast_channels_init(), ast_codec_init(), ast_config_hook_register(), ast_config_text_file_save2(), ast_datastores_alloc(), ast_endpoint_init(), ast_format_cache_init(), ast_format_init(), ast_get_namedgroups(), ast_media_cache_init(), ast_media_index_create(), ast_multi_channel_blob_create(), ast_multi_channel_blob_get_channels(), ast_named_locks_init(), ast_pbx_init(), ast_res_pjsip_init_options_handling(), ast_res_pjsip_initialize_configuration(), ast_sip_get_transport_states(), ast_sip_initialize_cli(), ast_sip_initialize_distributor(), ast_sip_initialize_scheduler(), ast_sip_initialize_sorcery_transport(), ast_sip_initialize_transport_events(), ast_sip_initialize_transport_management(), ast_sip_register_publish_handler(), ast_sip_session_alloc(), ast_sorcery_init(), ast_stasis_channels_init(), ast_str_container_alloc_options(), AST_TEST_DEFINE(), ast_tps_init(), ast_xmldoc_build_documentation(), ast_xmpp_client_config_alloc(), bucket_file_alloc(), build_calendar(), confbridge_cfg_alloc(), dialgroup_write(), init_queue(), initialize_escs(), jingle_config_alloc(), jingle_endpoint_state_create(), load_module(), load_objects(), media_info_alloc(), mwi_subscription_alloc(), named_acl_config_alloc(), notify_cfg_alloc(), parking_config_alloc(), realtime_sqlite3_require(), reload(), sip_options_aor_alloc(), sip_options_contact_statuses_alloc(), sip_options_endpoint_state_compositor_find_or_alloc(), sip_outbound_publish_apply(), sip_outbound_publish_state_alloc(), skel_config_alloc(), sorcery_config_internal_load(), sorcery_memory_cache_open(), sorcery_memory_open(), sorcery_object_type_alloc(), stasis_cache_create_full(), stasis_init(), stasis_state_manager_create(), stasis_topic_pool_create(), test_make_nonsorted(), test_performance(), threadpool_alloc(), ustmtext(), websocket_server_create_impl(), xml_translate(), xmpp_client_alloc(), and xmpp_client_create_buddy().

◆ ao2_container_alloc_list

#define ao2_container_alloc_list	(	ao2_options,
		container_options,
		sort_fn,
		cmp_fn
	)	__ao2_container_alloc_list((ao2_options), (container_options), (sort_fn), (cmp_fn), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1335 of file astobj2.h.

Referenced by __ast_sorcery_open(), __ast_sorcery_wizard_register(), __init_manager(), alloc_device_state_info(), alloc_new_parking_lot(), alloc_smdi_interface(), applicationmap_alloc(), ast_add_hint(), ast_bridge_features_init(), ast_local_init(), ast_msg_alloc(), ast_pbx_init(), ast_pickup_find_by_group(), ast_sip_location_retrieve_contacts_from_aor_list(), ast_sorcery_init(), ast_sorcery_retrieve_by_fields(), ast_sorcery_retrieve_by_prefix(), ast_sorcery_retrieve_by_regex(), AST_TEST_DEFINE(), build_conf(), build_mansession(), cli_aor_get_container(), cli_contact_get_container(), cli_endpoint_get_container(), cli_get_container(), cli_unid_get_container(), command_prestart_queue_command(), control_create(), featuregroup_alloc(), get_container(), handle_registrations(), init_queue(), load_module(), load_modules(), mwi_mailbox_get(), notify_option_alloc(), object_type_loaded_observer(), permanent_uri_handler(), register_aor_core(), sla_load_config(), smdi_load(), sorcery_object_type_alloc(), stasis_cache_dump_all(), stasis_cache_dump_by_eid(), stasis_cache_get_all(), stasis_show_topics(), test_cel_init_cb(), test_config_alloc(), test_make_nonsorted(), test_performance(), and xmpp_config_alloc().

◆ ao2_container_alloc_rbtree

#define ao2_container_alloc_rbtree	(	ao2_options,
		container_options,
		sort_fn,
		cmp_fn
	)	__ao2_container_alloc_rbtree((ao2_options), (container_options), (sort_fn), (cmp_fn), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1358 of file astobj2.h.

Referenced by __queues_show(), agents_cfg_alloc(), app_create(), ast_bridging_init(), bucket_alloc(), cli_show_tasks(), conf_alloc(), handle_cli_sounds_show(), load_module(), stasis_app_stored_recording_find_all(), test_performance(), and tps_report_taskprocessor_list().

◆ ao2_container_clone

#define ao2_container_clone	(	orig,
		flags
	)	__ao2_container_clone(orig, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1430 of file astobj2.h.

Referenced by ao2_weakproxy_unsubscribe(), ast_bucket_file_copy(), bucket_file_copy_handler(), sip_options_apply_aor_configuration(), sip_options_synchronize_task(), and test_container_clone().

◆ AO2_FIELD_CMP_FN

#define AO2_FIELD_CMP_FN	(	stype,
		fn_suffix,
		field,
		key_cmp,
		partial_key_cmp,
		transform,
		argconst
	)

Definition at line 2022 of file astobj2.h.

◆ AO2_FIELD_HASH_FN

#define AO2_FIELD_HASH_FN	(	stype,
		field,
		hash_fn
	)

Creates a hash function for a structure field.

Parameters

stype	The structure type
field	The string field in the structure to hash
hash_fn	Function which hashes the field

AO2_FIELD_HASH_FN(mystruct, myfield, ast_str_hash) will produce a function named mystruct_hash_fn which hashes mystruct->myfield with ast_str_hash.

Definition at line 1981 of file astobj2.h.

◆ AO2_FIELD_TRANSFORM_CMP_FN

#define AO2_FIELD_TRANSFORM_CMP_FN ( cmp ) ((cmp) ? 0 : CMP_MATCH)

Definition at line 2001 of file astobj2.h.

◆ AO2_FIELD_TRANSFORM_SORT_FN

#define AO2_FIELD_TRANSFORM_SORT_FN ( cmp ) (cmp)

Definition at line 2002 of file astobj2.h.

◆ ao2_find

#define ao2_find	(	container,
		arg,
		flags
	)	__ao2_find((container), (arg), (flags), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1756 of file astobj2.h.

Referenced by __ao2_weakproxy_find(), __ast_bucket_scheme_register(), __ast_codec_register_with_format(), __ast_format_interface_register(), __ast_sorcery_apply_default(), __ast_sorcery_object_field_register(), __ast_sorcery_object_register(), __ast_sorcery_object_type_insert_wizard(), __ast_sorcery_object_type_remove_wizard(), __ast_sorcery_remove_wizard_mapping(), __ast_sorcery_wizard_register(), __find_callno(), __has_voicemail(), __stasis_app_register(), action_confbridgekick(), action_confbridgelist(), action_confbridgesetsinglevideosrc(), action_confbridgestartrecord(), action_confbridgestoprecord(), add_calltoken_ignore(), add_sdp_streams(), add_to_cache(), admin_exec(), agent_after_bridge_cb(), agent_after_bridge_cb_failed(), agent_alert(), agent_cfg_find(), agent_function_read(), agent_handle_show_specific(), agent_login_exec(), agent_logoff_request(), agent_pvt_devstate_get(), agent_request_exec(), agent_run(), agents_post_apply_config(), alloc_variant(), ami_sip_qualify(), announce_request(), app_exec(), app_is_subscribed_bridge_id(), app_is_subscribed_channel_id(), app_is_subscribed_endpoint_id(), app_subscribe_bridge(), app_subscribe_channel(), app_subscribe_endpoint(), ari_show_user(), ast_add_hint(), ast_ari_config_validate_user(), ast_ari_websocket_events_event_websocket_established(), ast_bridge_channel_feature_digit(), ast_bridge_find_by_id(), ast_bucket_alloc(), ast_bucket_file_alloc(), ast_bucket_file_metadata_get(), ast_bucket_file_metadata_set(), ast_bucket_file_metadata_unset(), ast_cel_backend_unregister(), ast_change_hint(), ast_channel_dialed_causes_add(), ast_channel_dialed_causes_find(), ast_channel_snapshot_get_latest(), ast_channel_snapshot_get_latest_by_name(), ast_codec_get(), ast_config_hook_unregister(), ast_datastores_find(), ast_datastores_remove(), ast_endpoint_find_by_id(), ast_extension_state_del(), ast_format_attribute_get(), ast_format_attribute_set(), ast_format_cache_set(), ast_format_create_named(), ast_format_generate_sdp_fmtp(), ast_format_parse_sdp_fmtp(), ast_get_chan_applicationmap(), ast_get_feature(), ast_get_indication_zone(), ast_get_namedgroups(), ast_local_get_peer(), ast_local_setup_bridge(), ast_local_setup_masquerade(), ast_media_cache_create_or_update(), ast_media_cache_delete(), ast_media_cache_exists(), ast_media_cache_retrieve(), ast_media_cache_retrieve_metadata(), ast_media_get_variants(), ast_merge_contexts_and_delete(), ast_module_register(), ast_multi_channel_blob_get_channel(), ast_phoneprov_add_extension(), ast_remove_hint(), ast_res_pjsip_find_or_create_contact_status(), ast_sip_dialog_get_endpoint(), ast_sip_dialog_set_endpoint(), ast_sip_dialog_set_serializer(), ast_sip_get_contact_status(), ast_sip_get_transport_state(), ast_sip_lookup_cli_formatter(), ast_sip_persistent_endpoint_publish_contact_state(), ast_sip_persistent_endpoint_update_state(), ast_sip_publish_client_get_datastore(), ast_sip_publish_client_remove(), ast_sip_publish_client_remove_datastore(), ast_sip_sched_is_task_running_by_name(), ast_sip_sched_task_cancel_by_name(), ast_sip_sched_task_get_next_run_by_name(), ast_sip_sched_task_get_times_by_name2(), ast_sip_session_get_datastore(), ast_sip_session_register_sdp_handler(), ast_sip_transport_monitor_register_replace(), ast_sip_transport_monitor_unregister(), ast_smdi_interface_find(), ast_sorcery_alloc(), ast_sorcery_copy(), ast_sorcery_create(), ast_sorcery_delete(), ast_sorcery_diff(), ast_sorcery_force_reload_object(), ast_sorcery_get_object_type(), ast_sorcery_get_wizard_mapping(), ast_sorcery_get_wizard_mapping_count(), ast_sorcery_is_object_field_registered(), ast_sorcery_is_stale(), ast_sorcery_load_object(), ast_sorcery_object_fields_register(), ast_sorcery_object_set_congestion_levels(), ast_sorcery_object_set_copy_handler(), ast_sorcery_object_set_diff_handler(), ast_sorcery_object_unregister(), ast_sorcery_objectset_apply(), ast_sorcery_objectset_create2(), ast_sorcery_objectset_json_create(), ast_sorcery_observer_add(), ast_sorcery_observer_remove(), ast_sorcery_reload_object(), ast_sorcery_retrieve_by_fields(), ast_sorcery_retrieve_by_id(), ast_sorcery_retrieve_by_prefix(), ast_sorcery_retrieve_by_regex(), ast_sorcery_update(), ast_sorcery_wizard_observer_add(), ast_sorcery_wizard_observer_remove(), ast_sorcery_wizard_unregister(), ast_str_container_remove(), ast_taskprocessor_create_with_listener(), ast_taskprocessor_get(), AST_TEST_DEFINE(), ast_unregister_indication_country(), ast_websocket_server_add_protocol2(), ast_websocket_server_remove_protocol(), ast_websocket_uri_cb(), authenticate(), authenticate_request(), authenticate_verify(), bridge_agent_hold_push(), bridge_app_subscribed(), bridge_handle_dtmf(), bridge_profile_find(), bucket_file_wizard_retrieve(), bucket_wizard_retrieve(), build_callno_limits(), build_peer(), build_user(), cache_find(), can_ring_entry(), cel_linkedid_ref(), cel_track_app(), chan_pjsip_add_hold(), chan_pjsip_get_hold(), chan_pjsip_remove_hold(), check_featuregroup_item(), check_manager_session_inuse(), check_retire_linkedid(), cli_alias_passthrough(), cli_contact_retrieve_by_id(), cli_fax_show_session(), cli_qualify(), cli_retrieve_by_id(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), cli_show_qualify_aor(), cli_show_qualify_endpoint(), cli_unid_retrieve_by_id(), client_buddy_handler(), compare_weight(), complete_confbridge_participant(), complete_config_option(), complete_config_type(), complete_indications(), conf_find_bridge(), conf_find_bridge_profile(), conf_find_user_profile(), conf_handle_talker_cb(), conf_set_menu_to_user(), confbridge_handle_atxfer(), contact_observer_updated(), contact_status_publish_update_task(), cpg_confchg_cb(), create_unsolicited_mwi_subscriptions(), dial_state_process_bridge_enter(), dialgroup_read(), dialgroup_write(), distributor(), endpoint_deleted_observer(), endpoint_internal_create(), endpoint_lookup(), extension_state_add_destroy(), featuregroup_find(), find_app_by_name(), find_calendar(), find_database(), find_device_state_subscription(), find_event(), find_hint_by_cb_id(), find_internal_state_by_transport(), find_member_by_queuename_and_interface(), find_peer(), find_pvt(), find_user(), find_variant(), func_confbridge_info(), generic_lock_unlock_helper(), generic_mute_unmute_helper(), get_buddy_status(), get_dialstatus(), get_dsn(), get_esc_entry(), get_monitored_transport_by_name(), get_state(), get_subscription(), get_system_cfg(), handle_bridge_enter_message(), handle_bridge_leave_message(), handle_bridge_pairings(), handle_channel_snapshot_update_message(), handle_cli_confbridge_kick(), handle_cli_confbridge_list(), handle_cli_confbridge_start_record(), handle_cli_confbridge_stop_record(), handle_cli_iax2_unregister(), handle_cli_indication_show(), handle_dial_message(), handle_incoming_sdp(), handle_manager_show_event(), handle_msg_cb(), handle_negotiated_sdp_session_media(), handle_parked_call_message(), has_destination_cb(), has_mwi_subscription(), hash_test_lookup(), hash_test_shrink(), iax2_destroy_helper(), inprocess_count(), insert_test_duplicates(), jingle_action_hook(), jingle_endpoint_find(), jingle_request(), join_conference_bridge(), manager_fax_session(), manager_optimize_away(), manager_sipnotify(), mark_object_as_stale_in_cache(), media_cache_handle_show_item(), meetme_menu_admin(), meetmemute(), menu_find(), menu_template_handler(), monitored_transport_state_callback(), msg_data_find(), mwi_contact_deleted(), named_acl_find(), named_item_find(), namedgroup_match(), notify_option_find(), parse_tone_zone(), peercnt_add(), peercnt_modify(), peercnt_remove_by_addr(), pending_members_remove(), persistent_endpoint_find_or_create(), profile_destructor(), publish_cluster_discovery_to_stasis(), publisher_stop(), pubsub_on_rx_publish_request(), queue_mwi_event(), realtime_common(), realtime_sqlite3_require(), registration_deleted_observer(), reload_single_member(), remove_bridge_playback(), remove_from_cache(), remove_from_queue(), remove_oldest_from_cache(), routes_delete_cb(), save_dialstatus(), sched_delay_remove(), sdp_requires_deferral(), session_outgoing_nat_hook(), set_fn(), single_state_process_bridge_enter(), sip_options_aor_observer_deleted_task(), sip_options_aor_observer_modified_task(), sip_options_apply_aor_configuration(), sip_options_contact_add_management_task(), sip_options_contact_delete_management_task(), sip_options_contact_delete_task(), sip_options_contact_status_notify_task(), sip_options_endpoint_observer_deleted_task(), sip_options_endpoint_observer_modified_task(), sip_options_endpoint_state_compositor_find_or_alloc(), sip_options_endpoint_unlink_aor_feeders(), sip_options_remove_contact_status(), sip_options_synchronize_aor(), sip_options_synchronize_endpoint(), sip_options_update_endpoint_state_compositor_aor(), sip_outbound_publish_client_get_publisher(), sip_outbound_registration_apply(), sip_poke_peer_s(), sip_publish_state_get(), skel_find_or_create_state(), skel_level_find(), sla_find_station(), sla_find_trunk(), smdi_load(), smdi_msg_find(), sorcery_config_internal_load(), sorcery_config_retrieve_id(), sorcery_memory_cache_ami_expire(), sorcery_memory_cache_ami_expire_object(), sorcery_memory_cache_ami_populate(), sorcery_memory_cache_ami_stale(), sorcery_memory_cache_ami_stale_object(), sorcery_memory_cache_complete_object_name(), sorcery_memory_cache_dump(), sorcery_memory_cache_expire(), sorcery_memory_cache_populate(), sorcery_memory_cache_retrieve_id(), sorcery_memory_cache_show(), sorcery_memory_cache_stale(), sorcery_memory_create(), sorcery_memory_delete(), sorcery_memory_retrieve_id(), sorcery_memory_update(), sorcery_reloadable(), stasis_app_bridge_find_by_id(), stasis_app_bridge_moh_channel(), stasis_app_bridge_moh_stop(), stasis_app_bridge_playback_channel_find(), stasis_app_bridge_playback_channel_remove(), stasis_app_control_find_by_channel_id(), stasis_app_control_record(), stasis_app_exec(), stasis_app_message_handler(), stasis_app_playback_find_by_id(), stasis_app_recording_find_by_name(), stasis_app_send(), stasis_app_unregister(), stasis_message_type_declined(), stasis_topic_pool_delete_topic(), stasis_topic_pool_get_topic(), stasis_topic_pool_topic_exists(), stir_shaken_general_get(), test_ao2_find_w_no_flags(), test_ao2_find_w_OBJ_KEY(), test_ao2_find_w_OBJ_PARTIAL_KEY(), test_ao2_find_w_OBJ_POINTER(), test_cel_peer_strings_match(), test_expected_duplicates(), test_item_find(), test_performance(), transport_state_do_reg_callbacks(), unsubscribe(), update_queue(), user_find(), user_profile_find(), ustmtext(), verify_default_parking_lot(), verify_default_profiles(), wait_bridge_wrapper_find_by_name(), xml_translate(), xmldoc_update_config_option(), xmldoc_update_config_type(), xmpp_client_config_merge_buddies(), xmpp_client_service_discovery_result_hook(), xmpp_component_register_get_hook(), xmpp_config_find(), xmpp_pak_message(), xmpp_pak_presence(), xmpp_pak_s10n(), and xmpp_roster_hook().

◆ ao2_get_weakproxy

#define ao2_get_weakproxy ( obj ) __ao2_get_weakproxy(obj, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 692 of file astobj2.h.

◆ ao2_global_obj_ref

#define ao2_global_obj_ref ( holder ) __ao2_global_obj_ref(&holder, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

Examples:: /tmp/asterisk-shallow/main/app.c.

Definition at line 925 of file astobj2.h.

Referenced by __ast_manager_event_multichan(), __ast_vm_greeter_register(), __ast_vm_register(), acf_jabberreceive_read(), acf_jabberstatus_read(), agent_run(), agents_post_apply_config(), app_exec(), ast_ari_config_get(), ast_cdr_engine_term(), ast_cdr_get_config(), ast_cdr_set_config(), ast_cel_backend_register(), ast_cel_backend_unregister(), ast_cel_check_enabled(), ast_cel_fabricate_channel_from_event(), ast_cel_get_config(), ast_cel_set_config(), ast_cel_track_event(), ast_get_builtin_feature(), ast_get_chan_applicationmap(), ast_get_chan_featuremap_config(), ast_get_chan_features_general_config(), ast_get_chan_features_pickup_config(), ast_get_chan_features_xfer_config(), ast_named_acl_find(), ast_parking_blind_transfer_park(), ast_parking_is_exten_park(), ast_parking_park_bridge_channel(), ast_parking_park_call(), ast_parking_provider_registered(), ast_parking_register_bridge_features(), ast_parking_unregister_bridge_features(), ast_sip_get_artificial_auth(), ast_sip_transport_monitor_register_replace(), ast_sip_transport_monitor_unregister(), ast_sip_transport_monitor_unregister_all(), ast_smdi_interface_find(), ast_statsd_log_string(), AST_TEST_DEFINE(), ast_udptl_new_with_bindaddr(), ast_vm_greeter_is_registered(), ast_vm_greeter_unregister(), ast_vm_is_registered(), ast_vm_unregister(), ast_xmpp_client_find(), astman_verify_session_readpermissions(), astman_verify_session_writepermissions(), bridge_agent_hold_deferred_create(), build_mansession(), build_nonce(), cdr_detach(), cdr_submit_batch(), cdr_toggle_runtime_options(), cel_linkedid_ref(), cel_report_event(), cel_track_app(), check_manager_session_inuse(), check_retire_linkedid(), cli_complete_notify(), cli_display_named_acl(), cli_display_named_acl_list(), cli_notify(), cli_retrieve_by_id(), complete_bridge_profile_name(), complete_menu_name(), complete_user_profile_name(), conf_find_bridge_profile(), conf_find_user_profile(), conf_set_menu_to_user(), create_mwi_subscriptions(), delete_old_messages(), find_session(), find_session_by_nonce(), function_amiclient(), generate_or_link_lots_to_configs(), get_dialstatus(), get_feature_ds(), get_global_cfg(), get_monitored_transport_by_name(), get_state(), handle_cli_confbridge_show_bridge_profiles(), handle_cli_confbridge_show_menu(), handle_cli_confbridge_show_menus(), handle_cli_confbridge_show_user_profiles(), handle_cli_debug(), handle_cli_show_config(), handle_cli_status(), handle_cli_submit(), handle_feature_show(), handle_manager_show_event(), handle_manager_show_events(), handle_show_named_acl_cmd(), handle_showmanconn(), handle_skel_show_config(), handle_skel_show_levels(), hep_queue_cb(), hepv3_config_post_apply(), hepv3_get_uuid_type(), hepv3_is_loaded(), hepv3_send_packet(), http_callback(), is_cdr_flag_set(), is_enabled(), jingle_endpoint_state_find_or_create(), jingle_request(), keepalive_transport_thread(), line_identify(), manager_default_msg_cb(), manager_generic_msg_cb(), manager_jabber_send(), menu_template_handler(), module_config_post_apply(), monitored_transport_state_callback(), mwi_contact_changed(), mwi_contact_deleted(), mwi_subscription_established(), mwi_subscription_shutdown(), mwi_validate_for_aor(), parking_dynamic_lots_enabled(), post_cdr(), prometheus_config_post_apply(), prometheus_general_config_get(), prometheus_general_config_set(), purge_sessions(), registration_deleted_observer(), registration_loaded_observer(), reload_module(), remove_all_configured_parking_lot_extensions(), save_dialstatus(), send_initial_notify_all(), session_destroy(), sip_outbound_publish_synchronize(), sip_outbound_registration_apply(), sip_publish_state_get(), skel_find_or_create_state(), smdi_load(), sorcery_config_retrieve_fields(), sorcery_config_retrieve_id(), sorcery_config_retrieve_multiple(), sorcery_config_retrieve_prefix(), sorcery_config_retrieve_regex(), stasis_init(), stasis_message_type_declined(), stasis_subscription_cb_noop(), statsd_init(), submit_scheduled_batch(), subscription_dtor(), topic_dtor(), transport_state_callback(), unbound_config_preapply_callback(), unbound_resolver_resolve(), unregister_all(), xmpp_action_hook(), xmpp_cli_create_collection(), xmpp_cli_create_leafnode(), xmpp_cli_delete_pubsub_node(), xmpp_cli_list_pubsub_nodes(), xmpp_cli_purge_pubsub_nodes(), xmpp_client_config_post_apply(), xmpp_client_find_or_create(), xmpp_client_reconnect(), xmpp_client_send_message(), xmpp_client_set_group_presence(), xmpp_client_set_presence(), xmpp_client_thread(), xmpp_component_register_get_hook(), xmpp_component_service_discovery_get_hook(), xmpp_component_service_discovery_items_hook(), xmpp_config_post_apply(), xmpp_config_prelink(), xmpp_connect_hook(), xmpp_init_event_distribution(), xmpp_join_exec(), xmpp_leave_exec(), xmpp_log_hook(), xmpp_pubsub_build_publish_skeleton(), xmpp_pubsub_handle_error(), xmpp_pubsub_iq_create(), xmpp_pubsub_publish_device_state(), xmpp_pubsub_subscribe(), xmpp_roster_hook(), xmpp_send_cb(), xmpp_send_exec(), xmpp_sendgroup_exec(), xmpp_show_buddies(), and xmpp_show_clients().

◆ ao2_global_obj_release

#define ao2_global_obj_release ( holder ) __ao2_global_obj_replace_unref(&holder, NULL, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

◆ ao2_global_obj_replace

#define ao2_global_obj_replace	(	holder,
		obj
	)	__ao2_global_obj_replace(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

Definition at line 885 of file astobj2.h.

Referenced by unload_module().

◆ ao2_global_obj_replace_unref

#define ao2_global_obj_replace_unref	(	holder,
		obj
	)	__ao2_global_obj_replace_unref(&holder, (obj), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

◆ AO2_GLOBAL_OBJ_STATIC

#define AO2_GLOBAL_OBJ_STATIC ( name )

Value:

struct ao2_global_obj name = {                              \
      .lock = AST_RWLOCK_INIT_VALUE,                           \
   }

Define a global object holder to be used to hold an ao2 object, statically initialized.

Since: 11.0

Parameters

name	This will be the name of the object holder.

This macro creates a global object holder that can be used to hold an ao2 object accessible using the API. The structure is allocated and initialized to be empty.

Example usage:

static AO2_GLOBAL_OBJ_STATIC(global_cfg);

This defines global_cfg, intended to hold an ao2 object accessible using an API.

Examples:: /tmp/asterisk-shallow/main/app.c.

Definition at line 848 of file astobj2.h.

◆ ao2_iterator_next

#define ao2_iterator_next ( iter ) __ao2_iterator_next((iter), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1933 of file astobj2.h.

Referenced by __find_call(), __iax2_show_peers(), __manager_event_sessions_va(), __test_cel_generate_peer_str(), aco_set_defaults(), action_agents(), action_confbridgelistrooms(), action_coreshowchannels(), action_devicestatelist(), action_extensionstatelist(), action_meetmelist(), action_presencestatelist(), add_ice_to_sdp(), add_ice_to_stream(), agent_show_requested(), agents_post_apply_config(), agents_sweep(), alias_show(), ami_show_registration_contact_statuses(), app_to_json(), ari_show_apps(), ast_add_hint(), ast_ari_bridges_list(), ast_ari_channels_list(), ast_ari_endpoints_list(), ast_ari_endpoints_list_by_tech(), ast_ari_recordings_list_stored(), ast_bridge_channel_kick(), ast_bucket_file_json(), ast_bucket_json(), ast_cdr_setvar(), ast_channel_iterator_next(), ast_complete_channels(), ast_endpoint_snapshot_create(), ast_format_cache_get_by_codec(), ast_merge_contexts_and_delete(), ast_msg_var_iterator_get_next(), ast_multi_channel_blob_get_channels(), ast_pickup_find_by_group(), ast_print_namedgroups(), ast_sip_destroy_scheduler(), ast_sip_for_each_contact(), ast_sorcery_objectset_create2(), ast_sorcery_objectset_json_create(), ast_srtp_unprotect(), AST_TEST_DEFINE(), ast_var_indications(), ast_var_indications_table(), astman_verify_session_readpermissions(), astman_verify_session_writepermissions(), auth_observer(), authenticate(), authenticate_reply(), bridge_app_subscribed_involved(), bridge_channel_event_join_leave(), bridge_channel_moving(), bridge_channel_talking(), bridges_scrape_cb(), build_cli_notify(), calendar_query_exec(), cel_generate_peer_str(), channels_scrape_cb(), check_access(), check_events(), clear_queue(), cli_complete_endpoint(), cli_complete_notify(), cli_complete_registration(), cli_complete_show(), cli_complete_uri(), cli_console_active(), cli_display_named_acl_list(), cli_fax_show_sessions(), cli_list_devices(), cli_show_channels(), cli_show_modules(), cli_show_tasks(), cli_tps_reset_stats_all(), complete_bridge_profile_name(), complete_confbridge_name(), complete_config_module(), complete_core_show_hint(), complete_country(), complete_iax2_peers(), complete_iax2_unregister(), complete_menu_name(), complete_queue_remove_member(), complete_user_profile_name(), complete_userno(), conf_queue_dtmf(), config_hook_exec(), configure_parking_extensions(), container_to_json_array(), control_dispatch_all(), control_flush_queue(), control_prestart_dispatch_all(), destroy_pvts(), device_state_cb(), device_state_notify_callbacks(), dial_state_process_bridge_enter(), dialgroup_read(), disable_marked_lots(), dump_queue_members(), endpoints_scrape_cb(), event_session_shutdown(), exten_state_publisher_state_cb(), extension_state_cb(), fax_session_tab_complete(), find_queue_by_name_rt(), find_ringing_channel(), find_session(), find_session_by_nonce(), free_members(), generate_or_link_lots_to_configs(), get_device_state_causing_channels(), get_member_status(), get_transferee(), get_udp_transport(), get_write_timeout(), handle_bridge_pairings(), handle_bridge_show_all(), handle_chanlist(), handle_cli_confbridge_list(), handle_cli_confbridge_show_bridge_profiles(), handle_cli_confbridge_show_menus(), handle_cli_confbridge_show_user_profiles(), handle_cli_iax2_show_callno_limits(), handle_cli_iax2_show_users(), handle_cli_indication_show(), handle_cli_odbc_show(), handle_cli_sound_show(), handle_cli_status(), handle_export_primitives(), handle_manager_show_event(), handle_manager_show_events(), handle_show_calendar(), handle_show_calendars(), handle_show_hint(), handle_show_hints(), handle_show_named_acl_cmd(), handle_showmanconn(), handle_skel_show_games(), handle_skel_show_levels(), handle_voicemail_show_aliases(), has_mwi_subscription(), iax2_getpeername(), iax2_getpeertrunk(), interface_exists(), ip_identify_apply(), jingle_add_google_candidates_to_transport(), jingle_add_ice_udp_candidates_to_transport(), jingle_request(), keepalive_transport_thread(), load_users(), local_devicestate(), locals_show(), manager_fax_sessions(), manager_iax2_show_peer_list(), manager_parking_status_all_lots(), manager_parking_status_single_lot(), manager_queues_status(), manager_queues_summary(), mark_lots_as_disabled(), media_cache_handle_show_item(), meetme_menu_admin_extended(), meetme_show_cmd(), moh_rescan_files(), msg_func_write(), mwi_contact_deleted(), mwi_initial_events(), mwi_mailbox_delete_all(), mwi_mailbox_get(), mwi_subscription_mailboxes_str(), num_available_members(), parking_lot_get_space(), pjsip_acf_dial_contacts_read(), pjsip_aor_function_read(), poke_all_peers(), presence_state_cb(), presence_state_notify_callbacks(), print_queue(), prune_peers(), prune_users(), purge_sessions(), queue_function_mem_read(), queue_function_qac_dep(), queue_function_queuememberlist(), queue_mwi_event(), qupd_exec(), reload(), reload_single_queue(), remove_all_configured_parking_lot_extensions(), remove_pending_parking_lot_extensions(), rt_handle_member_record(), rtp_learning_start(), set_transfer_variables_all(), show_codecs(), single_state_process_bridge_enter(), sip_options_apply_aor_configuration(), sip_options_cleanup_task(), sip_options_endpoint_unlink_aor_feeders(), sip_options_get_endpoint_state_compositor_state(), sip_outbound_publish_synchronize(), sip_show_channels(), sip_show_channelstats(), sla_calc_station_delays(), sla_change_trunk_state(), sla_queue_event_conf(), sla_show_stations(), sla_show_trunks(), sorcery_memory_cache_complete_name(), sorcery_memory_cache_complete_object_name(), stasis_app_mailboxes_to_json(), stasis_app_set_global_debug(), stasis_app_to_cli(), stasis_show_topics(), stir_shaken_tab_complete_name(), stop_streams(), system_create_resolver_and_set_nameservers(), test_ao2_callback_traversal(), test_ao2_iteration(), test_expected_duplicates(), test_iterator_next(), topic_complete_name(), tps_report_taskprocessor_list(), tps_taskprocessor_tab_complete(), try_calling(), unbound_config_preapply(), update_realtime_members(), xmpp_pubsub_create_affiliations(), xmpp_show_buddies(), and xmpp_show_clients().

◆ ao2_link

#define ao2_link	(	container,
		obj
	)	__ao2_link((container), (obj), 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1549 of file astobj2.h.

Referenced by __ast_sorcery_object_field_register(), __ast_sorcery_object_type_insert_wizard(), activate_thread(), add_calltoken_ignore(), add_column_name(), add_item(), add_new_event_cb(), agents_post_apply_config(), alloc_str(), alloc_variant(), ao2_weakproxy_unsubscribe(), app_exec(), append_event(), applicationmap_handler(), ast_add_hint(), ast_bridge_dtmf_hook(), ast_bridge_peers_nolock(), ast_bucket_file_metadata_set(), ast_cel_backend_register(), ast_change_hint(), ast_change_name(), ast_channel_dialed_causes_add(), ast_config_hook_register(), ast_datastores_add(), ast_extension_state3(), ast_get_chan_applicationmap(), ast_get_namedgroups(), ast_merge_contexts_and_delete(), ast_module_register(), ast_multi_channel_blob_add_channel(), ast_multi_channel_blob_get_channels(), ast_phoneprov_add_extension(), ast_phoneprov_provider_register(), ast_register_indication_country(), ast_sip_publish_client_add_datastore(), ast_sip_register_cli_formatter(), ast_sip_schedule_task(), ast_sip_session_add_datastore(), ast_sip_session_register_sdp_handler(), ast_smdi_md_message_push(), ast_smdi_mwi_message_push(), ast_sorcery_global_observer_add(), ast_sorcery_instance_observer_add(), ast_sorcery_object_fields_register(), ast_sorcery_observer_add(), ast_sorcery_wizard_observer_add(), ast_str_container_add(), AST_TEST_DEFINE(), ast_xmldoc_build_documentation(), astobj2_test_1_helper(), bridge_create_common(), bridge_other_hook(), bridge_register(), build_calendar(), build_callno_limits(), build_device(), build_mansession(), build_route(), cache_dump_by_eid_cb(), cache_entry_dump(), caldav_add_event(), can_ring_entry(), cel_linkedid_ref(), chan_pjsip_add_hold(), channel_do_masquerade(), channel_replaced_cb(), cli_contact_populate_container(), cli_gather_contact(), cli_message_to_snapshot(), command_prestart_queue_command(), conf_run(), contact_link_static(), context_table_create_autohints(), create_new_sip_etag(), create_unsolicited_mwi_subscriptions(), dialgroup_write(), endelm(), endpoint_internal_create(), event_session_alloc(), extension_state_add_destroy(), fax_session_new(), featuregroup_handler(), find_channel_by_group(), generate_parked_user(), get_or_create_subscription(), grow(), handle_channel_snapshot_update_message(), handle_scan_file(), hash_test_grow(), icalendar_add_event(), inprocess_count(), insert_test_duplicates(), insert_test_vector(), jingle_action_session_initiate(), jingle_request(), join_conference_bridge(), link_option_to_types(), load_aliases(), load_config(), local_request_with_stream_topology(), media_cache_item_populate_from_astdb(), member_add_to_queue(), merge_container_cb(), monitored_transport_state_callback(), msg_set_var_full(), mwi_mailbox_get(), mwi_on_aor(), mwi_subscription_established(), notify_option_handler(), odbc_register_class(), on_dns_update_peer(), parking_lot_build_or_update(), parse_config(), parse_tag(), peercnt_add(), permanent_uri_handler(), populate_transport_states(), process_category(), pubsub_on_rx_publish_request(), queued_active_thread_idle(), realtime_common(), realtime_peer(), realtime_user(), register_aor_core(), registrar_add_non_permanent(), reload_single_member(), save_dialstatus(), set_config(), set_fn(), sip_monitor_instance_init(), sip_options_aor_observer_modified_task(), sip_options_apply_aor_configuration(), sip_options_contact_add_task(), sip_options_contact_status_notify_task(), sip_options_set_contact_status(), sip_options_synchronize_aor(), sip_options_update_endpoint_state_compositor_aor(), sip_outbound_publish_client_add_publisher(), sip_outbound_registration_apply(), sla_build_station(), sla_build_trunk(), smdi_load(), sorcery_astdb_retrieve_fields_common(), sorcery_astdb_retrieve_prefix(), sorcery_astdb_retrieve_regex(), sorcery_config_fields_cmp(), sorcery_config_internal_load(), sorcery_memory_cache_ami_populate(), sorcery_memory_cache_fields_cmp(), sorcery_memory_cache_load(), sorcery_memory_fields_cmp(), sorcery_memory_update(), sorcery_realtime_retrieve_multiple(), stasis_app_bridge_playback_channel_add(), stasis_app_control_play_uri(), stasis_app_control_record(), stasis_app_exec(), stasis_subscription_cb_noop(), store_by_peercallno(), store_by_transfercallno(), test_performance(), test_sub(), topic_dtor(), transport_state_callback(), ustmtext(), verify_default_parking_lot(), verify_default_profiles(), wait_bridge_wrapper_alloc(), xml_translate(), xmpp_client_config_merge_buddies(), xmpp_client_create_buddy(), and zombify_threads().

◆ ao2_link_flags

#define ao2_link_flags	(	container,
		obj,
		flags
	)	__ao2_link((container), (obj), (flags), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1572 of file astobj2.h.

Referenced by __allocate_taskprocessor(), __ast_bucket_scheme_register(), __ast_channel_alloc_ap(), __ast_codec_register_with_format(), __ast_format_interface_register(), __ast_named_lock_get(), __ast_sorcery_open(), __ast_sorcery_wizard_register(), __stasis_app_register(), add_to_cache(), app_subscribe_bridge(), app_subscribe_channel(), app_subscribe_endpoint(), ast_channel_publish_snapshot(), ast_format_cache_set(), ast_media_cache_create_or_update(), ast_media_cache_retrieve(), ast_res_pjsip_find_or_create_contact_status(), ast_sip_dialog_set_endpoint(), ast_sip_dialog_set_serializer(), ast_websocket_server_add_protocol2(), bridge_moh_create(), cache_put(), cdr_all_relink(), create_dsn(), create_unsolicited_mwi_subscriptions(), dup_obj_cb(), dup_weakproxy_cb(), endpoint_lookup(), exec_command_on_condition(), link_topic_proxy(), persistent_endpoint_find_or_create(), pthread_timer_open(), publish_cluster_discovery_to_stasis(), publisher_start(), sip_options_endpoint_state_compositor_find_or_alloc(), sorcery_memory_create(), stasis_topic_pool_get_topic(), state_alloc(), subscribe_device_state(), transport_apply(), and xmpp_pak_presence().

◆ ao2_lock

#define ao2_lock ( a ) __ao2_lock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

Definition at line 718 of file astobj2.h.

◆ ao2_rdlock

#define ao2_rdlock ( a ) __ao2_lock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

◆ ao2_ref

#define ao2_ref	(	o,
		delta
	)	__ao2_ref((o), (delta), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 464 of file astobj2.h.

◆ ao2_replace

#define ao2_replace	(	dst,
		src
	)	ao2_t_replace((dst), (src), NULL)

Definition at line 517 of file astobj2.h.

Referenced by app_set_replace_channel_snapshot(), app_update(), apply_acls(), ast_cdr_set_config(), ast_channel_make_compatible_helper(), ast_channel_nativeformats_set(), ast_channel_set_oldwriteformat(), ast_channel_set_rawreadformat(), ast_channel_set_rawwriteformat(), ast_channel_set_readformat(), ast_channel_set_writeformat(), ast_dns_resolve_recurring_cancel(), ast_rtp_interpret(), ast_rtp_write(), ast_slinfactory_feed(), AST_TEST_DEFINE(), ast_translator_best_choice(), ast_writestream(), audiohook_list_translate_to_native(), audiohook_list_translate_to_slin(), audiohook_read_frame_helper(), bridge_p2p_rtp_write(), destroy_escs(), dns_query_recurring_resolution_callback(), fax_detect_framehook(), fax_gateway_framehook(), format_cache_shutdown(), hook_event_cb(), jb_get_and_deliver(), moh_files_alloc(), moh_files_generator(), moh_files_write_format_change(), moh_parse_options(), moh_scan_files(), ooh323_set_read_format(), ooh323_set_write_format(), phone_setup(), phone_write(), process_sdp_a_audio(), process_sdp_a_video(), prometheus_general_config_set(), set_cached_format(), set_softmix_bridge_data(), sip_outbound_registration_apply(), softmix_process_write_audio(), stasis_state_publish(), stasis_state_publish_by_id(), and transport_apply().

◆ AO2_STRING_FIELD_CASE_CMP_FN

#define AO2_STRING_FIELD_CASE_CMP_FN	(	stype,
		field
	)	AO2_FIELD_CMP_FN(stype, _cmp_fn, field, strcasecmp, strncasecmp, AO2_FIELD_TRANSFORM_CMP_FN,)

Definition at line 2073 of file astobj2.h.

◆ AO2_STRING_FIELD_CASE_HASH_FN

#define AO2_STRING_FIELD_CASE_HASH_FN	(	stype,
		field
	)	AO2_FIELD_HASH_FN(stype, field, ast_str_case_hash)

Definition at line 2057 of file astobj2.h.

◆ AO2_STRING_FIELD_CASE_SORT_FN

#define AO2_STRING_FIELD_CASE_SORT_FN	(	stype,
		field
	)	AO2_FIELD_CMP_FN(stype, _sort_fn, field, strcasecmp, strncasecmp, AO2_FIELD_TRANSFORM_SORT_FN, const)

Definition at line 2089 of file astobj2.h.

◆ AO2_STRING_FIELD_CMP_FN

#define AO2_STRING_FIELD_CMP_FN	(	stype,
		field
	)	AO2_FIELD_CMP_FN(stype, _cmp_fn, field, strcmp, strncmp, AO2_FIELD_TRANSFORM_CMP_FN,)

Creates a compare function for a structure string field.

Parameters

stype	The structure type
field	The string field in the structure to compare

AO2_STRING_FIELD_CMP_FN(mystruct, myfield) will produce a function named mystruct_cmp_fn which compares mystruct->myfield.

AO2_STRING_FIELD_CASE_CMP_FN(mystruct, myfield) would do the same except it performs case insensitive comparisons.

Definition at line 2071 of file astobj2.h.

Referenced by ast_bucket_file_temporary_destroy(), ast_bucket_json(), create_routes(), sorcery_cleanup(), sorcery_destructor(), and sorcery_field_default_handler().

◆ AO2_STRING_FIELD_HASH_FN

#define AO2_STRING_FIELD_HASH_FN	(	stype,
		field
	)	AO2_FIELD_HASH_FN(stype, field, ast_str_hash)

Creates a hash function for a structure string field.

Parameters

stype	The structure type
field	The string field in the structure to hash

AO2_STRING_FIELD_HASH_FN(mystruct, myfield) will produce a function named mystruct_hash_fn which hashes mystruct->myfield.

AO2_STRING_FIELD_HASH_FN(mystruct, myfield) would do the same except it uses the hash function which ignores case.

Definition at line 2055 of file astobj2.h.

Referenced by ast_bucket_file_temporary_destroy(), ast_bucket_json(), create_routes(), sorcery_cleanup(), sorcery_destructor(), and sorcery_field_default_handler().

◆ AO2_STRING_FIELD_SORT_FN

#define AO2_STRING_FIELD_SORT_FN	(	stype,
		field
	)	AO2_FIELD_CMP_FN(stype, _sort_fn, field, strcmp, strncmp, AO2_FIELD_TRANSFORM_SORT_FN, const)

Creates a sort function for a structure string field.

Parameters

stype	The structure type
field	The string field in the structure to compare

AO2_STRING_FIELD_SORT_FN(mystruct, myfield) will produce a function named mystruct_sort_fn which compares mystruct->myfield.

AO2_STRING_FIELD_CASE_SORT_FN(mystruct, myfield) would do the same except it performs case insensitive comparisons.

Definition at line 2087 of file astobj2.h.

◆ ao2_t_alloc

#define ao2_t_alloc	(	data_size,
		destructor_fn,
		debug_msg
	)	__ao2_alloc((data_size), (destructor_fn), AO2_ALLOC_OPT_LOCK_MUTEX, (debug_msg), __FILE__, __LINE__, __PRETTY_FUNCTION__)

◆ ao2_t_alloc_options

#define ao2_t_alloc_options	(	data_size,
		destructor_fn,
		options,
		debug_msg
	)	__ao2_alloc((data_size), (destructor_fn), (options), (debug_msg), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Allocate and initialize an object.

Parameters

data_size	The sizeof() of the user-defined structure.
destructor_fn	The destructor function (can be NULL)
options	The ao2 object options (See enum ao2_alloc_opts)
debug_msg	An ao2 object debug tracing message.

Returns: A pointer to user-data.

Allocates a struct astobj2 with sufficient space for the user-defined structure.

Note

storage is zeroed; XXX maybe we want a flag to enable/disable this.
the refcount of the object just created is 1
the returned pointer cannot be free()'d or realloc()'ed; rather, we just call ao2_ref(o, -1);

Definition at line 404 of file astobj2.h.

Referenced by __ast_codec_register_with_format(), ao2_container_register(), ast_format_create_named(), ast_module_register(), stasis_message_create_full(), stasis_message_type_create(), and transport_create().

◆ ao2_t_bump

#define ao2_t_bump	(	obj,
		tag
	)

Bump refcount on an AO2 object by one, returning the object.

Since: 12 This is useful for inlining a ref bump, and you don't care about the ref count. Also NULL safe, for even more convenience.

Parameters

obj	AO2 object to bump the refcount on.

Return values

The	given obj pointer.

Definition at line 483 of file astobj2.h.

Referenced by __sip_subscribe_mwi_do(), bridge_impart_internal(), internal_ao2_alloc(), and transmit_register().

◆ ao2_t_callback

#define ao2_t_callback	(	c,
		flags,
		cb_fn,
		arg,
		tag
	)	__ao2_callback((c), (flags), (cb_fn), (arg), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

ao2_callback() is a generic function that applies cb_fn() to all objects in a container, as described below.

Parameters

c	A pointer to the container to operate on.
flags	A set of flags specifying the operation to perform, partially used by the container code, but also passed to the callback. If OBJ_NODATA is set, ao2_callback will return NULL. No refcounts of any of the traversed objects will be incremented. On the converse, if it is NOT set (the default), the ref count of the first matching object will be incremented and returned. If OBJ_MULTIPLE is set, the ref count of all matching objects will be incremented in an iterator for a temporary container and returned. If OBJ_SEARCH_OBJECT is set, the traversed items will be restricted to the objects in the bucket that the object key hashes to. If OBJ_SEARCH_KEY is set, the traversed items will be restricted to the objects in the bucket that the object key hashes to.
cb_fn	A function pointer, that will be called on all objects, to see if they match. This function returns CMP_MATCH if the object is matches the criteria; CMP_STOP if the traversal should immediately stop, or both (via bitwise ORing), if you find a match and want to end the traversal, and 0 if the object is not a match, but the traversal should continue. This is the function that is applied to each object traversed. Its arguments are: (void obj, void arg, int flags), where: obj is an object arg is the same as arg passed into ao2_callback flags is the same as flags passed into ao2_callback (flags are also used by ao2_callback).
arg	passed to the callback.
tag	used for debugging.

Return values

NULL	on failure or no matching object found.
object	found if OBJ_MULTIPLE is not set in the flags parameter.
ao2_iterator	pointer if OBJ_MULTIPLE is set in the flags parameter. The iterator must be destroyed with ao2_iterator_destroy() when the caller no longer needs it.

If the function returns any objects, their refcount is incremented, and the caller is in charge of decrementing them once done.

Typically, ao2_callback() is used for two purposes:

to perform some action (including removal from the container) on one or more objects; in this case, cb_fn() can modify the object itself, and to perform deletion should set CMP_MATCH on the matching objects, and have OBJ_UNLINK set in flags.
to look for a specific object in a container; in this case, cb_fn() should not modify the object, but just return a combination of CMP_MATCH and CMP_STOP on the desired object. Other usages are also possible, of course.

This function searches through a container and performs operations on objects according on flags passed. XXX describe better The comparison is done calling the compare function set implicitly. The arg pointer can be a pointer to an object or to a key, we can say this looking at flags value. If arg points to an object we will search for the object pointed by this value, otherwise we search for a key value. If the key is not unique we only find the first matching value.

The use of flags argument is the follow:

 OBJ_UNLINK              unlinks the object found
 OBJ_NODATA              on match, do not return an object
                         Callbacks use OBJ_NODATA as a default
                         functions such as find() do
 OBJ_MULTIPLE            return multiple matches
                         Default is no.
 OBJ_SEARCH_OBJECT       the pointer is to an object
 OBJ_SEARCH_KEY          the pointer is to a search key
 OBJ_SEARCH_PARTIAL_KEY  the pointer is to a partial search key

Note: When the returned object is no longer in use, ao2_ref() should be used to free the additional reference possibly created by this function.

Definition at line 1714 of file astobj2.h.

Referenced by __init_manager(), ao2_weakproxy_unsubscribe(), ast_cc_agent_callback(), ast_cc_monitor_count(), ast_moh_destroy(), ast_srtp_destroy(), astobj2_test_1_helper(), cc_cli_output_status(), cleanup_all_regs(), container_destruct(), device_state_cb(), do_monitor(), get_mohbydigit(), handle_cc_kill(), load_moh_classes(), presence_state_cb(), reload_config(), sip_show_objects(), test_container_clone(), unlink_peers_from_tables(), and unload_module().

◆ ao2_t_callback_data

#define ao2_t_callback_data	(	container,
		flags,
		cb_fn,
		arg,
		data,
		tag
	)	__ao2_callback_data((container), (flags), (cb_fn), (arg), (data), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

ao2_callback_data() is a generic function that applies cb_fn() to all objects in a container. It is functionally identical to ao2_callback() except that instead of taking an ao2_callback_fn *, it takes an ao2_callback_data_fn *, and allows the caller to pass in arbitrary data.

This call would be used instead of ao2_callback() when the caller needs to pass OBJ_SEARCH_OBJECT, OBJ_SEARCH_KEY, or OBJ_SEARCH_PARTIAL_KEY as part of the flags argument (which in turn requires passing in a known pointer type for 'arg') and also needs access to other non-global data to complete it's comparison or task.

See the documentation for ao2_callback() for argument descriptions.

See also: ao2_callback()

Definition at line 1741 of file astobj2.h.

Referenced by cccancel_exec(), ccreq_exec(), ccss_device_state(), count_agents(), kill_duplicate_offers(), match_filter(), remove_hintdevice(), and sip_find_peer_full().

◆ ao2_t_cleanup

#define ao2_t_cleanup	(	obj,
		tag
	)	__ao2_cleanup_debug((obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1959 of file astobj2.h.

Referenced by ast_bridge_join(), ast_rtp_codecs_payloads_copy(), ast_rtp_codecs_payloads_destroy(), ast_rtp_codecs_payloads_set_m_type(), ast_rtp_codecs_payloads_set_rtpmap_type_rate(), AST_TEST_DEFINE(), bridge_channel_depart_thread(), bridge_channel_ind_thread(), bridge_channel_internal_join(), bridge_impart_internal(), rtp_codecs_payload_replace_rx(), rtp_codecs_payloads_copy_tx(), and unload_module().

◆ ao2_t_container_alloc_hash

#define ao2_t_container_alloc_hash	(	ao2_options,
		container_options,
		n_buckets,
		hash_fn,
		sort_fn,
		cmp_fn,
		tag
	)	__ao2_container_alloc_hash((ao2_options), (container_options), (n_buckets), (hash_fn), (sort_fn), (cmp_fn), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Allocate and initialize a hash container with the desired number of buckets.

We allocate space for a struct astobj_container, struct container and the buckets[] array.

Parameters

ao2_options	Container ao2 object options (See enum ao2_alloc_opts)
container_options	Container behaviour options (See enum ao2_container_opts)
n_buckets	Number of buckets for hash
hash_fn	Pointer to a function computing a hash value. (NULL if everyting goes in first bucket.)
sort_fn	Pointer to a sort function. (NULL to not sort the buckets.)
cmp_fn	Pointer to a compare function used by ao2_find. (NULL to match everything)
tag	used for debugging.

Returns: A pointer to a struct container.

Note: Destructor is set implicitly.

Definition at line 1308 of file astobj2.h.

Referenced by astobj2_test_1_helper(), load_module(), messaging_init(), res_srtp_new(), and test_make_sorted().

◆ ao2_t_container_alloc_list

#define ao2_t_container_alloc_list	(	ao2_options,
		container_options,
		sort_fn,
		cmp_fn,
		tag
	)	__ao2_container_alloc_list((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Allocate and initialize a list container.

Parameters

ao2_options	Container ao2 object options (See enum ao2_alloc_opts)
container_options	Container behaviour options (See enum ao2_container_opts)
sort_fn	Pointer to a sort function. (NULL if list not sorted.)
cmp_fn	Pointer to a compare function used by ao2_find. (NULL to match everything)
tag	used for debugging.

Returns: A pointer to a struct container.

Note: Destructor is set implicitly.; Implemented as a degenerate hash table.

Definition at line 1333 of file astobj2.h.

Referenced by ao2_weakproxy_unsubscribe(), astobj2_test_1_helper(), container_init(), internal_ao2_traverse(), load_module(), and test_make_sorted().

◆ ao2_t_container_alloc_rbtree

#define ao2_t_container_alloc_rbtree	(	ao2_options,
		container_options,
		sort_fn,
		cmp_fn,
		tag
	)	__ao2_container_alloc_rbtree((ao2_options), (container_options), (sort_fn), (cmp_fn), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Allocate and initialize a red-black tree container.

Parameters

ao2_options	Container ao2 object options (See enum ao2_alloc_opts)
container_options	Container behaviour options (See enum ao2_container_opts)
sort_fn	Pointer to a sort function.
cmp_fn	Pointer to a compare function used by ao2_find. (NULL to match everything)
tag	used for debugging.

Returns: A pointer to a struct container.

Note: Destructor is set implicitly.

Definition at line 1356 of file astobj2.h.

Referenced by astobj2_test_1_helper(), and test_make_sorted().

◆ ao2_t_container_clone

#define ao2_t_container_clone	(	orig,
		flags,
		tag
	)	__ao2_container_clone(orig, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1428 of file astobj2.h.

◆ ao2_t_find

#define ao2_t_find	(	container,
		arg,
		flags,
		tag
	)	__ao2_find((container), (arg), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

ao2_find() is a short hand for ao2_callback(c, flags, c->cmp_fn, arg) XXX possibly change order of arguments ?

Definition at line 1754 of file astobj2.h.

Referenced by _sip_tcp_helper_thread(), ao2_container_unregister(), build_peer(), find_cc_core_instance(), find_generic_monitor_instance_list(), find_load_queue_rt_friendly(), find_policy(), find_queue_by_name_rt(), get_sip_pvt_from_replaces(), queue_function_queuegetchannel(), queue_function_queuewaitingcount(), reload_queue_members(), reload_single_queue(), remove_from_queue(), sip_prune_realtime(), sip_register(), and sip_tcptls_write().

◆ ao2_t_get_weakproxy

#define ao2_t_get_weakproxy	(	obj,
		tag
	)	__ao2_get_weakproxy(obj, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 695 of file astobj2.h.

Referenced by AST_TEST_DEFINE().

◆ ao2_t_global_obj_ref

#define ao2_t_global_obj_ref	(	holder,
		tag
	)	__ao2_global_obj_ref(&holder, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

Get a reference to the object stored in the global holder.

Since: 11.0

Parameters

holder	Global ao2 object holder.
tag	used for debugging

Return values

Reference	to current ao2 object stored in the holder.
NULL	if no object available.

Definition at line 923 of file astobj2.h.

Referenced by AST_TEST_DEFINE(), check_peer_ok(), and register_verify().

◆ ao2_t_global_obj_release

#define ao2_t_global_obj_release	(	holder,
		tag
	)	__ao2_global_obj_replace_unref(&holder, NULL, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

Release the ao2 object held in the global holder.

Since: 11.0

Parameters

holder	Global ao2 object holder.
tag	used for debugging

Returns: Nothing

Definition at line 863 of file astobj2.h.

Referenced by ast_sip_destroy_sorcery_global(), AST_TEST_DEFINE(), manager_shutdown(), and unload_module().

◆ ao2_t_global_obj_replace

#define ao2_t_global_obj_replace	(	holder,
		obj,
		tag
	)	__ao2_global_obj_replace(&holder, (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

Replace an ao2 object in the global holder.

Since: 11.0

Parameters

holder	Global ao2 object holder.
obj	Object to put into the holder. Can be NULL.
tag	used for debugging

Note: This function automatically increases the reference count to account for the reference that the global holder now holds to the object.

Return values

Reference	to previous global ao2 object stored.
NULL	if no object available.

Definition at line 883 of file astobj2.h.

Referenced by AST_TEST_DEFINE().

◆ ao2_t_global_obj_replace_unref

#define ao2_t_global_obj_replace_unref	(	holder,
		obj,
		tag
	)	__ao2_global_obj_replace_unref(&holder, (obj), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__, #holder)

Replace an ao2 object in the global holder, throwing away any old object.

Since: 11.0

Parameters

holder	Global ao2 object holder.
obj	Object to put into the holder. Can be NULL.
tag	used for debugging

Note: This function automatically increases the reference count to account for the reference that the global holder now holds to the object. It also decreases the reference count of any object being replaced.

Return values

0	The global object was previously empty
1	The global object was not previously empty

Definition at line 906 of file astobj2.h.

Referenced by __init_manager(), AST_TEST_DEFINE(), global_apply(), load_module(), and sip_reload().

◆ ao2_t_iterator_next

#define ao2_t_iterator_next	(	iter,
		tag
	)	__ao2_iterator_next((iter), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1931 of file astobj2.h.

Referenced by __queues_show(), _sip_show_peers(), ao2_weakproxy_unsubscribe(), astobj2_test_1_helper(), clear_stats(), compare_weight(), complete_core_id(), complete_mohclass_realtime(), complete_queue(), complete_queue_remove_member(), complete_show_sorcery_object(), complete_sip_peer(), complete_sip_registered_peer(), complete_sip_user(), complete_sipch(), device_state_cb(), extension_state_cb(), handle_cli_moh_show_classes(), handle_cli_moh_show_files(), handle_cli_moh_unregister_class(), manager_queues_status(), manager_queues_summary(), manager_show_registry(), manager_sip_peer_status(), set_member_paused(), set_member_value(), sip_keepalive_all_peers(), sip_poke_all_peers(), sip_prune_realtime(), sip_send_all_mwi_subscriptions(), sip_send_all_registers(), sip_show_channel(), sip_show_history(), sip_show_inuse(), sip_show_mwi(), sip_show_objects(), sip_show_registry(), sip_show_tcp(), sip_show_users(), sip_unregister_tests(), test_container_clone(), unload_module(), and update_queue().

◆ ao2_t_link

#define ao2_t_link	(	container,
		obj,
		tag
	)	__ao2_link((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Add an object to a container.

Parameters

container	The container to operate on.
obj	The object to be added.
tag	used for debugging.

Return values

0	on errors.
1	on success.

This function inserts an object in a container according its key.

Note: Remember to set the key before calling this function.; This function automatically increases the reference count to account for the reference that the container now holds to the object.

Definition at line 1547 of file astobj2.h.

Referenced by __sip_alloc(), _moh_register(), add_hintdevice(), add_sdp(), ao2_container_register(), ast_srtp_add_stream(), ast_srtp_create(), astobj2_test_1_helper(), authenticate(), cc_core_init_instance(), change_callid_pvt(), create_new_generic_list(), manager_add_filter(), parse_register_contact(), pvt_set_needdestroy(), realtime_peer(), register_verify(), reload_config(), sip_prune_realtime(), sip_register(), sip_subscribe_mwi(), and sip_threadinfo_create().

◆ ao2_t_link_flags

#define ao2_t_link_flags	(	container,
		obj,
		flags,
		tag
	)	__ao2_link((container), (obj), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Add an object to a container.

Parameters

container	The container to operate on.
obj	The object to be added.
flags	search_flags to control linking the object. (OBJ_NOLOCK)
tag	used for debugging.

Return values

0	on errors.
1	on success.

This function inserts an object in a container according its key.

Note: Remember to set the key before calling this function.; This function automatically increases the reference count to account for the reference that the container now holds to the object.

Definition at line 1570 of file astobj2.h.

◆ ao2_t_ref

#define ao2_t_ref	(	o,
		delta,
		tag
	)	__ao2_ref((o), (delta), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Reference/unreference an object and return the old refcount.

Parameters

o	A pointer to the object
delta	Value to add to the reference counter.
tag	used for debugging

Returns: The value of the reference counter before the operation.

Increase/decrease the reference counter according the value of delta.

If the refcount goes to zero, the object is destroyed.

Note: The object must not be locked by the caller of this function, as it is invalid to try to unlock it after releasing the reference.; if we know the pointer to an object, it is because we have a reference count to it, so the only case when the object can go away is when we release our reference, and it is the last one in existence.

Definition at line 463 of file astobj2.h.

Referenced by __ao2_ref(), __ast_named_lock_get(), __cleanup_registration(), __init_manager(), __shutdown_mwi_subscription(), __sip_ack(), __sip_alloc(), __sip_reliable_xmit(), __sip_subscribe_mwi_do(), __start_mwi_subscription(), __start_register_timeout(), __start_reregister_timeout(), __stop_register_timeout(), __stop_retrans_pkt(), _sip_show_peer(), _sip_tcp_helper_thread(), action_find(), add_hintdevice(), agent_connect_caller(), ao2_container_check(), ao2_container_dup(), ao2_container_dup_weakproxy_objs(), ao2_container_register(), ao2_container_unregister(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_weakproxy_unsubscribe(), ast_channel_internal_cleanup(), ast_hook_send_action(), ast_iostream_close(), ast_manager_register2(), ast_manager_register_struct(), ast_manager_unregister(), ast_srtp_add_stream(), ast_srtp_change_source(), ast_srtp_destroy(), ast_srtp_policy_destroy(), ast_srtp_unprotect(), AST_TEST_DEFINE(), ast_xmldoc_build_documentation(), astobj2_test_1_helper(), authenticate(), build_peer(), build_reply_digest(), cc_ref(), cc_unref(), cdr_object_alloc(), check_peer_ok(), cleanup_module(), cleanup_registration(), complete_show_sorcery_object(), cpg_confchg_cb(), create_addr_from_peer(), default_listener_shutdown(), default_tps_processing_function(), device_state_cb(), dialog_dump_func(), do_dialog_unlink_sched_items(), endpt_send_request(), generic_monitor_devstate_cb(), handle_request_cancel(), handle_request_do(), handle_response_subscribe(), insert_test_duplicates(), insert_test_vector(), internal_ao2_alloc(), internal_ao2_traverse(), load_module(), manager_add_filter(), manager_free_user(), manager_show_registry(), peer_dump_func(), presence_state_cb(), process_message(), publish_corosync_ping_to_stasis(), push_to_serializer(), register_verify(), reload_config(), retrans_pkt(), session_destructor(), shutdown_mwi_subscription(), sip_call(), sip_cc_monitor_cancel_available_timer(), sip_cc_monitor_request_cc(), sip_destroy_peer(), sip_monitor_instance_destructor(), sip_prepare_socket(), sip_pvt_dtor(), sip_reg_timeout(), sip_register(), sip_reload(), sip_reregister(), sip_send_all_mwi_subscriptions(), sip_send_all_registers(), sip_show_channel(), sip_show_history(), sip_show_mwi(), sip_show_objects(), sip_show_registry(), sip_show_settings(), sip_show_tcp(), sip_subscribe_mwi(), sip_subscribe_mwi_do(), sip_tcp_locate(), sip_tcptls_write(), sip_threadinfo_create(), sip_threadinfo_destructor(), sip_unregister_tests(), start_mwi_subscription(), start_register_timeout(), start_reregister_timeout(), stop_register_timeout(), stop_retrans_pkt(), temp_peer(), test_ao2_find_w_no_flags(), test_ao2_find_w_OBJ_KEY(), test_ao2_find_w_OBJ_PARTIAL_KEY(), test_ao2_find_w_OBJ_POINTER(), test_container_clone(), test_traversal_nonsorted(), test_traversal_sorted(), tps_shutdown(), transmit_register(), and unload_module().

◆ ao2_t_replace

#define ao2_t_replace	(	dst,
		src,
		tag
	)

Replace one object reference with another cleaning up the original.

Since: 12.4.0

Parameters

dst	Pointer to the object that will be cleaned up.
src	Pointer to the object replacing it.

Definition at line 503 of file astobj2.h.

Referenced by cdr_object_snapshot_copy(), cdr_object_swap_snapshot(), dialog_unlink_all(), format_cap_replace(), handle_response_register(), sip_pvt_dtor(), sip_reg_timeout(), sip_registry_destroy(), and softmix_mixing_loop().

◆ ao2_t_unlink

#define ao2_t_unlink	(	container,
		obj,
		tag
	)	__ao2_unlink((container), (obj), 0, (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Remove an object from a container.

Parameters

container	The container to operate on.
obj	The object to unlink.
tag	used for debugging.

Return values

NULL,always

Note: The object requested to be unlinked must be valid. However, if it turns out that it is not in the container, this function is still safe to be called.; If the object gets unlinked from the container, the container's reference to the object will be automatically released. (The refcount will be decremented).

Definition at line 1596 of file astobj2.h.

Referenced by _moh_unregister(), _sip_tcp_helper_thread(), add_sdp(), ao2_weakproxy_unsubscribe(), ast_srtp_add_stream(), astobj2_test_1_helper(), build_peer(), cc_complete(), cc_failed(), cc_generic_monitor_destructor(), dialog_unlink_all(), expire_register(), parse_register_contact(), sip_prepare_socket(), and sip_prune_realtime().

◆ ao2_t_unlink_flags

#define ao2_t_unlink_flags	(	container,
		obj,
		flags,
		tag
	)	__ao2_unlink((container), (obj), (flags), (tag), __FILE__, __LINE__, __PRETTY_FUNCTION__)

Remove an object from a container.

Parameters

container	The container to operate on.
obj	The object to unlink.
flags	search_flags to control unlinking the object. (OBJ_NOLOCK)
tag	used for debugging.

Return values

NULL,always

Note: The object requested to be unlinked must be valid. However, if it turns out that it is not in the container, this function is still safe to be called.; If the object gets unlinked from the container, the container's reference to the object will be automatically released. (The refcount will be decremented).

Definition at line 1620 of file astobj2.h.

◆ ao2_t_weakproxy_alloc

#define ao2_t_weakproxy_alloc	(	data_size,
		destructor_fn,
		tag
	)	__ao2_weakproxy_alloc(data_size, destructor_fn, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 557 of file astobj2.h.

Referenced by __ast_named_lock_get(), __ast_sorcery_open(), AST_TEST_DEFINE(), link_topic_proxy(), and state_alloc().

◆ ao2_t_weakproxy_get_object

#define ao2_t_weakproxy_get_object	(	weakproxy,
		flags,
		tag
	)	__ao2_weakproxy_get_object(weakproxy, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 628 of file astobj2.h.

Referenced by AST_TEST_DEFINE().

◆ ao2_t_weakproxy_ref_object

#define ao2_t_weakproxy_ref_object	(	weakproxy,
		delta,
		flags,
		tag
	)

Value:

__ao2_weakproxy_ref_object(weakproxy, delta, flags, \

tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

__ao2_weakproxy_ref_object

int __ao2_weakproxy_ref_object(void *weakproxy, int delta, int flags, const char *tag, const char *file, int line, const char *func)

Run ao2_t_ref on the object associated with weakproxy.

Definition: astobj2.c:859

Definition at line 605 of file astobj2.h.

Referenced by AST_TEST_DEFINE().

◆ ao2_t_weakproxy_set_object

#define ao2_t_weakproxy_set_object	(	weakproxy,
		obj,
		flags,
		tag
	)	__ao2_weakproxy_set_object(weakproxy, obj, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 586 of file astobj2.h.

Referenced by __ast_sorcery_open(), AST_TEST_DEFINE(), link_topic_proxy(), and state_alloc().

◆ ao2_trylock

#define ao2_trylock ( a ) __ao2_trylock(a, AO2_LOCK_REQ_MUTEX, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

Definition at line 740 of file astobj2.h.

Referenced by AST_TEST_DEFINE(), caldav_load_calendar(), ewscal_load_calendar(), exchangecal_load_calendar(), and ical_load_calendar().

◆ ao2_tryrdlock

#define ao2_tryrdlock ( a ) __ao2_trylock(a, AO2_LOCK_REQ_RDLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

Definition at line 741 of file astobj2.h.

◆ ao2_trywrlock

#define ao2_trywrlock ( a ) __ao2_trylock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

Definition at line 742 of file astobj2.h.

Referenced by expire_objects_from_cache().

◆ ao2_unlink

#define ao2_unlink	(	container,
		obj
	)	__ao2_unlink((container), (obj), 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 1598 of file astobj2.h.

Referenced by activate_thread(), allow_and_or_replace_unsolicited(), app_exec(), ast_ari_websocket_events_event_websocket_established(), ast_bridge_channel_feature_digit(), ast_bridge_channel_kick(), ast_change_name(), ast_channel_publish_final_snapshot(), ast_channel_release(), ast_channel_unlink(), ast_endpoint_shutdown(), ast_hangup(), ast_pickup_find_by_group(), ast_sip_sched_task_cancel(), ast_sip_schedule_task(), ast_sorcery_wizard_unregister(), ast_websocket_server_remove_protocol(), authenticate(), bridge_base_dissolving(), bridge_channel_event_join_leave(), bridge_channel_moving(), bridge_channel_talking(), build_calendar(), build_user(), channel_do_masquerade(), check_retire_linkedid(), conf_ended(), conf_run(), control_unlink(), create_new_sip_etag(), destroy_gateway(), destroy_pvts(), destroy_v21_sessions(), dialgroup_write(), endpoint_lookup(), event_session_cleanup(), fax_session_new(), generic_fax_exec(), grow(), handle_channel_snapshot_update_message(), handle_cli_iax2_prune_realtime(), handle_sip_publish_remove(), jingle_hangup(), join_conference_bridge(), link_option_to_types(), local_hangup(), member_remove_from_queue(), merge_events_cb(), messaging_app_unsubscribe_endpoint(), moh_channel_thread(), msg_set_var_full(), mwi_subscription_shutdown(), named_lock_proxy_cb(), on_dns_update_peer(), parking_lot_remove_if_unused(), parking_lot_retrieve_parked_user(), peercnt_remove(), proxy_dtor(), prune_users(), pthread_timer_close(), publish_expire(), push_to_serializer(), queued_active_thread_idle(), queued_idle_thread_dead(), queued_zombie_thread_dead(), register_aor_core(), reload(), reload_single_member(), remove_bridge_playback(), remove_by_peercallno(), remove_by_transfercallno(), remove_excess_contacts(), run_task(), save_dialstatus(), session_destroy(), sip_cc_monitor_destructor(), sip_options_unused_aor(), sip_options_update_endpoint_state_compositor_aor(), sip_outbound_registration_apply(), sorcery_memory_cache_close(), sorcery_proxy_cb(), stasis_app_bridge_destroy(), stasis_app_bridge_playback_channel_remove(), state_proxy_sub_cb(), subscription_dtor(), topic_dtor(), unlink_peer(), unpark_parked_user(), and wait_wrapper_removal().

◆ ao2_unlink_flags

#define ao2_unlink_flags	(	container,
		obj,
		flags
	)	__ao2_unlink((container), (obj), (flags), NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

◆ ao2_unlock

#define ao2_unlock ( a ) __ao2_unlock(a, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

Definition at line 730 of file astobj2.h.

◆ AO2_WEAKPROXY

#define AO2_WEAKPROXY ( ) struct ao2_weakproxy __weakproxy##__LINE__

Macro which must be used at the beginning of weakproxy capable objects.

Note: The primary purpose of user defined fields on weakproxy objects is to hold immutable container keys for the real object.

Definition at line 539 of file astobj2.h.

◆ ao2_weakproxy_alloc

#define ao2_weakproxy_alloc	(	data_size,
		destructor_fn
	)	__ao2_weakproxy_alloc(data_size, destructor_fn, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 554 of file astobj2.h.

Referenced by alloc_str().

◆ ao2_weakproxy_find

#define ao2_weakproxy_find	(	c,
		arg,
		flags,
		tag
	)	__ao2_weakproxy_find(c, arg, flags, tag, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Perform an ao2_find on a container with ao2_weakproxy objects, returning the real object.

Note: Only OBJ_SEARCH_* and OBJ_NOLOCK flags are supported by this function.

See also: ao2_callback for description of arguments.

Definition at line 1768 of file astobj2.h.

Referenced by __state_find_or_add(), ast_sorcery_retrieve_by_module_name(), stasis_state_remove_publish_by_id(), and stasis_topic_get().

◆ ao2_weakproxy_get_object

#define ao2_weakproxy_get_object	(	weakproxy,
		flags
	)	__ao2_weakproxy_get_object(weakproxy, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 625 of file astobj2.h.

Referenced by dup_weakproxy_cb(), handle_stasis_state_proxy(), and handle_stasis_state_subscribed().

◆ ao2_weakproxy_ref_object

#define ao2_weakproxy_ref_object	(	weakproxy,
		delta,
		flags
	)	ao2_t_weakproxy_ref_object(weakproxy, delta, flags, NULL)

Definition at line 609 of file astobj2.h.

Referenced by AST_TEST_DEFINE().

◆ ao2_weakproxy_set_object

#define ao2_weakproxy_set_object	(	weakproxy,
		obj,
		flags
	)	__ao2_weakproxy_set_object(weakproxy, obj, flags, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 583 of file astobj2.h.

Referenced by __ast_named_lock_get(), and alloc_str().

◆ ao2_wrlock

#define ao2_wrlock ( a ) __ao2_lock(a, AO2_LOCK_REQ_WRLOCK, __FILE__, __PRETTY_FUNCTION__, __LINE__, #a)

Definition at line 720 of file astobj2.h.

◆ OBJ_KEY

#define OBJ_KEY OBJ_SEARCH_KEY

Deprecated name

Definition at line 1155 of file astobj2.h.

Referenced by __ast_bucket_scheme_register(), __ast_sorcery_apply_default(), __ast_sorcery_object_field_register(), __ast_sorcery_object_register(), __ast_sorcery_object_type_insert_wizard(), __ast_sorcery_remove_wizard_mapping(), __ast_sorcery_wizard_register(), aco_option_find(), action_confbridgekick(), action_confbridgelist(), action_confbridgesetsinglevideosrc(), action_confbridgestartrecord(), action_confbridgestoprecord(), add_sdp_streams(), agent_alert(), agent_cfg_find(), agent_cfg_sort_cmp(), agent_function_read(), agent_handle_show_specific(), agent_login_exec(), agent_logoff_request(), agent_pvt_cmp(), agent_pvt_devstate_get(), agent_pvt_sort_cmp(), agent_request_exec(), agent_run(), agents_post_apply_config(), alloc_variant(), announce_request(), app_exec(), applicationmap_sort(), ari_show_user(), ast_bucket_alloc(), ast_bucket_file_alloc(), ast_bucket_file_metadata_get(), ast_bucket_file_metadata_set(), ast_bucket_file_metadata_unset(), ast_channel_dialed_causes_add(), ast_channel_dialed_causes_find(), ast_channel_get_by_name_prefix(), ast_channel_hash_cb(), ast_channel_iterator_by_name_new(), ast_endpoint_find_by_id(), ast_get_chan_applicationmap(), ast_get_feature(), ast_media_get_variants(), ast_sip_session_get_datastore(), ast_sip_session_register_sdp_handler(), ast_sip_session_remove_datastore(), ast_sip_session_unregister_sdp_handler(), ast_sorcery_alloc(), ast_sorcery_copy(), ast_sorcery_create(), ast_sorcery_delete(), ast_sorcery_diff(), ast_sorcery_force_reload_object(), ast_sorcery_get_wizard_mapping(), ast_sorcery_get_wizard_mapping_count(), ast_sorcery_is_stale(), ast_sorcery_load_object(), ast_sorcery_object_fields_register(), ast_sorcery_object_set_copy_handler(), ast_sorcery_object_set_diff_handler(), ast_sorcery_objectset_apply(), ast_sorcery_objectset_create2(), ast_sorcery_objectset_json_create(), ast_sorcery_observer_add(), ast_sorcery_observer_remove(), ast_sorcery_reload_object(), ast_sorcery_retrieve_by_fields(), ast_sorcery_retrieve_by_prefix(), ast_sorcery_retrieve_by_regex(), ast_sorcery_update(), ast_taskprocessor_create_with_listener(), ast_taskprocessor_get(), AST_TEST_DEFINE(), ast_websocket_server_add_protocol2(), ast_websocket_server_remove_protocol(), ast_websocket_uri_cb(), ast_xml_doc_item_cmp(), ast_xml_doc_item_hash(), authenticate_request(), authenticate_verify(), bridge_cmp_cb(), bridge_dtmf_hook_sort(), bridge_hash_cb(), bridge_profile_find(), bridge_sort_cmp(), bucket_file_wizard_retrieve(), bucket_rbtree_str_sort_cmp(), bucket_wizard_retrieve(), build_peer(), build_user(), channel_cmp(), channel_hash(), check_featuregroup_item(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), client_buddy_handler(), complete_confbridge_participant(), complete_config_option(), complete_config_type(), conf_find_bridge(), conf_find_bridge_profile(), conf_find_user_profile(), conf_handle_talker_cb(), conf_set_menu_to_user(), conference_bridge_cmp_cb(), conference_bridge_hash_cb(), config_opt_cmp(), config_opt_hash(), datastore_cmp(), datastore_hash(), db_cmp_fn(), db_hash_fn(), endpoint_internal_create(), featuregroup_cmp(), featuregroup_find(), featuregroup_hash(), find_database(), find_member_by_queuename_and_interface(), find_peer(), find_user(), find_variant(), forwards_sort(), func_confbridge_info(), generic_lock_unlock_helper(), generic_mute_unmute_helper(), get_buddy_status(), group_item_sort(), handle_cli_confbridge_kick(), handle_cli_confbridge_list(), handle_cli_confbridge_start_record(), handle_cli_confbridge_stop_record(), handle_cli_iax2_unregister(), handle_incoming_sdp(), handle_manager_show_event(), handle_negotiated_sdp_session_media(), iax2_destroy_helper(), insert_test_duplicates(), jingle_action_hook(), jingle_endpoint_cmp(), jingle_endpoint_find(), jingle_endpoint_hash(), jingle_request(), jingle_session_cmp(), jingle_session_hash(), join_conference_bridge(), media_info_cmp(), media_info_hash(), media_variant_cmp(), media_variant_hash(), member_cmp_fn(), member_hash_fn(), menu_cmp_cb(), menu_find(), menu_hash_cb(), menu_template_handler(), named_item_find(), notify_option_cmp(), notify_option_find(), notify_option_hash(), parking_lot_cfg_cmp_fn(), parking_lot_cfg_hash_fn(), parking_lot_sort_fn(), peer_cmp_cb(), peer_hash_cb(), persistent_endpoint_cmp(), persistent_endpoint_hash(), playback_cmp(), playback_hash(), protocol_cmp_fn(), protocol_hash_fn(), publication_cmp_fn(), publication_hash_fn(), pubsub_on_rx_publish_request(), recording_cmp(), recording_hash(), recording_sort(), sdp_handler_list_cmp(), sdp_handler_list_hash(), sdp_requires_deferral(), session_outgoing_nat_hook(), skel_find_or_create_state(), skel_level_cmp(), skel_level_find(), skel_level_hash(), sorcery_memory_cmp(), sorcery_memory_create(), sorcery_memory_delete(), sorcery_memory_hash(), sorcery_memory_retrieve_id(), sorcery_memory_update(), sorcery_reloadable(), stasis_app_control_record(), stasis_app_playback_find_by_id(), stasis_app_recording_find_by_name(), test_ao2_find_w_OBJ_KEY(), test_cmp_cb(), test_expected_duplicates(), test_hash_cb(), test_item_cmp(), test_item_find(), test_performance(), test_sort_cb(), tps_cmp_cb(), tps_hash_cb(), user_cmp_cb(), user_hash_cb(), user_profile_find(), verify_default_parking_lot(), verify_default_profiles(), wait_bridge_hash_fn(), wait_bridge_sort_fn(), wait_bridge_wrapper_find_by_name(), xmldoc_update_config_option(), xmldoc_update_config_type(), xmpp_buddy_cmp(), xmpp_buddy_hash(), xmpp_client_config_merge_buddies(), xmpp_client_service_discovery_result_hook(), xmpp_component_register_get_hook(), xmpp_config_cmp(), xmpp_config_find(), xmpp_pak_message(), xmpp_pak_presence(), xmpp_pak_s10n(), xmpp_resource_hash(), and xmpp_roster_hook().

◆ OBJ_PARTIAL_KEY

#define OBJ_PARTIAL_KEY OBJ_SEARCH_PARTIAL_KEY

Deprecated name

Definition at line 1156 of file astobj2.h.

Referenced by agent_cfg_sort_cmp(), agent_pvt_cmp(), agent_pvt_sort_cmp(), applicationmap_sort(), bridge_cmp_cb(), bridge_dtmf_hook_sort(), bridge_hash_cb(), bridge_sort_cmp(), bucket_rbtree_str_sort_cmp(), channel_cmp(), channel_hash(), complete_agent(), complete_agent_logoff(), complete_ari_user(), complete_bridge_live(), complete_parking_lot(), conference_bridge_cmp_cb(), conference_bridge_hash_cb(), featuregroup_cmp(), featuregroup_hash(), forwards_sort(), group_item_sort(), menu_cmp_cb(), menu_hash_cb(), parking_lot_cfg_cmp_fn(), parking_lot_cfg_hash_fn(), parking_lot_sort_fn(), recording_sort(), test_ao2_find_w_OBJ_PARTIAL_KEY(), test_cmp_cb(), test_hash_cb(), test_sort_cb(), test_traversal_nonsorted(), test_traversal_sorted(), user_cmp_cb(), user_hash_cb(), wait_bridge_hash_fn(), and wait_bridge_sort_fn().

◆ OBJ_POINTER

#define OBJ_POINTER OBJ_SEARCH_OBJECT

Deprecated name

Definition at line 1154 of file astobj2.h.

Referenced by __find_call(), __find_callno(), _sip_tcp_helper_thread(), add_calltoken_ignore(), agent_cfg_sort_cmp(), agent_pvt_cmp(), agent_pvt_sort_cmp(), applicationmap_sort(), ast_config_hook_unregister(), ast_get_indication_zone(), ast_get_namedgroups(), ast_srtp_add_stream(), ast_srtp_change_source(), AST_TEST_DEFINE(), ast_unregister_indication_country(), bridge_cmp_cb(), bridge_dtmf_hook_sort(), bridge_hash_cb(), bridge_sort_cmp(), bucket_rbtree_str_sort_cmp(), build_callno_limits(), build_peer(), channel_cmp(), channel_hash(), cli_alias_passthrough(), cli_fax_show_session(), compare_weight(), complete_indications(), conference_bridge_cmp_cb(), conference_bridge_hash_cb(), entry_cmp_fn(), featuregroup_cmp(), featuregroup_hash(), find_calendar(), find_cc_core_instance(), find_event(), find_generic_monitor_instance_list(), find_load_queue_rt_friendly(), find_pvt(), find_queue_by_name_rt(), forwards_sort(), get_esc_entry(), get_sip_pvt_from_replaces(), group_cmp_fn(), group_item_sort(), handle_cli_indication_show(), hash_test_lookup(), hash_test_shrink(), manager_fax_session(), menu_cmp_cb(), menu_hash_cb(), msg_data_find(), named_acl_find(), namedgroup_match(), parking_lot_cfg_cmp_fn(), parking_lot_cfg_hash_fn(), parking_lot_sort_fn(), parse_tone_zone(), peercnt_add(), peercnt_modify(), peercnt_remove_by_addr(), pending_members_remove(), presence_state_cb(), queue_function_queuegetchannel(), queue_function_queuewaitingcount(), realtime_common(), realtime_sqlite3_require(), recording_cleanup(), recording_sort(), reload_queue_members(), reload_single_member(), reload_single_queue(), remove_from_playbacks(), remove_from_queue(), sched_delay_remove(), set_fn(), sip_find_peer_full(), sip_poke_peer_s(), sip_prune_realtime(), sip_tcptls_write(), sla_find_station(), sla_find_trunk(), test_ao2_find_w_OBJ_POINTER(), test_container_clone(), unsubscribe(), update_queue(), user_cmp_cb(), user_hash_cb(), ustmtext(), wait_bridge_hash_fn(), and wait_bridge_sort_fn().

Typedef Documentation

◆ ao2_callback_data_fn

typedef int() ao2_callback_data_fn(void *obj, void *arg, void *data, int flags)

Type of a generic callback function.

Parameters

obj	pointer to the (user-defined part) of an object.
arg	callback argument from ao2_callback()
data	arbitrary data from ao2_callback()
flags	flags from ao2_callback() OBJ_SEARCH_OBJECT - if set, 'arg', is an object. OBJ_SEARCH_KEY - if set, 'arg', is a search key item that is not an object. OBJ_SEARCH_PARTIAL_KEY - if set, 'arg', is a partial search key item that is not an object.

The return values are a combination of enum _cb_results. Callback functions are used to search or manipulate objects in a container.

Definition at line 1248 of file astobj2.h.

◆ ao2_callback_fn

typedef int() ao2_callback_fn(void *obj, void *arg, int flags)

Type of a generic callback function.

Parameters

obj	pointer to the (user-defined part) of an object.
arg	callback argument from ao2_callback()
flags	flags from ao2_callback() OBJ_SEARCH_OBJECT - if set, 'arg', is an object. OBJ_SEARCH_KEY - if set, 'arg', is a search key item that is not an object. OBJ_SEARCH_PARTIAL_KEY - if set, 'arg', is a partial search key item that is not an object.

The return values are a combination of enum _cb_results. Callback functions are used to search or manipulate objects in a container.

Definition at line 1230 of file astobj2.h.

◆ ao2_destructor_fn

typedef void(* ao2_destructor_fn) (void *vdoomed)

Typedef for an object destructor.

Parameters

vdoomed Object to destroy.

This is called just before freeing the memory for the object. It is passed a pointer to the user-defined data of the object.

Returns: Nothing

Definition at line 360 of file astobj2.h.

◆ ao2_hash_fn

typedef int() ao2_hash_fn(const void *obj, int flags)

Type of a generic function to generate a hash value from an object.

Parameters

obj	pointer to the (user-defined part) of an object.
flags	flags from ao2_callback() OBJ_SEARCH_OBJECT - if set, 'obj', is an object. OBJ_SEARCH_KEY - if set, 'obj', is a search key item that is not an object.

Note: This function must be idempotent.

Returns: Computed hash value.

Definition at line 1262 of file astobj2.h.

◆ ao2_prnt_fn

typedef void() ao2_prnt_fn(void *where, const char *fmt,...)

Print output.

Since: 12.0.0

Parameters

where	User data pointer needed to determine where to put output.
fmt	printf type format string.

Returns: Nothing

Definition at line 1442 of file astobj2.h.

◆ ao2_prnt_obj_fn

typedef void() ao2_prnt_obj_fn(void *v_obj, void *where, ao2_prnt_fn *prnt)

Print object key.

Since: 12.0.0

Parameters

v_obj	A pointer to the object we want the key printed.
where	User data needed by prnt to determine where to put output.
prnt	Print output callback function to use.

Returns: Nothing

Definition at line 1454 of file astobj2.h.

◆ ao2_sort_fn

typedef int() ao2_sort_fn(const void *obj_left, const void *obj_right, int flags)

Type of generic container sort function.

Parameters

obj_left	pointer to the (user-defined part) of an object.
obj_right	pointer to the (user-defined part) of an object.
flags	flags from ao2_callback() OBJ_SEARCH_OBJECT - if set, 'obj_right', is an object. OBJ_SEARCH_KEY - if set, 'obj_right', is a search key item that is not an object. OBJ_SEARCH_PARTIAL_KEY - if set, 'obj_right', is a partial search key item that is not an object.

Note: This function must be idempotent.

Return values

<0	if obj_left < obj_right
=0	if obj_left == obj_right
>0	if obj_left > obj_right

Definition at line 1280 of file astobj2.h.

◆ ao2_weakproxy_notification_cb

typedef void(* ao2_weakproxy_notification_cb) (void *weakproxy, void *data)

Definition at line 527 of file astobj2.h.

Enumeration Type Documentation

◆ _cb_results

enum _cb_results

A callback function will return a combination of CMP_MATCH and CMP_STOP. The latter will terminate the search in a container.

Enumerator
CMP_MATCH	the object matches the request
CMP_STOP	stop the search now

Definition at line 1030 of file astobj2.h.

                  {
    CMP_MATCH   = 0x1,   /*!< the object matches the request */
    CMP_STOP = 0x2,   /*!< stop the search now */
 };

◆ ao2_alloc_opts

enum ao2_alloc_opts

Options available when allocating an ao2 object.

Enumerator
AO2_ALLOC_OPT_LOCK_MUTEX	The ao2 object has a recursive mutex lock associated with it.
AO2_ALLOC_OPT_LOCK_RWLOCK	The ao2 object has a non-recursive read/write lock associated with it.
AO2_ALLOC_OPT_LOCK_NOLOCK	The ao2 object has no lock associated with it.
AO2_ALLOC_OPT_LOCK_MASK	The ao2 object locking option field mask.
AO2_ALLOC_OPT_LOCK_OBJ
AO2_ALLOC_OPT_NO_REF_DEBUG	The ao2 object will not record any REF_DEBUG entries

Definition at line 363 of file astobj2.h.

                     {
    /*! The ao2 object has a recursive mutex lock associated with it. */
    AO2_ALLOC_OPT_LOCK_MUTEX = (0 << 0),
    /*! The ao2 object has a non-recursive read/write lock associated with it. */
    AO2_ALLOC_OPT_LOCK_RWLOCK = (1 << 0),
    /*! The ao2 object has no lock associated with it. */
    AO2_ALLOC_OPT_LOCK_NOLOCK = (2 << 0),
    /*! The ao2 object locking option field mask. */
    AO2_ALLOC_OPT_LOCK_MASK = (3 << 0),
    /*!
     * \internal The ao2 object uses a separate object for locking.
     *
     * \note This option is used internally by ao2_alloc_with_lockobj and
     * should never be passed directly to ao2_alloc.
     */
    AO2_ALLOC_OPT_LOCK_OBJ = AO2_ALLOC_OPT_LOCK_MASK,
    /*! The ao2 object will not record any REF_DEBUG entries */
    AO2_ALLOC_OPT_NO_REF_DEBUG = (1 << 2),
 };

◆ ao2_container_opts

enum ao2_container_opts

Options available when allocating an ao2 container object.

Note: Each option is open to some interpretation by the container type as long as it makes sense with the option name.

Enumerator
AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN	Insert objects at the beginning of the container. (Otherwise it is the opposite; insert at the end.) Note If an ao2_sort_fn is provided, the object is inserted before any objects with duplicate keys. Hash containers insert the object in the computed hash bucket in the indicated manner.
AO2_CONTAINER_ALLOC_OPT_DUPS_MASK	The ao2 container objects with duplicate keys option field mask.
AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW	Allow objects with duplicate keys in container.
AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT	Reject objects with duplicate keys in container. Note The container must be sorted. i.e. have an ao2_sort_fn.
AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT	Reject duplicate objects in container. Don't link the same object into the container twice. However, you can link a different object with the same key. Note The container must be sorted. i.e. have an ao2_sort_fn. It is assumed that the objects are located where the search key says they should be located.
AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE	Replace objects with duplicate keys in container. The existing duplicate object is removed and the new object takes the old object's place. Note The container must be sorted. i.e. have an ao2_sort_fn.

Definition at line 1165 of file astobj2.h.

                         {
    /*!
     * \brief Insert objects at the beginning of the container.
     * (Otherwise it is the opposite; insert at the end.)
     *
     * \note If an ao2_sort_fn is provided, the object is inserted
     * before any objects with duplicate keys.
     *
     * \note Hash containers insert the object in the computed hash
     * bucket in the indicated manner.
     */
    AO2_CONTAINER_ALLOC_OPT_INSERT_BEGIN = (1 << 0),
 
    /*!
     * \brief The ao2 container objects with duplicate keys option field mask.
     */
    AO2_CONTAINER_ALLOC_OPT_DUPS_MASK = (3 << 1),
    /*!
     * \brief Allow objects with duplicate keys in container.
     */
    AO2_CONTAINER_ALLOC_OPT_DUPS_ALLOW = (0 << 1),
    /*!
     * \brief Reject objects with duplicate keys in container.
     *
     * \note The container must be sorted.  i.e. have an
     * ao2_sort_fn.
     */
    AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT = (1 << 1),
    /*!
     * \brief Reject duplicate objects in container.
     *
     * \details Don't link the same object into the container twice.
     * However, you can link a different object with the same key.
     *
     * \note The container must be sorted.  i.e. have an
     * ao2_sort_fn.
     *
     * \note It is assumed that the objects are located where the
     * search key says they should be located.
     */
    AO2_CONTAINER_ALLOC_OPT_DUPS_OBJ_REJECT = (2 << 1),
    /*!
     * \brief Replace objects with duplicate keys in container.
     *
     * \details The existing duplicate object is removed and the new
     * object takes the old object's place.
     *
     * \note The container must be sorted.  i.e. have an
     * ao2_sort_fn.
     */
    AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE = (3 << 1),
 };

◆ ao2_iterator_flags

enum ao2_iterator_flags

Flags that can be passed to ao2_iterator_init() to modify the behavior of the iterator.

Enumerator
AO2_ITERATOR_DONTLOCK	Assume that the ao2_container is already locked. Note For ao2_containers that have mutexes, no locking will be done. For ao2_containers that have RWLOCKs, the lock will be promoted to write mode as needed. The lock will be returned to the original locked state. Only use this flag if the ao2_container is manually locked already. You should hold the lock until after ao2_iterator_destroy(). If you must release the lock then you must at least hold the lock whenever you call an ao2_iterator_xxx function with this iterator.
AO2_ITERATOR_MALLOCD	Indicates that the iterator was dynamically allocated by astobj2 API and should be freed by ao2_iterator_destroy().
AO2_ITERATOR_UNLINK	Indicates that before the iterator returns an object from the container being iterated, the object should be unlinked from the container.
AO2_ITERATOR_DESCENDING	Iterate in descending order (Last to first container object) (Otherwise ascending order) Note Other traversal orders such as pre-order and post-order do not make sense because they require the container structure to be static during the traversal. Iterators just about guarantee that is not going to happen because the container is allowed to change by other threads during the iteration.

Definition at line 1855 of file astobj2.h.

                         {
    /*!
     * \brief Assume that the ao2_container is already locked.
     *
     * \note For ao2_containers that have mutexes, no locking will
     * be done.
     *
     * \note For ao2_containers that have RWLOCKs, the lock will be
     * promoted to write mode as needed.  The lock will be returned
     * to the original locked state.
     *
     * \note Only use this flag if the ao2_container is manually
     * locked already.  You should hold the lock until after
     * ao2_iterator_destroy().  If you must release the lock then
     * you must at least hold the lock whenever you call an
     * ao2_iterator_xxx function with this iterator.
     */
    AO2_ITERATOR_DONTLOCK = (1 << 0),
    /*!
     * Indicates that the iterator was dynamically allocated by
     * astobj2 API and should be freed by ao2_iterator_destroy().
     */
    AO2_ITERATOR_MALLOCD = (1 << 1),
    /*!
     * Indicates that before the iterator returns an object from
     * the container being iterated, the object should be unlinked
     * from the container.
     */
    AO2_ITERATOR_UNLINK = (1 << 2),
    /*!
     * Iterate in descending order (Last to first container object)
     * (Otherwise ascending order)
     *
     * \note Other traversal orders such as pre-order and post-order
     * do not make sense because they require the container
     * structure to be static during the traversal.  Iterators just
     * about guarantee that is not going to happen because the
     * container is allowed to change by other threads during the
     * iteration.
     */
    AO2_ITERATOR_DESCENDING = (1 << 3),
 };

◆ ao2_lock_req

enum ao2_lock_req

Which lock to request.

Enumerator
AO2_LOCK_REQ_MUTEX	Request the mutex lock be acquired.
AO2_LOCK_REQ_RDLOCK	Request the read lock be acquired.
AO2_LOCK_REQ_WRLOCK	Request the write lock be acquired.

Definition at line 701 of file astobj2.h.

                   {
    /*! Request the mutex lock be acquired. */
    AO2_LOCK_REQ_MUTEX,
    /*! Request the read lock be acquired. */
    AO2_LOCK_REQ_RDLOCK,
    /*! Request the write lock be acquired. */
    AO2_LOCK_REQ_WRLOCK,
 };

◆ search_flags

enum search_flags

Flags passed to ao2_callback_fn(), ao2_hash_fn(), and ao2_sort_fn() to modify behaviour.

Enumerator
OBJ_UNLINK	Unlink the object for which the callback function returned CMP_MATCH.
OBJ_NODATA	On match, don't return the object hence do not increase its refcount.
OBJ_MULTIPLE	Don't stop at the first match in ao2_callback() unless the result of the callback function has the CMP_STOP bit set.
OBJ_NOLOCK	Assume that the ao2_container is already locked. Note For ao2_containers that have mutexes, no locking will be done. For ao2_containers that have RWLOCKs, the lock will be promoted to write mode as needed. The lock will be returned to the original locked state. Only use this flag if the ao2_container is manually locked already.
OBJ_SEARCH_MASK	Search option field mask. Todo: Eventually OBJ_SEARCH_MASK will shrink to a two bit field when the codebase is made to use the search field values as a field instead of independent bits.
OBJ_SEARCH_NONE	The arg parameter has no meaning to the astobj2 code.
OBJ_SEARCH_OBJECT	The arg parameter is an object of the same type. The arg parameter is an object of the same type as the one being searched for, so use the object's ao2_hash_fn and/or ao2_sort_fn functions for optimized searching. Note The supplied ao2_callback_fn is called after the container nodes have been filtered by the ao2_hash_fn and/or ao2_sort_fn functions.
OBJ_SEARCH_KEY	The arg parameter is a search key, but is not an object. This can be used when you want to be able to pass custom data to the container's stored ao2_hash_fn, ao2_sort_fn, and ao2_find ao2_callback_fn functions that is not a full object, but perhaps just a string. Note The supplied ao2_callback_fn is called after the container nodes have been filtered by the ao2_hash_fn and/or ao2_sort_fn functions.
OBJ_SEARCH_PARTIAL_KEY	The arg parameter is a partial search key similar to OBJ_SEARCH_KEY. The partial key can be used by the ao2_sort_fn to guide the search to find a contiguous subset of a sorted container. For example, a sorted container holds: "A", "B", "Bert", "Beth", "Earnie". Doing a partial key search with "B" will find the sorted subset of all held objects starting with "B". Note The supplied ao2_callback_fn is called after the container nodes have been filtered by the ao2_sort_fn function.
OBJ_ORDER_MASK	Traverse order option field mask.
OBJ_ORDER_ASCENDING	Traverse in ascending order (First to last container object)
OBJ_ORDER_DESCENDING	Traverse in descending order (Last to first container object)
OBJ_ORDER_PRE	Traverse in pre-order (Node then children, for tree container) Note For non-tree containers, it is up to the container type to make the best interpretation of the order. For list and hash containers, this also means ascending order because a binary tree can degenerate into a list.
OBJ_ORDER_POST	Traverse in post-order (Children then node, for tree container) Note For non-tree containers, it is up to the container type to make the best interpretation of the order. For list and hash containers, this also means descending order because a binary tree can degenerate into a list.

Definition at line 1038 of file astobj2.h.

                   {
    /*!
     * Unlink the object for which the callback function returned
     * CMP_MATCH.
     */
    OBJ_UNLINK = (1 << 0),
    /*!
     * On match, don't return the object hence do not increase its
     * refcount.
     */
    OBJ_NODATA = (1 << 1),
    /*!
     * Don't stop at the first match in ao2_callback() unless the
     * result of the callback function has the CMP_STOP bit set.
     */
    OBJ_MULTIPLE = (1 << 2),
    /*!
     * \brief Assume that the ao2_container is already locked.
     *
     * \note For ao2_containers that have mutexes, no locking will
     * be done.
     *
     * \note For ao2_containers that have RWLOCKs, the lock will be
     * promoted to write mode as needed.  The lock will be returned
     * to the original locked state.
     *
     * \note Only use this flag if the ao2_container is manually
     * locked already.
     */
    OBJ_NOLOCK = (1 << 4),
 
    /*!
     * \brief Search option field mask.
     *
     * \todo Eventually OBJ_SEARCH_MASK will shrink to a two bit
     * field when the codebase is made to use the search field
     * values as a field instead of independent bits.
     */
    OBJ_SEARCH_MASK = (0x07 << 5),
    /*! \brief The arg parameter has no meaning to the astobj2 code. */
    OBJ_SEARCH_NONE = (0 << 5),
    /*!
     * \brief The arg parameter is an object of the same type.
     *
     * \details
     * The arg parameter is an object of the same type as the one
     * being searched for, so use the object's ao2_hash_fn and/or
     * ao2_sort_fn functions for optimized searching.
     *
     * \note The supplied ao2_callback_fn is called after the
     * container nodes have been filtered by the ao2_hash_fn and/or
     * ao2_sort_fn functions.
     */
    OBJ_SEARCH_OBJECT = (1 << 5),
    /*!
     * \brief The arg parameter is a search key, but is not an object.
     *
     * \details
     * This can be used when you want to be able to pass custom data
     * to the container's stored ao2_hash_fn, ao2_sort_fn, and
     * ao2_find ao2_callback_fn functions that is not a full object,
     * but perhaps just a string.
     *
     * \note The supplied ao2_callback_fn is called after the
     * container nodes have been filtered by the ao2_hash_fn and/or
     * ao2_sort_fn functions.
     */
    OBJ_SEARCH_KEY = (2 << 5),
    /*!
     * \brief The arg parameter is a partial search key similar to OBJ_SEARCH_KEY.
     *
     * \details
     * The partial key can be used by the ao2_sort_fn to guide the
     * search to find a contiguous subset of a sorted container.
     * For example, a sorted container holds: "A", "B", "Bert",
     * "Beth", "Earnie".  Doing a partial key search with "B" will
     * find the sorted subset of all held objects starting with "B".
     *
     * \note The supplied ao2_callback_fn is called after the
     * container nodes have been filtered by the ao2_sort_fn
     * function.
     */
    OBJ_SEARCH_PARTIAL_KEY = (4 << 5),
 
    /*! \brief Traverse order option field mask. */
    OBJ_ORDER_MASK = (0x03 << 8),
    /*! \brief Traverse in ascending order (First to last container object) */
    OBJ_ORDER_ASCENDING = (0 << 8),
    /*! \brief Traverse in descending order (Last to first container object) */
    OBJ_ORDER_DESCENDING = (1 << 8),
    /*!
     * \brief Traverse in pre-order (Node then children, for tree container)
     *
     * \note For non-tree containers, it is up to the container type
     * to make the best interpretation of the order.  For list and
     * hash containers, this also means ascending order because a
     * binary tree can degenerate into a list.
     */
    OBJ_ORDER_PRE = (2 << 8),
    /*!
     * \brief Traverse in post-order (Children then node, for tree container)
     *
     * \note For non-tree containers, it is up to the container type
     * to make the best interpretation of the order.  For list and
     * hash containers, this also means descending order because a
     * binary tree can degenerate into a list.
     */
    OBJ_ORDER_POST = (3 << 8),
 };

Function Documentation

◆ __ao2_alloc()

void* __ao2_alloc	(	size_t	data_size,
		ao2_destructor_fn	destructor_fn,
		unsigned int	options,
		const char *	tag,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 765 of file astobj2.c.

References internal_ao2_alloc(), and NULL.

Referenced by

Data Structures

Macros

Typedefs

Enumerations

Functions

Object Containers

Object Management

Detailed Description

Macro Definition Documentation

◆ ao2_alloc

◆ ao2_alloc_options

◆ ao2_alloc_with_lockobj

◆ ao2_bump

◆ ao2_callback

◆ ao2_callback_data

◆ ao2_cleanup

◆ ao2_container_alloc_hash

◆ ao2_container_alloc_list

◆ ao2_container_alloc_rbtree

◆ ao2_container_clone

◆ AO2_FIELD_CMP_FN

◆ AO2_FIELD_HASH_FN

◆ AO2_FIELD_TRANSFORM_CMP_FN

◆ AO2_FIELD_TRANSFORM_SORT_FN

◆ ao2_find

◆ ao2_get_weakproxy

◆ ao2_global_obj_ref

◆ ao2_global_obj_release

◆ ao2_global_obj_replace

◆ ao2_global_obj_replace_unref

◆ AO2_GLOBAL_OBJ_STATIC

◆ ao2_iterator_next

◆ ao2_link

◆ ao2_link_flags

◆ ao2_lock

◆ ao2_rdlock

◆ ao2_ref

◆ ao2_replace

◆ AO2_STRING_FIELD_CASE_CMP_FN

◆ AO2_STRING_FIELD_CASE_HASH_FN

◆ AO2_STRING_FIELD_CASE_SORT_FN

◆ AO2_STRING_FIELD_CMP_FN

◆ AO2_STRING_FIELD_HASH_FN

◆ AO2_STRING_FIELD_SORT_FN

◆ ao2_t_alloc

◆ ao2_t_alloc_options

◆ ao2_t_bump

◆ ao2_t_callback

◆ ao2_t_callback_data

◆ ao2_t_cleanup

◆ ao2_t_container_alloc_hash

◆ ao2_t_container_alloc_list

◆ ao2_t_container_alloc_rbtree

◆ ao2_t_container_clone

◆ ao2_t_find

◆ ao2_t_get_weakproxy

◆ ao2_t_global_obj_ref

◆ ao2_t_global_obj_release

◆ ao2_t_global_obj_replace

◆ ao2_t_global_obj_replace_unref

◆ ao2_t_iterator_next

◆ ao2_t_link

◆ ao2_t_link_flags

◆ ao2_t_ref

◆ ao2_t_replace

◆ ao2_t_unlink

◆ ao2_t_unlink_flags

◆ ao2_t_weakproxy_alloc

◆ ao2_t_weakproxy_get_object

◆ ao2_t_weakproxy_ref_object

◆ ao2_t_weakproxy_set_object

◆ ao2_trylock

◆ ao2_tryrdlock

◆ ao2_trywrlock

◆ ao2_unlink

◆ ao2_unlink_flags

◆ ao2_unlock

◆ AO2_WEAKPROXY

◆ ao2_weakproxy_alloc

◆ ao2_weakproxy_find