Asterisk.org: Developer Documentation (28 Oct 2009)

Wed Oct 28 15:48:22 2009

## Asterisk developer's documentation

# astobj.h File Reference

A set of macros implementing objects and containers. Macros are used for maximum performance, to support multiple inheritance, and to be easily integrated into existing structures without additional malloc calls, etc. More...

`#include <string.h>`
`#include "asterisk/lock.h"`
`#include "asterisk/compiler.h"`

Include dependency graph for astobj.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Defines

#define | __ASTOBJ_HASH(type, hashes) type *next[1]
#define | ASTOBJ_COMPONENTS(type)
| Add ASTOBJ components to a struct (with locking support).
#define | ASTOBJ_COMPONENTS_FULL(type, namelen, hashes)
| Add ASTOBJ components to a struct (with locking support).
#define | ASTOBJ_COMPONENTS_NOLOCK(type) ASTOBJ_COMPONENTS_NOLOCK_FULL(type,ASTOBJ_DEFAULT_NAMELEN,1)
| Add ASTOBJ components to a struct (without locking support).
#define | ASTOBJ_COMPONENTS_NOLOCK_FULL(type, namelen, hashes)
| Add ASTOBJ components to a struct (without locking support).
#define | ASTOBJ_CONTAINER_COMPONENTS(type)
| Create a container for ASTOBJs (with locking support).
#define | ASTOBJ_CONTAINER_COMPONENTS_NOLOCK(type) ASTOBJ_CONTAINER_COMPONENTS_NOLOCK_FULL(type,1,ASTOBJ_DEFAULT_BUCKETS)
| Create a container for ASTOBJs (without locking support).
#define | ASTOBJ_CONTAINER_COMPONENTS_NOLOCK_FULL(type, hashes, buckets) type *head
| Create a container for ASTOBJs (without locking support).
#define | ASTOBJ_CONTAINER_DESTROY(container) ASTOBJ_CONTAINER_DESTROY_FULL(container,1,ASTOBJ_DEFAULT_BUCKETS)
| Destroy a container.
#define | ASTOBJ_CONTAINER_DESTROY_FULL(container, hashes, buckets)
| Destroy a container.
#define | ASTOBJ_CONTAINER_DESTROYALL(container, destructor)
| Empty a container.
#define | ASTOBJ_CONTAINER_DUMP(fd, s, slen, container) ASTOBJ_CONTAINER_TRAVERSE(container, 1, do { ASTOBJ_DUMP(s,slen,iterator); ast_cli(fd, "%s", s); } while(0))
| Dump information about all the objects in a container to a file descriptor.
#define | ASTOBJ_CONTAINER_FIND(container, namestr)
| Find an object in a container.
#define | ASTOBJ_CONTAINER_FIND_FULL(container, data, field, hashfunc, hashoffset, comparefunc)
| Find an object in a container.
#define | ASTOBJ_CONTAINER_FIND_UNLINK(container, namestr)
| Find and remove an object from a container.
#define | ASTOBJ_CONTAINER_FIND_UNLINK_FULL(container, data, field, hashfunc, hashoffset, comparefunc)
| Find and remove an object in a container.
#define | ASTOBJ_CONTAINER_INIT(container) ASTOBJ_CONTAINER_INIT_FULL(container,1,ASTOBJ_DEFAULT_BUCKETS)
| Initialize a container.
#define | ASTOBJ_CONTAINER_INIT_FULL(container, hashes, buckets)
| Initialize a container.
#define | ASTOBJ_CONTAINER_LINK(container, newobj) ASTOBJ_CONTAINER_LINK_FULL(container,newobj,(newobj)->name,name,ASTOBJ_DEFAULT_HASH,0,strcasecmp)
| Add an object to a container.
#define | ASTOBJ_CONTAINER_LINK_FULL(container, newobj, data, field, hashfunc, hashoffset, comparefunc)
| Add an object to a container.
#define | ASTOBJ_CONTAINER_MARKALL(container) ASTOBJ_CONTAINER_TRAVERSE(container, 1, ASTOBJ_MARK(iterator))
| Mark all the objects in a container.
#define | ASTOBJ_CONTAINER_PRUNE_MARKED(container, destructor)
| Prune marked objects from a container.
#define | ASTOBJ_CONTAINER_RDLOCK(container) ast_mutex_lock(&(container)->_lock)
| Lock an ASTOBJ_CONTAINER for reading.
#define | ASTOBJ_CONTAINER_TRAVERSE(container, continue, eval)
| Iterate through the objects in a container.
#define | ASTOBJ_CONTAINER_UNLINK(container, obj)
| Remove an object from a container.
#define | ASTOBJ_CONTAINER_UNLOCK(container) ast_mutex_unlock(&(container)->_lock)
| Unlock an ASTOBJ_CONTAINER.
#define | ASTOBJ_CONTAINER_UNMARKALL(container) ASTOBJ_CONTAINER_TRAVERSE(container, 1, ASTOBJ_UNMARK(iterator))
| Unmark all the objects in a container.
#define | ASTOBJ_CONTAINER_WRLOCK(container) ast_mutex_lock(&(container)->_lock)
| Lock an ASTOBJ_CONTAINER for writing.
#define | ASTOBJ_DEFAULT_BUCKETS 256
#define | ASTOBJ_DEFAULT_HASH ast_strhash
#define | ASTOBJ_DEFAULT_NAMELEN 80
#define | ASTOBJ_DUMP(s, slen, obj) snprintf((s),(slen),"name: %s\nobjflags: %d\nrefcount: %d\n\n", (obj)->name, (obj)->objflags, (obj)->refcount);
| Dump information about an object into a string.
#define | ASTOBJ_FLAG_MARKED (1 << 0)
#define | ASTOBJ_INIT(object)
| Initialize an object.
#define | ASTOBJ_MARK(object)
| Mark an ASTOBJ by adding the ASTOBJ_FLAG_MARKED flag to its objflags mask.
#define | ASTOBJ_RDLOCK(object) ast_mutex_lock(&(object)->_lock)
| Lock an ASTOBJ for reading.
#define | ASTOBJ_REF(object)
| Increment an object reference count.
#define | ASTOBJ_UNLOCK(object) ast_mutex_unlock(&(object)->_lock)
| Unlock a locked object.
#define | ASTOBJ_UNMARK(object)
| Unmark an ASTOBJ by subtracting the ASTOBJ_FLAG_MARKED flag from its objflags mask.
#define | ASTOBJ_UNREF(object, destructor)
| Decrement the reference count on an object.
#define | ASTOBJ_WRLOCK(object) ast_mutex_lock(&(object)->_lock)
| Lock an ASTOBJ for writing.

## Detailed Description

A set of macros implementing objects and containers. Macros are used for maximum performance, to support multiple inheritance, and to be easily integrated into existing structures without additional malloc calls, etc.

These macros expect to operate on two different object types, ASTOBJs and ASTOBJ_CONTAINERs. These are not actual types, as any struct can be converted into an ASTOBJ compatible object or container using the supplied macros.

Sample Usage:

     struct sample_object {
        ASTOBJ_COMPONENTS(struct sample_object);
     };

     struct sample_container {
        ASTOBJ_CONTAINER_COMPONENTS(struct sample_object);
     } super_container;

     void sample_object_destroy(struct sample_object *obj)
     {
        free(obj);
     }

     int init_stuff()
     {
        struct sample_object *obj1;
        struct sample_object *found_obj;

        obj1 = malloc(sizeof(struct sample_object));

        ASTOBJ_CONTAINER_INIT(&super_container);

        ASTOBJ_INIT(obj1);
        ASTOBJ_WRLOCK(obj1);
        ast_copy_string(obj1->name, "obj1", sizeof(obj1->name));
        ASTOBJ_UNLOCK(obj1);

        ASTOBJ_CONTAINER_LINK(&super_container, obj1);

        found_obj = ASTOBJ_CONTAINER_FIND(&super_container, "obj1");

        if(found_obj) {
           printf("Found object: %s", found_obj->name);
           ASTOBJ_UNREF(found_obj,sample_object_destroy);
        }

        ASTOBJ_CONTAINER_DESTROYALL(&super_container,sample_object_destroy);
        ASTOBJ_CONTAINER_DESTROY(&super_container);

        return 0;
     }

Definition in file astobj.h.

## Define Documentation

#define __ASTOBJ_HASH | ( | type,
|  | hashes |  | ) | type *next[1]

Definition at line 116 of file astobj.h.

#define ASTOBJ_COMPONENTS | ( | type |  | ) |

Value:

    ASTOBJ_COMPONENTS_NOLOCK(type); \
       ast_mutex_t _lock;

Add ASTOBJ components to a struct (with locking support).

Parameters:

  | type | The datatype of the object.

This macro works like ASTOBJ_COMPONENTS_NOLOCK() except it includes locking support.

Sample Usage:

     struct sample_struct {
        ASTOBJ_COMPONENTS(struct sample_struct);
     };

Definition at line 174 of file astobj.h.

#define ASTOBJ_COMPONENTS_FULL | ( | type,
|  | namelen,
|  | hashes |  | ) |

Value:

    ASTOBJ_COMPONENTS_NOLOCK_FULL(type,namelen,hashes); \
       ast_mutex_t _lock;

Add ASTOBJ components to a struct (with locking support).

Parameters:

  | type | The datatype of the object.
  | namelen | The length to make the name char array.
  | hashes | The number of containers the object can be present in.

This macro adds components to a struct to make it an ASTOBJ and includes support for locking.

Sample Usage:

     struct sample_struct {
        ASTOBJ_COMPONENTS_FULL(struct sample_struct,1,1);
     };

Definition at line 194 of file astobj.h.

#define ASTOBJ_COMPONENTS_NOLOCK | ( | type |  | ) | ASTOBJ_COMPONENTS_NOLOCK_FULL(type,ASTOBJ_DEFAULT_NAMELEN,1)

Add ASTOBJ components to a struct (without locking support).

Parameters:

  | type | The datatype of the object.

This macro works like ASTOBJ_COMPONENTS_NOLOCK_FULL() except it only accepts a type and uses default values for namelen and hashes.

Sample Usage:

     struct sample_struct_componets {
        ASTOBJ_COMPONENTS_NOLOCK(struct sample_struct);
     };

Definition at line 157 of file astobj.h.

#define ASTOBJ_COMPONENTS_NOLOCK_FULL | ( | type,
|  | namelen,
|  | hashes |  | ) |

Value:

    char name[namelen]; \
       unsigned int refcount; \
       unsigned int objflags; \
       __ASTOBJ_HASH(type,hashes)

Add ASTOBJ components to a struct (without locking support).

Parameters:

  | type | The datatype of the object.
  | namelen | The length to make the name char array.
  | hashes | The number of containers the object can be present in.

This macro adds components to a struct to make it an ASTOBJ. This macro differs from ASTOBJ_COMPONENTS_FULL in that it does not create a mutex for locking.

Sample Usage:

     struct sample_struct {
        ASTOBJ_COMPONENTS_NOLOCK_FULL(struct sample_struct,1,1);
     };

Definition at line 137 of file astobj.h.

#define ASTOBJ_CONTAINER_COMPONENTS | ( | type |  | ) |

Value:

    ast_mutex_t _lock; \
       ASTOBJ_CONTAINER_COMPONENTS_NOLOCK(type)

Create a container for ASTOBJs (with locking support).

Parameters:

  | type | The type of objects the container will hold.

This macro is used to create a container for ASTOBJs with locking support.

Sample Usage:

     struct sample_struct_container {
        ASTOBJ_CONTAINER_COMPONENTS(struct sample_struct);
     };

Definition at line 660 of file astobj.h.

#define ASTOBJ_CONTAINER_COMPONENTS_NOLOCK | ( | type |  | ) | ASTOBJ_CONTAINER_COMPONENTS_NOLOCK_FULL(type,1,ASTOBJ_DEFAULT_BUCKETS)

Create a container for ASTOBJs (without locking support).

Parameters:

  | type | The type of objects the container will hold.

This macro is used to create a container for ASTOBJs without locking support.

Sample Usage:

     struct sample_struct_nolock_container {
        ASTOBJ_CONTAINER_COMPONENTS_NOLOCK(struct sample_struct);
     };

Definition at line 643 of file astobj.h.

#define ASTOBJ_CONTAINER_COMPONENTS_NOLOCK_FULL | ( | type,
|  | hashes,
|  | buckets |  | ) | type *head

Create a container for ASTOBJs (without locking support).

Parameters:

  | type | The type of objects the container will hold.
  | hashes | Currently unused.
  | buckets | Currently unused.

This macro is used to create a container for ASTOBJs without locking support.

Sample Usage:

     struct sample_struct_nolock_container {
        ASTOBJ_CONTAINER_COMPONENTS_NOLOCK_FULL(struct sample_struct,1,1);
     };

Definition at line 307 of file astobj.h.

#define ASTOBJ_CONTAINER_DESTROY | ( | container |  | ) | ASTOBJ_CONTAINER_DESTROY_FULL(container,1,ASTOBJ_DEFAULT_BUCKETS)

Destroy a container.

Parameters:

  | container | A pointer to the container to destory.

This macro frees up resources used by a container. It does not operate on the objects in the container. To unlink the objects from the container use ASTOBJ_CONTAINER_DESTROYALL().

Note:
  This macro should only be used on containers with locking support.

Definition at line 696 of file astobj.h.

Referenced by ast_netsock_release(), and unload_module().

#define ASTOBJ_CONTAINER_DESTROY_FULL | ( | container,
|  | hashes,
|  | buckets |  | ) |

Value:

    do { \
          ast_mutex_destroy(&(container)->_lock); \
       } while(0)

Destroy a container.

Parameters:

  | container | A pointer to the container to destroy.
  | hashes | Currently unused.
  | buckets | Currently unused.

This macro frees up resources used by a container. It does not operate on the objects in the container. To unlink the objects from the container use ASTOBJ_CONTAINER_DESTROYALL().

Note:
  This macro should only be used on containers with locking support.

Definition at line 348 of file astobj.h.

#define ASTOBJ_CONTAINER_DESTROYALL | ( | container,
|  | destructor |  | ) |

Empty a container.

Parameters:

  | container | A pointer to the container to operate on.
  | destructor | A destructor function to call on each object.

This macro loops through a container removing all the items from it using ASTOBJ_UNREF(). This does not destroy the container itself, use ASTOBJ_CONTAINER_DESTROY() for that.

Note:
  If any object in the container is only referenced by the container, the destructor will be called for that object once it has been removed.

Definition at line 454 of file astobj.h.

Referenced by ast_netsock_release(), sip_do_reload(), and unload_module().

#define ASTOBJ_CONTAINER_DUMP | ( | fd,
|  | s,
|  | slen,
|  | container |  | ) | ASTOBJ_CONTAINER_TRAVERSE(container, 1, do { ASTOBJ_DUMP(s,slen,iterator); ast_cli(fd, "%s", s); } while(0))

Dump information about all the objects in a container to a file descriptor.

Parameters:

  | fd | The file descriptor to write to.
  | s | A string buffer, same as ASTOBJ_DUMP().
  | slen | The length of s, same as ASTOBJ_DUMP().
  | container | A pointer to the container to dump.

This macro dumps a text representation of the name, objectflags, and refcount fields of all the objects in a container to the specified file descriptor.

Definition at line 745 of file astobj.h.

Referenced by sip_show_objects().

#define ASTOBJ_CONTAINER_FIND | ( | container,
|  | namestr |  | ) |

Find an object in a container.

Parameters:

  | container | A pointer to the container to search.
  | namestr | The name to search for.

Use this function to find an object with the specfied name in a container.

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

Returns:
  A new reference to the object located or NULL if nothing is found.

Definition at line 402 of file astobj.h.

Referenced by find_peer(), and find_user().

#define ASTOBJ_CONTAINER_FIND_FULL | ( | container,
|  | data,
|  | field,
|  | hashfunc,
|  | hashoffset,
|  | comparefunc |  | ) |

Find an object in a container.

Parameters:

  | container | A pointer to the container to search.
  | data | The data to search for.
  | field | The field/member of the container's objects to search.
  | hashfunc | The hash function to use, currently not implemented.
  | hashoffset | The hash offset to use, currently not implemented.
  | comparefunc | The function used to compare the field and data values.

This macro iterates through a container passing the specified field and data elements to the specified comparefunc. The function should return 0 when a match is found.

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

Returns:
  A pointer to the object located or NULL if nothing is found.

Definition at line 429 of file astobj.h.

Referenced by find_peer().

#define ASTOBJ_CONTAINER_FIND_UNLINK | ( | container,
|  | namestr |  | ) |

Find and remove an object from a container.

Parameters:

  | container | A pointer to the container to operate on.
  | namestr | The name of the object to remove.

This macro iterates through a container and removes the first object with the specfied name from the container.

Note:
  This macro does not destroy any objects, it simply unlinks them. No destructors are called.

Returns:
  The container's reference to the removed object or NULL if no matching object was found.

Definition at line 513 of file astobj.h.

Referenced by sip_prune_realtime().

#define ASTOBJ_CONTAINER_FIND_UNLINK_FULL | ( | container,
|  | data,
|  | field,
|  | hashfunc,
|  | hashoffset,
|  | comparefunc |  | ) |

Find and remove an object in a container.

Parameters:

  | container | A pointer to the container to search.
  | data | The data to search for.
  | field | The field/member of the container's objects to search.
  | hashfunc | The hash function to use, currently not implemented.
  | hashoffset | The hash offset to use, currently not implemented.
  | comparefunc | The function used to compare the field and data values.

This macro iterates through a container passing the specified field and data elements to the specified comparefunc. The function should return 0 when a match is found. If a match is found it is removed from the list.

Note:
  This macro does not destroy any objects, it simply unlinks them. No destructors are called.

Returns:
  The container's reference to the removed object or NULL if no match was found.

Definition at line 552 of file astobj.h.

Referenced by build_peer().

#define ASTOBJ_CONTAINER_INIT | ( | container |  | ) | ASTOBJ_CONTAINER_INIT_FULL(container,1,ASTOBJ_DEFAULT_BUCKETS)

Initialize a container.

Parameters:

  | container | A pointer to the container to initialize.

This macro initializes a container. It should only be used on containers that support locking.

Sample Usage:

     struct sample_struct_container {
        ASTOBJ_CONTAINER_COMPONENTS(struct sample_struct);
     } container;

     int func()
     {
        ASTOBJ_CONTAINER_INIT(&container);
     }

Definition at line 683 of file astobj.h.

Referenced by ast_netsock_init(), and load_module().

#define ASTOBJ_CONTAINER_INIT_FULL | ( | container,
|  | hashes,
|  | buckets |  | ) |

Value:

    do { \
          ast_mutex_init(&(container)->_lock); \
       } while(0)

Initialize a container.

Parameters:

  | container | A pointer to the container to initialize.
  | hashes | Currently unused.
  | buckets | Currently unused.

This macro initializes a container. It should only be used on containers that support locking.

Sample Usage:

     struct sample_struct_container {
        ASTOBJ_CONTAINER_COMPONENTS_FULL(struct sample_struct,1,1);
     } container;

     int func()
     {
        ASTOBJ_CONTAINER_INIT_FULL(&container,1,1);
     }

Definition at line 331 of file astobj.h.

#define ASTOBJ_CONTAINER_LINK | ( | container,
|  | newobj |  | ) | ASTOBJ_CONTAINER_LINK_FULL(container,newobj,(newobj)->name,name,ASTOBJ_DEFAULT_HASH,0,strcasecmp)

Add an object to a container.

Parameters:

  | container | A pointer to the container to operate on.
  | newobj | A pointer to the object to be added.

Currently this macro adds an object to the head of a container. One day it should add an object in alphabetical order.

Definition at line 707 of file astobj.h.

Referenced by ast_netsock_bindaddr(), realtime_peer(), realtime_user(), register_verify(), reload_config(), sip_prune_realtime(), and sip_register().

#define ASTOBJ_CONTAINER_LINK_FULL | ( | container,
|  | newobj,
|  | data,
|  | field,
|  | hashfunc,
|  | hashoffset,
|  | comparefunc |  | ) |

Add an object to a container.

Parameters:

  | container | A pointer to the container to operate on.
  | newobj | A pointer to the object to be added.
  | data | Currently unused.
  | field | Currently unused.
  | hashfunc | Currently unused.
  | hashoffset | Currently unused.
  | comparefunc | Currently unused.

Currently this function adds an object to the head of the list. One day it will support adding objects atthe position specified using the various options this macro offers.

Definition at line 617 of file astobj.h.

#define ASTOBJ_CONTAINER_MARKALL | ( | container |  | ) | ASTOBJ_CONTAINER_TRAVERSE(container, 1, ASTOBJ_MARK(iterator))

Mark all the objects in a container.

Parameters:

  | container | A pointer to the container to operate on.

Definition at line 713 of file astobj.h.

Referenced by sip_do_reload().

#define ASTOBJ_CONTAINER_PRUNE_MARKED | ( | container,
|  | destructor |  | ) |

Prune marked objects from a container.

Parameters:

  | container | A pointer to the container to prune.
  | destructor | A destructor function to call on each marked object.

This macro iterates through the specfied container and prunes any marked objects executing the specfied destructor if necessary.

Definition at line 582 of file astobj.h.

Referenced by sip_do_reload(), and sip_prune_realtime().

#define ASTOBJ_CONTAINER_RDLOCK | ( | container |  | ) | ast_mutex_lock(&(container)->_lock)

Lock an ASTOBJ_CONTAINER for reading.

Definition at line 277 of file astobj.h.

#define ASTOBJ_CONTAINER_TRAVERSE | ( | container,
|  | continue,
|  | eval |  | ) |

Iterate through the objects in a container.

Parameters:

  | container | A pointer to the container to traverse.
  | continue | A condition to allow the traversal to continue.
  | eval | A statement to evaluate in the iteration loop.

This is macro is a little complicated, but it may help to think of it as a loop. Basically it iterates through the specfied containter as long as the condition is met. Two variables, iterator and next, are provided for use in your `eval` statement. See the sample code for an example.

Sample Usage:

     ASTOBJ_CONTAINER_TRAVERSE(&sample_container,1, {
        ASTOBJ_RDLOCK(iterator);
        printf("Currently iterating over '%s'\n", iterator->name);
        ASTOBJ_UNLOCK(iterator);
     } );

     ASTOBJ_CONTAINER_TRAVERSE(&sample_container,1, sample_func(iterator));

Definition at line 377 of file astobj.h.

Referenced by _sip_show_peers(), ast_netsock_find(), complete_sip_peer(), complete_sip_user(), do_monitor(), sip_do_reload(), sip_poke_all_peers(), sip_prune_realtime(), sip_send_all_registers(), sip_show_inuse(), sip_show_registry(), and sip_show_users().

#define ASTOBJ_CONTAINER_UNLINK | ( | container,
|  | obj |  | ) |

Remove an object from a container.

Parameters:

  | container | A pointer to the container to operate on.
  | obj | A pointer to the object to remove.

This macro iterates through a container and removes the specfied object if it exists in the container.

Note:
  This macro does not destroy any objects, it simply unlinks them from the list. No destructors are called.

Returns:
  The container's reference to the removed object or NULL if no matching object was found.

Definition at line 479 of file astobj.h.

Referenced by expire_register().

#define ASTOBJ_CONTAINER_UNLOCK | ( | container |  | ) | ast_mutex_unlock(&(container)->_lock)

Unlock an ASTOBJ_CONTAINER.

Definition at line 284 of file astobj.h.

Referenced by sip_prune_realtime().

#define ASTOBJ_CONTAINER_UNMARKALL | ( | container |  | ) | ASTOBJ_CONTAINER_TRAVERSE(container, 1, ASTOBJ_UNMARK(iterator))

Unmark all the objects in a container.

Parameters:

  | container | A pointer to the container to operate on.

Definition at line 719 of file astobj.h.

#define ASTOBJ_CONTAINER_WRLOCK | ( | container |  | ) | ast_mutex_lock(&(container)->_lock)

Lock an ASTOBJ_CONTAINER for writing.

Definition at line 281 of file astobj.h.

Referenced by sip_prune_realtime().

#define ASTOBJ_DEFAULT_BUCKETS 256

Definition at line 93 of file astobj.h.

#define ASTOBJ_DEFAULT_HASH ast_strhash

Definition at line 94 of file astobj.h.

#define ASTOBJ_DEFAULT_NAMELEN 80

Definition at line 92 of file astobj.h.

#define ASTOBJ_DUMP | ( | s,
|  | slen,
|  | obj |  | ) | snprintf((s),(slen),"name: %s\nobjflags: %d\nrefcount: %d\n\n", (obj)->name, (obj)->objflags, (obj)->refcount);

Dump information about an object into a string.

Parameters:

  | s | A pointer to the string buffer to use.
  | slen | The length of s.
  | obj | A pointer to the object to dump.

This macro dumps a text representation of the name, objectflags, and refcount fields of an object to the specfied string buffer.

Definition at line 731 of file astobj.h.

#define ASTOBJ_FLAG_MARKED (1 << 0)

Definition at line 96 of file astobj.h.

#define ASTOBJ_INIT | ( | object |  | ) |

Value:

    do { \
          ast_mutex_init(&(object)->_lock); \
          object->name[0] = '\0'; \
          object->refcount = 1; \
       } while(0)

Initialize an object.

Parameters:

  | object | A pointer to the object to operate on.

Note:
  This should only be used on objects that support locking (objects created with ASTOBJ_COMPONENTS() or ASTOBJ_COMPONENTS_FULL())

Definition at line 265 of file astobj.h.

Referenced by ast_netsock_bindaddr(), build_peer(), build_user(), sip_register(), and temp_peer().

#define ASTOBJ_MARK | ( | object |  | ) |

Value:

    do { \
          ASTOBJ_WRLOCK(object); \
          (object)->objflags |= ASTOBJ_FLAG_MARKED; \
          ASTOBJ_UNLOCK(object); \
       } while(0)

Mark an ASTOBJ by adding the ASTOBJ_FLAG_MARKED flag to its objflags mask.

Parameters:

  | object | A pointer to the object to operate on.

This macro "marks" an object. Marked objects can later be unlinked from a container using ASTOBJ_CONTAINER_PRUNE_MARKED().

Definition at line 242 of file astobj.h.

Referenced by sip_prune_realtime().

#define ASTOBJ_RDLOCK | ( | object |  | ) | ast_mutex_lock(&(object)->_lock)

Lock an ASTOBJ for reading.

Definition at line 103 of file astobj.h.

Referenced by _sip_show_peers(), ast_netsock_find(), sip_do_reload(), sip_prune_realtime(), sip_show_inuse(), sip_show_registry(), and sip_show_users().

#define ASTOBJ_REF | ( | object |  | ) |

Increment an object reference count.

Parameters:

  | object | A pointer to the object to operate on.

Returns:
  The object.

Definition at line 202 of file astobj.h.

Referenced by do_monitor(), sip_reg_timeout(), sip_reregister(), and transmit_register().

#define ASTOBJ_UNLOCK | ( | object |  | ) | ast_mutex_unlock(&(object)->_lock)

Unlock a locked object.

Definition at line 110 of file astobj.h.

Referenced by _sip_show_peers(), ast_netsock_find(), do_monitor(), sip_do_reload(), sip_poke_all_peers(), sip_prune_realtime(), sip_send_all_registers(), sip_show_inuse(), sip_show_registry(), and sip_show_users().

#define ASTOBJ_UNMARK | ( | object |  | ) |

Value:

    do { \
          ASTOBJ_WRLOCK(object); \
          (object)->objflags &= ~ASTOBJ_FLAG_MARKED; \
          ASTOBJ_UNLOCK(object); \
       } while(0)

Unmark an ASTOBJ by subtracting the ASTOBJ_FLAG_MARKED flag from its objflags mask.

Parameters:

  | object | A pointer to the object to operate on.

Definition at line 252 of file astobj.h.

Referenced by build_peer().

#define ASTOBJ_UNREF | ( | object,
|  | destructor |  | ) |

Decrement the reference count on an object.

Parameters:

  | object | A pointer the object to operate on.
  | destructor | The destructor to call if the object is no longer referenced. It will be passed the pointer as an argument.

This macro unreferences an object and calls the specfied destructor if the object is no longer referenced. The destructor should free the object if it was dynamically allocated.

Definition at line 219 of file astobj.h.

Referenced by __sip_destroy(), _sip_show_peer(), ast_netsock_unref(), build_peer(), check_user_full(), create_addr(), do_monitor(), expire_register(), function_sippeer(), handle_response_register(), register_verify(), reload_config(), sip_devicestate(), sip_do_debug_peer(), sip_prune_realtime(), sip_reg_timeout(), sip_register(), sip_reregister(), sip_show_user(), and update_call_counter().

#define ASTOBJ_WRLOCK | ( | object |  | ) | ast_mutex_lock(&(object)->_lock)

Lock an ASTOBJ for writing.

Definition at line 107 of file astobj.h.

Referenced by do_monitor(), sip_poke_all_peers(), and sip_send_all_registers().