Mon Mar 12 2012 21:38:39

Asterisk developer's documentation

Data Structures | Defines | Typedefs | Enumerations | Functions
data.h File Reference

Data retrieval API. More...

#include "asterisk/frame.h"
Include dependency graph for data.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ast_data_entry
 This entries are for multiple registers. More...
struct  ast_data_handler
 The structure of the node handler. More...
struct  ast_data_mapping_structure
 Map the members of a structure. More...
struct  ast_data_query
 A query to the data API is specified in this structure. More...
struct  ast_data_retrieve
 structure retrieved from a node, with the nodes content. More...

Defines

#define __AST_DATA_MAPPING_FUNCTION(__structure, __member, __type)   __AST_DATA_MAPPING_FUNCTION_##__type(__structure, __member)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_BOOLEAN(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_BOOLEAN, unsigned int)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_CHARACTER(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CHARACTER, char)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_CONTAINER(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CONTAINER, void *)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_DOUBLE(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_DBL, double)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_INTEGER(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_IPADDR(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_IPADDR, struct in_addr)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_MILLISECONDS(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_PASSWORD(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_PASSWORD, char *)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_POINTER(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_POINTER, void *)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_SECONDS(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_STRING(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_STRING, char *)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_TIMESTAMP(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)
#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_UNSIGNED_INTEGER(__structure, __member)   __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_UNSIGNED_INTEGER, unsigned int)
#define __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, __type, __real_type)
#define __AST_DATA_MAPPING_STRUCTURE(__structure, __member, __type)
#define ast_data_add_structure(structure_name, root, structure)
#define AST_DATA_ENTRY(__path, __handler)   { .path = __path, .handler = __handler }
#define AST_DATA_HANDLER_VERSION   1
 The Data API structures version.
#define AST_DATA_QUERY_VERSION   1
#define ast_data_register(path, handler)   __ast_data_register(path, handler, __FILE__, ast_module_info->self)
#define ast_data_register_core(path, handler)   __ast_data_register(path, handler, __FILE__, NULL)
#define ast_data_register_multiple(data_entries, entries)   __ast_data_register_multiple(data_entries, entries, __FILE__, ast_module_info->self)
#define ast_data_register_multiple_core(data_entries, entries)   __ast_data_register_multiple(data_entries, entries, __FILE__, NULL)
#define ast_data_search_cmp_structure(search, structure_name, structure, structure_name_cmp)
#define AST_DATA_STRUCTURE(__struct, __name)
#define ast_data_unregister(path)   __ast_data_unregister(path, __FILE__)

Typedefs

typedef int(* ast_data_get_cb )(const struct ast_data_search *search, struct ast_data *root)
 The get callback definition.

Enumerations

enum  ast_data_type {
  AST_DATA_CONTAINER, AST_DATA_INTEGER, AST_DATA_UNSIGNED_INTEGER, AST_DATA_DOUBLE,
  AST_DATA_BOOLEAN, AST_DATA_STRING, AST_DATA_CHARACTER, AST_DATA_PASSWORD,
  AST_DATA_IPADDR, AST_DATA_TIMESTAMP, AST_DATA_SECONDS, AST_DATA_MILLISECONDS,
  AST_DATA_POINTER
}
 The data type of the data node. More...

Functions

int __ast_data_add_structure (struct ast_data *root, const struct ast_data_mapping_structure *mapping, size_t mapping_len, void *structure)
 Add a complete structure to a node.
int __ast_data_register (const char *path, const struct ast_data_handler *handler, const char *registrar, struct ast_module *mod)
 Register a data provider.
int __ast_data_register_multiple (const struct ast_data_entry *data_entries, size_t entries, const char *registrar, struct ast_module *mod)
 Register multiple data providers at once.
int __ast_data_search_cmp_structure (const struct ast_data_search *search, const struct ast_data_mapping_structure *mapping, size_t mapping_len, void *structure, const char *structure_name)
 Based on a search tree, evaluate every member of a structure against it.
int __ast_data_unregister (const char *path, const char *registrar)
 Unregister a data provider.
struct ast_data * ast_data_add_bool (struct ast_data *root, const char *childname, unsigned int boolean)
 Add a boolean node type.
struct ast_data * ast_data_add_char (struct ast_data *root, const char *childname, char value)
 Add a char node type.
int ast_data_add_codecs (struct ast_data *root, const char *node_name, format_t capability)
 Add the list of codecs in the root node based on the capability parameter.
struct ast_data * ast_data_add_dbl (struct ast_data *root, const char *childname, double dbl)
 Add a floating point node type.
struct ast_data * ast_data_add_int (struct ast_data *root, const char *childname, int value)
 Add an integer node type.
struct ast_data * ast_data_add_ipaddr (struct ast_data *root, const char *childname, struct in_addr addr)
 Add a ipv4 address type.
struct ast_data * ast_data_add_milliseconds (struct ast_data *root, const char *childname, unsigned int milliseconds)
 Add a milliseconds node type.
struct ast_data * ast_data_add_node (struct ast_data *root, const char *childname)
 Add a container child.
struct ast_data * ast_data_add_password (struct ast_data *root, const char *childname, const char *string)
 Add a password node type.
struct ast_data * ast_data_add_ptr (struct ast_data *root, const char *childname, void *ptr)
 Add a ptr node type.
struct ast_data * ast_data_add_seconds (struct ast_data *root, const char *childname, unsigned int seconds)
 Add a seconds node type.
struct ast_data * ast_data_add_str (struct ast_data *root, const char *childname, const char *string)
 Add a string node type.
struct ast_data * ast_data_add_timestamp (struct ast_data *root, const char *childname, unsigned int timestamp)
 Add a timestamp node type.
struct ast_data * ast_data_add_uint (struct ast_data *root, const char *childname, unsigned int value)
 Add an unsigned integer node type.
void ast_data_free (struct ast_data *root)
 Release the allocated memory of a tree.
struct ast_data * ast_data_get (const struct ast_data_query *query)
 Retrieve a subtree from the asterisk data API.
struct ast_xml_doc * ast_data_get_xml (const struct ast_data_query *query)
 Retrieve a subtree from the asterisk data API in XML format..
void ast_data_iterator_end (struct ast_data_iterator *iterator)
 Release (stop using) an iterator.
struct ast_data_iterator * ast_data_iterator_init (struct ast_data *tree, const char *elements)
 Initialize an iterator.
struct ast_data * ast_data_iterator_next (struct ast_data_iterator *iterator)
 Get the next node of the tree.
void ast_data_remove_node (struct ast_data *root, struct ast_data *child)
 Remove a node that was added using ast_data_add_.
int ast_data_retrieve (struct ast_data *tree, const char *path, struct ast_data_retrieve *content)
 Retrieve a value from a node in the tree.
static unsigned int ast_data_retrieve_bool (struct ast_data *tree, const char *path)
 Retrieve the boolean value of a node.
static char ast_data_retrieve_char (struct ast_data *tree, const char *path)
 Retrieve the character value of a node.
static double ast_data_retrieve_dbl (struct ast_data *tree, const char *path)
 Retrieve the double value of a node.
static int ast_data_retrieve_int (struct ast_data *tree, const char *path)
 Retrieve the integer value of a node.
static struct in_addr ast_data_retrieve_ipaddr (struct ast_data *tree, const char *path)
 Retrieve the ipv4 address value of a node.
char * ast_data_retrieve_name (struct ast_data *node)
 Get the node name.
static const char * ast_data_retrieve_password (struct ast_data *tree, const char *path)
 Retrieve the password value of a node.
static void * ast_data_retrieve_ptr (struct ast_data *tree, const char *path)
 Retrieve the ptr value of a node.
static const char * ast_data_retrieve_string (struct ast_data *tree, const char *path)
 Retrieve the string value of a node.
enum ast_data_type ast_data_retrieve_type (struct ast_data *res, const char *path)
 Get a node type.
static unsigned int ast_data_retrieve_uint (struct ast_data *tree, const char *path)
 Retrieve the unsigned integer value of a node.
int ast_data_search_match (const struct ast_data_search *search, struct ast_data *data)
 Check the current generated node to know if it matches the search condition.

Detailed Description

Data retrieval API.

Author:
Brett Bryant <brettbryant@gmail.com>
Eliel C. Sardanons (LU1ALY) <eliels@gmail.com>

Definition in file data.h.

Define Documentation

#define __AST_DATA_MAPPING_FUNCTION (   __structure,
  __member,
  __type 
)    __AST_DATA_MAPPING_FUNCTION_##__type(__structure, __member)

Definition at line 339 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_BOOLEAN (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_BOOLEAN, unsigned int)

Definition at line 328 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_CHARACTER (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CHARACTER, char)

Definition at line 316 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_CONTAINER (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_CONTAINER, void *)

Definition at line 336 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_DOUBLE (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_DBL, double)

Definition at line 334 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_INTEGER (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)

Definition at line 318 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_IPADDR (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_IPADDR, struct in_addr)

Definition at line 332 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_MILLISECONDS (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)

Definition at line 324 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_PASSWORD (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_PASSWORD, char *)

Definition at line 312 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_POINTER (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_POINTER, void *)

Definition at line 330 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_SECONDS (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)

Definition at line 322 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_STRING (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_STRING, char *)

Definition at line 314 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_TIMESTAMP (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_INTEGER, int)

Definition at line 320 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_AST_DATA_UNSIGNED_INTEGER (   __structure,
  __member 
)    __AST_DATA_MAPPING_FUNCTION_TYPE(__structure, __member, AST_DATA_UNSIGNED_INTEGER, unsigned int)

Definition at line 326 of file data.h.

#define __AST_DATA_MAPPING_FUNCTION_TYPE (   __structure,
  __member,
  __type,
  __real_type 
)
Value:
static __real_type data_mapping_structure_get_##__structure##__member(void *ptr) {  \
      struct __structure *struct_##__member = (struct __structure *) ptr;     \
      return (__real_type) struct_##__member->__member;           \
   }

Definition at line 343 of file data.h.

#define __AST_DATA_MAPPING_STRUCTURE (   __structure,
  __member,
  __type 
)
Value:
{ .name = #__member, .get.__type = data_mapping_structure_get_##__structure##__member, \
   .type = __type },

Definition at line 307 of file data.h.

#define ast_data_add_structure (   structure_name,
  root,
  structure 
)
Value:
__ast_data_add_structure(root, __data_mapping_structure_##structure_name,  \
      ARRAY_LEN(__data_mapping_structure_##structure_name), structure)

Definition at line 620 of file data.h.

Referenced by agents_data_provider_get(), ast_channel_data_add_structure(), ast_tone_zone_data_add_structure(), dahdi_channels_data_provider_get(), data_odbc_provider_handler(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), user_add_provider_cb(), users_data_provider_get(), and vm_users_data_provider_get_helper().

#define AST_DATA_ENTRY (   __path,
  __handler 
)    { .path = __path, .handler = __handler }

Definition at line 260 of file data.h.

#define AST_DATA_HANDLER_VERSION   1

The Data API structures version.

Definition at line 204 of file data.h.

#define AST_DATA_QUERY_VERSION   1

Definition at line 205 of file data.h.

Referenced by handle_cli_data_get(), and manager_data_get().

#define ast_data_register (   path,
  handler 
)    __ast_data_register(path, handler, __FILE__, ast_module_info->self)

Definition at line 362 of file data.h.

#define ast_data_register_core (   path,
  handler 
)    __ast_data_register(path, handler, __FILE__, NULL)

Definition at line 363 of file data.h.

#define ast_data_register_multiple (   data_entries,
  entries 
)    __ast_data_register_multiple(data_entries, entries, __FILE__, ast_module_info->self)

Definition at line 377 of file data.h.

Referenced by load_module().

#define ast_data_register_multiple_core (   data_entries,
  entries 
)    __ast_data_register_multiple(data_entries, entries, __FILE__, NULL)

Definition at line 379 of file data.h.

Referenced by ast_channels_init(), and load_pbx().

#define ast_data_search_cmp_structure (   search,
  structure_name,
  structure,
  structure_name_cmp 
)
Value:
__ast_data_search_cmp_structure(search, __data_mapping_structure_##structure_name,     \
   ARRAY_LEN(__data_mapping_structure_##structure_name), structure, structure_name_cmp)

Definition at line 420 of file data.h.

Referenced by ast_channel_data_cmp_structure().

#define AST_DATA_STRUCTURE (   __struct,
  __name 
)
Value:
__name(__AST_DATA_MAPPING_FUNCTION);                        \
   static const struct ast_data_mapping_structure __data_mapping_structure_##__struct[] = {  \
      __name(__AST_DATA_MAPPING_STRUCTURE)                     \
   }

Definition at line 300 of file data.h.

#define ast_data_unregister (   path)    __ast_data_unregister(path, __FILE__)

Definition at line 394 of file data.h.

Referenced by __unload_module(), and unload_module().

Typedef Documentation

typedef int(* ast_data_get_cb)(const struct ast_data_search *search, struct ast_data *root)

The get callback definition.

Definition at line 241 of file data.h.

Enumeration Type Documentation

enum ast_data_type

The data type of the data node.

Enumerator:
AST_DATA_CONTAINER 
AST_DATA_INTEGER 
AST_DATA_UNSIGNED_INTEGER 
AST_DATA_DOUBLE 
AST_DATA_BOOLEAN 
AST_DATA_STRING 
AST_DATA_CHARACTER 
AST_DATA_PASSWORD 
AST_DATA_IPADDR 
AST_DATA_TIMESTAMP 
AST_DATA_SECONDS 
AST_DATA_MILLISECONDS 
AST_DATA_POINTER 

Definition at line 187 of file data.h.

                   {
   AST_DATA_CONTAINER,
   AST_DATA_INTEGER,
   AST_DATA_UNSIGNED_INTEGER,
   AST_DATA_DOUBLE,
   AST_DATA_BOOLEAN,
   AST_DATA_STRING,
   AST_DATA_CHARACTER,
   AST_DATA_PASSWORD,
   AST_DATA_IPADDR,
   AST_DATA_TIMESTAMP,
   AST_DATA_SECONDS,
   AST_DATA_MILLISECONDS,
   AST_DATA_POINTER
};

Function Documentation

int __ast_data_add_structure ( struct ast_data *  root,
const struct ast_data_mapping_structure *  mapping,
size_t  mapping_len,
void *  structure 
)

Add a complete structure to a node.

Parameters:
[in]rootWhere to add the structure.
[in]mappingThe structure mapping array.
[in]mapping_lenThe lenght of the mapping array.
[in]structureThe structure pointer.
Return values:
0on success.
1on error.

Definition at line 2416 of file data.c.

References ast_data_add_bool(), ast_data_add_char(), ast_data_add_dbl(), ast_data_add_int(), ast_data_add_ipaddr(), ast_data_add_milliseconds(), ast_data_add_password(), ast_data_add_ptr(), ast_data_add_seconds(), ast_data_add_str(), ast_data_add_timestamp(), ast_data_add_uint(), AST_DATA_BOOLEAN, AST_DATA_CHARACTER, AST_DATA_CONTAINER, AST_DATA_DOUBLE, AST_DATA_INTEGER, AST_DATA_IPADDR, AST_DATA_MILLISECONDS, AST_DATA_PASSWORD, AST_DATA_POINTER, AST_DATA_SECONDS, AST_DATA_STRING, AST_DATA_TIMESTAMP, AST_DATA_UNSIGNED_INTEGER, data_filter::name, and type.

{
   int i;

   for (i = 0; i < mapping_len; i++) {
      switch (mapping[i].type) {
      case AST_DATA_INTEGER:
         ast_data_add_int(root, mapping[i].name,
            mapping[i].get.AST_DATA_INTEGER(structure));
         break;
      case AST_DATA_UNSIGNED_INTEGER:
         ast_data_add_uint(root, mapping[i].name,
            mapping[i].get.AST_DATA_UNSIGNED_INTEGER(structure));
         break;
      case AST_DATA_DOUBLE:
         ast_data_add_dbl(root, mapping[i].name,
            mapping[i].get.AST_DATA_DOUBLE(structure));
         break;
      case AST_DATA_BOOLEAN:
         ast_data_add_bool(root, mapping[i].name,
            mapping[i].get.AST_DATA_BOOLEAN(structure));
         break;
      case AST_DATA_PASSWORD:
         ast_data_add_password(root, mapping[i].name,
            mapping[i].get.AST_DATA_PASSWORD(structure));
         break;
      case AST_DATA_TIMESTAMP:
         ast_data_add_timestamp(root, mapping[i].name,
            mapping[i].get.AST_DATA_TIMESTAMP(structure));
         break;
      case AST_DATA_SECONDS:
         ast_data_add_seconds(root, mapping[i].name,
            mapping[i].get.AST_DATA_SECONDS(structure));
         break;
      case AST_DATA_MILLISECONDS:
         ast_data_add_milliseconds(root, mapping[i].name,
            mapping[i].get.AST_DATA_MILLISECONDS(structure));
         break;
      case AST_DATA_STRING:
         ast_data_add_str(root, mapping[i].name,
            mapping[i].get.AST_DATA_STRING(structure));
         break;
      case AST_DATA_CHARACTER:
         ast_data_add_char(root, mapping[i].name,
            mapping[i].get.AST_DATA_CHARACTER(structure));
         break;
      case AST_DATA_CONTAINER:
         break;
      case AST_DATA_IPADDR:
         ast_data_add_ipaddr(root, mapping[i].name,
            mapping[i].get.AST_DATA_IPADDR(structure));
         break;
      case AST_DATA_POINTER:
         ast_data_add_ptr(root, mapping[i].name,
            mapping[i].get.AST_DATA_POINTER(structure));
         break;
      }
   }

   return 0;
}
int __ast_data_register ( const char *  path,
const struct ast_data_handler *  handler,
const char *  registrar,
struct ast_module *  mod 
)

Register a data provider.

Parameters:
[in]pathThe path of the node to register.
[in]handlerThe structure defining this node handler.
[in]registrarWho is registering this node.
[in]modThe module registering this handler.
See also:
ast_data_unregister
Return values:
<0on error.
0on success.
See also:
__ast_data_unregister, __ast_data_register_multiple

Definition at line 514 of file data.c.

References ao2_container_count(), ao2_ref, ast_log(), data_provider::children, data_provider_create(), data_structure_compatible(), data_unlock, data_write_lock, data_provider::handler, LOG_ERROR, data_provider::module, data_provider::name, root_data, and ast_data_handler::version.

Referenced by __ast_data_register_multiple().

{
   struct data_provider *node;

   if (!path) {
      return -1;
   }

   /* check if the handler structure is compatible. */
   if (!data_structure_compatible(handler->version,
      latest_handler_compatible_version,
      current_handler_version)) {
      return -1;
   }

   /* create the node structure for the registered handler. */
   data_write_lock();

   node = data_provider_create(root_data.container, path, registrar);
   if (!node) {
      ast_log(LOG_ERROR, "Unable to create the specified path (%s) "
         "for '%s'.\n", path, registrar);
      data_unlock();
      return -1;
   }

   if (ao2_container_count(node->children) || node->handler) {
      ast_log(LOG_ERROR, "The node '%s' was already registered. "
         "We were unable to register '%s' for registrar '%s'.\n",
         node->name, path, registrar);
      ao2_ref(node, -1);
      data_unlock();
      return -1;
   }

   /* add handler to that node. */
   node->handler = handler;
   node->module = mod;

   ao2_ref(node, -1);

   data_unlock();

   return 0;
}
int __ast_data_register_multiple ( const struct ast_data_entry *  data_entries,
size_t  entries,
const char *  registrar,
struct ast_module *  mod 
)

Register multiple data providers at once.

Parameters:
[in]data_entriesAn array of data_entries structures.
[in]entriesThe number of entries in the data_entries array.
[in]registrarWho is registering this nodes.
[in]modThe module registering this handlers.
Return values:
<0on error (none of the nodes are being registered on error).
0on success.
See also:
__ast_data_register, __ast_data_unregister

Definition at line 561 of file data.c.

References __ast_data_register(), __ast_data_unregister(), and data_provider::handler.

{
   int i, res;

   for (i = 0; i < entries; i++) {
      res = __ast_data_register(data_entries[i].path, data_entries[i].handler,
            registrar, mod);
      if (res) {
         /* unregister all the already registered nodes, and make
          * this an atomic action. */
         while ((--i) >= 0) {
            __ast_data_unregister(data_entries[i].path, registrar);
         }
         return -1;
      }
   }

   return 0;
}
int __ast_data_search_cmp_structure ( const struct ast_data_search *  search,
const struct ast_data_mapping_structure *  mapping,
size_t  mapping_len,
void *  structure,
const char *  structure_name 
)

Based on a search tree, evaluate every member of a structure against it.

Parameters:
[in]searchThe search tree.
[in]mappingThe structure mapping.
[in]mapping_lenThe lenght of the structure mapping.
[in]structureThe structure pointer.
[in]structure_nameThe name of the structure to compare.
Return values:
0If the structure matches.
1If the structure doesn't match.

Definition at line 1267 of file data.c.

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, AST_DATA_BOOLEAN, ast_data_mapping_structure::AST_DATA_BOOLEAN, AST_DATA_CHARACTER, ast_data_mapping_structure::AST_DATA_CHARACTER, AST_DATA_CONTAINER, AST_DATA_DOUBLE, ast_data_mapping_structure::AST_DATA_DOUBLE, AST_DATA_INTEGER, ast_data_mapping_structure::AST_DATA_INTEGER, AST_DATA_IPADDR, ast_data_mapping_structure::AST_DATA_IPADDR, AST_DATA_MILLISECONDS, ast_data_mapping_structure::AST_DATA_MILLISECONDS, AST_DATA_PASSWORD, ast_data_mapping_structure::AST_DATA_PASSWORD, AST_DATA_POINTER, ast_data_mapping_structure::AST_DATA_POINTER, AST_DATA_SECONDS, ast_data_mapping_structure::AST_DATA_SECONDS, AST_DATA_STRING, ast_data_mapping_structure::AST_DATA_STRING, AST_DATA_TIMESTAMP, ast_data_mapping_structure::AST_DATA_TIMESTAMP, AST_DATA_UNSIGNED_INTEGER, ast_data_mapping_structure::AST_DATA_UNSIGNED_INTEGER, ast_data_search::children, data_search_cmp_bool(), data_search_cmp_char(), data_search_cmp_dbl(), data_search_cmp_int(), data_search_cmp_ipaddr(), data_search_cmp_ptr(), data_search_cmp_string(), data_search_cmp_uint(), data_search_get_node(), data_search_mapping_find(), ast_data_mapping_structure::get, ast_data_search::name, and type.

{
   struct ao2_iterator i;
   struct ast_data_search *node, *struct_children;
   int member, notmatch = 0;

   if (!search) {
      return 0;
   }

   struct_children = data_search_get_node(search, structure_name);
   if (!struct_children) {
      return 0;
   }

   i = ao2_iterator_init(struct_children->children, 0);
   while ((node = ao2_iterator_next(&i))) {
      member = data_search_mapping_find(mapping, mapping_len, node->name);
      if (member < 0) {
         /* the structure member name doesn't match! */
         ao2_ref(node, -1);
         ao2_ref(struct_children, -1);
         ao2_iterator_destroy(&i);
         return 0;
      }

      notmatch = 0;
      switch (mapping[member].type) {
      case AST_DATA_PASSWORD:
         notmatch = data_search_cmp_string(struct_children,
            node->name,
            mapping[member].get.AST_DATA_PASSWORD(structure));
         break;
      case AST_DATA_TIMESTAMP:
         notmatch = data_search_cmp_uint(struct_children,
            node->name,
            mapping[member].get.AST_DATA_TIMESTAMP(structure));
         break;
      case AST_DATA_SECONDS:
         notmatch = data_search_cmp_uint(struct_children,
            node->name,
            mapping[member].get.AST_DATA_SECONDS(structure));
         break;
      case AST_DATA_MILLISECONDS:
         notmatch = data_search_cmp_uint(struct_children,
            node->name,
            mapping[member].get.AST_DATA_MILLISECONDS(structure));
         break;
      case AST_DATA_STRING:
         notmatch = data_search_cmp_string(struct_children,
            node->name,
            mapping[member].get.AST_DATA_STRING(structure));
         break;
      case AST_DATA_CHARACTER:
         notmatch = data_search_cmp_char(struct_children,
            node->name,
            mapping[member].get.AST_DATA_CHARACTER(structure));
         break;
      case AST_DATA_INTEGER:
         notmatch = data_search_cmp_int(struct_children,
            node->name,
            mapping[member].get.AST_DATA_INTEGER(structure));
         break;
      case AST_DATA_BOOLEAN:
         notmatch = data_search_cmp_bool(struct_children,
            node->name,
            mapping[member].get.AST_DATA_BOOLEAN(structure));
         break;
      case AST_DATA_UNSIGNED_INTEGER:
         notmatch = data_search_cmp_uint(struct_children,
            node->name,
            mapping[member].get.AST_DATA_UNSIGNED_INTEGER(structure));
         break;
      case AST_DATA_DOUBLE:
         notmatch = data_search_cmp_dbl(struct_children,
            node->name,
            mapping[member].get.AST_DATA_DOUBLE(structure));
         break;
      case AST_DATA_IPADDR:
         notmatch = data_search_cmp_ipaddr(struct_children,
            node->name,
            mapping[member].get.AST_DATA_IPADDR(structure));
         break;
      case AST_DATA_POINTER:
         notmatch = data_search_cmp_ptr(struct_children,
            node->name,
            mapping[member].get.AST_DATA_POINTER(structure));
         break;
      case AST_DATA_CONTAINER:
         break;
      }

      ao2_ref(node, -1);
   }
   ao2_iterator_destroy(&i);

   ao2_ref(struct_children, -1);

   return notmatch;
}
int __ast_data_unregister ( const char *  path,
const char *  registrar 
)

Unregister a data provider.

Parameters:
[in]pathWhich node to unregister, if path is NULL unregister every node registered by the passed 'registrar'.
[in]registrarWho is trying to unregister this node, only the owner (the one who registered the node) will be able to unregister it.
See also:
ast_data_register
Return values:
<0on error.
0on success.
See also:
__ast_data_register, __ast_data_register_multiple

Definition at line 582 of file data.c.

References ast_log(), data_provider_release(), data_provider_release_all(), data_unlock, data_write_lock, LOG_ERROR, and root_data.

Referenced by __ast_data_register_multiple().

{
   int ret = 0;

   data_write_lock();
   if (path) {
      ret = data_provider_release(root_data.container, path, registrar);
   } else {
      data_provider_release_all(root_data.container, registrar);
   }
   data_unlock();

   if (path && ret) {
      ast_log(LOG_ERROR, "Unable to unregister '%s' for '%s'\n",
         path, registrar);
   }

   return ret;
}
struct ast_data* ast_data_add_bool ( struct ast_data *  root,
const char *  childname,
unsigned int  boolean 
) [read]

Add a boolean node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]booleanThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2338 of file data.c.

References __ast_data_add(), and AST_DATA_BOOLEAN.

Referenced by __ast_data_add_structure(), agents_data_provider_get(), ast_channel_data_add_structure(), channel_data_add_flags(), dahdi_status_data_provider_get(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), peers_data_provider_get(), and users_data_provider_get().

{
   return __ast_data_add(root, childname, AST_DATA_BOOLEAN, &boolean);
}
struct ast_data* ast_data_add_char ( struct ast_data *  root,
const char *  childname,
char  value 
) [read]

Add a char node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]valueThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2321 of file data.c.

References __ast_data_add(), and AST_DATA_CHARACTER.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, name, AST_DATA_CHARACTER, &value);
}
int ast_data_add_codecs ( struct ast_data *  root,
const char *  node_name,
format_t  capability 
)

Add the list of codecs in the root node based on the capability parameter.

Parameters:
[in]rootThe astdata root node where to add the codecs node.
[in]node_nameThe name of the node where we are going to add the list of codecs.
[in]capabilityThe codecs allowed.
Returns:
< 0 on error.
0 on success.

Definition at line 3103 of file data.c.

References ast_data_add_int(), ast_data_add_node(), ast_data_add_str(), ast_get_format_list(), ast_format_list::bits, desc, ast_format_list::fr_len, data_filter::name, and ast_format_list::samplespersecond.

Referenced by ast_channel_data_add_structure(), data_channeltypes_provider_handler(), peers_data_provider_get(), and users_data_provider_get().

{
   struct ast_data *codecs, *codec;
   size_t fmlist_size;
   const struct ast_format_list *fmlist;
   int x;

   codecs = ast_data_add_node(root, node_name);
   if (!codecs) {
      return -1;
   }
   fmlist = ast_get_format_list(&fmlist_size);
   for (x = 0; x < fmlist_size; x++) {
      if (fmlist[x].bits & capability) {
         codec = ast_data_add_node(codecs, "codec");
         if (!codec) {
            return -1;
         }
         ast_data_add_str(codec, "name", fmlist[x].name);
         ast_data_add_int(codec, "samplespersecond", fmlist[x].samplespersecond);
         ast_data_add_str(codec, "description", fmlist[x].desc);
         ast_data_add_int(codec, "frame_length", fmlist[x].fr_len);
      }
   }

   return 0;
}
struct ast_data* ast_data_add_dbl ( struct ast_data *  root,
const char *  childname,
double  dbl 
) [read]

Add a floating point node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]dblThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2332 of file data.c.

References __ast_data_add(), and AST_DATA_DOUBLE.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, childname, AST_DATA_DOUBLE, &dbl);
}
struct ast_data* ast_data_add_int ( struct ast_data *  root,
const char *  childname,
int  value 
) [read]

Add an integer node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]valueThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2316 of file data.c.

References __ast_data_add(), and AST_DATA_INTEGER.

Referenced by __ast_data_add_structure(), ast_cdr_data_add_structure(), ast_channel_data_add_structure(), ast_data_add_codecs(), dahdi_status_data_provider_get(), data_odbc_provider_handler(), hints_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), user_add_provider_cb(), users_data_provider_get(), and vm_users_data_provider_get_helper().

{
   return __ast_data_add(root, name, AST_DATA_INTEGER, &value);
}
struct ast_data* ast_data_add_ipaddr ( struct ast_data *  root,
const char *  childname,
struct in_addr  addr 
) [read]

Add a ipv4 address type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]addrThe ipv4 address value.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2344 of file data.c.

References __ast_data_add(), and AST_DATA_IPADDR.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, childname, AST_DATA_IPADDR, &addr);
}
struct ast_data* ast_data_add_milliseconds ( struct ast_data *  root,
const char *  childname,
unsigned int  milliseconds 
) [read]

Add a milliseconds node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]millisecondsThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2368 of file data.c.

References __ast_data_add(), and AST_DATA_MILLISECONDS.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, childname, AST_DATA_MILLISECONDS, &milliseconds);
}
struct ast_data* ast_data_add_node ( struct ast_data *  root,
const char *  childname 
) [read]

Add a container child.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2311 of file data.c.

References __ast_data_add(), and AST_DATA_CONTAINER.

Referenced by agents_data_provider_get(), ast_cdr_data_add_structure(), ast_channel_data_add_structure(), ast_data_add_codecs(), ast_tone_zone_data_add_structure(), dahdi_channels_data_provider_get(), dahdi_status_data_provider_get(), data_channels_provider_handler(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), user_add_provider_cb(), users_data_provider_get(), and vm_users_data_provider_get_helper().

{
   return __ast_data_add(root, name, AST_DATA_CONTAINER, NULL);
}
struct ast_data* ast_data_add_password ( struct ast_data *  root,
const char *  childname,
const char *  string 
) [read]

Add a password node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]stringThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2374 of file data.c.

References __ast_data_add(), AST_DATA_PASSWORD, ast_free, ast_malloc, ast_strlen_zero(), and data_filter::name.

Referenced by __ast_data_add_structure(), and users_data_provider_get().

{
   char *name;
   size_t namelen = 1 + (ast_strlen_zero(value) ? 0 : strlen(value));
   struct ast_data *res;

   if (!(name = ast_malloc(namelen))) {
      return NULL;
   }

   strcpy(name, (ast_strlen_zero(value) ? "" : value));

   res = __ast_data_add(root, childname, AST_DATA_PASSWORD, name);
   if (!res) {
      ast_free(name);
   }

   return res;
}
struct ast_data* ast_data_add_ptr ( struct ast_data *  root,
const char *  childname,
void *  ptr 
) [read]

Add a ptr node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]ptrThe pointer value to add.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2350 of file data.c.

References __ast_data_add(), and AST_DATA_POINTER.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, childname, AST_DATA_POINTER, ptr);
}
struct ast_data* ast_data_add_seconds ( struct ast_data *  root,
const char *  childname,
unsigned int  seconds 
) [read]

Add a seconds node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]secondsThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2362 of file data.c.

References __ast_data_add(), and AST_DATA_SECONDS.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, childname, AST_DATA_SECONDS, &seconds);
}
struct ast_data* ast_data_add_str ( struct ast_data *  root,
const char *  childname,
const char *  string 
) [read]

Add a string node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]stringThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2395 of file data.c.

References __ast_data_add(), AST_DATA_STRING, ast_free, ast_malloc, ast_strlen_zero(), and data_filter::name.

Referenced by __ast_data_add_structure(), agents_data_provider_get(), ast_cdr_data_add_structure(), ast_channel_data_add_structure(), ast_data_add_codecs(), dahdi_status_data_provider_get(), dahdi_version_data_provider_get(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), and users_data_provider_get().

{
   char *name;
   size_t namelen = 1 + (ast_strlen_zero(value) ? 0 : strlen(value));
   struct ast_data *res;

   if (!(name = ast_malloc(namelen))) {
      return NULL;
   }

   strcpy(name, (ast_strlen_zero(value) ? "" : value));

   res = __ast_data_add(root, childname, AST_DATA_STRING, name);
   if (!res) {
      ast_free(name);
   }

   return res;
}
struct ast_data* ast_data_add_timestamp ( struct ast_data *  root,
const char *  childname,
unsigned int  timestamp 
) [read]

Add a timestamp node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]timestampThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2356 of file data.c.

References __ast_data_add(), and AST_DATA_TIMESTAMP.

Referenced by __ast_data_add_structure().

{
   return __ast_data_add(root, childname, AST_DATA_TIMESTAMP, &timestamp);
}
struct ast_data* ast_data_add_uint ( struct ast_data *  root,
const char *  childname,
unsigned int  value 
) [read]

Add an unsigned integer node type.

Parameters:
[in]rootThe root of the ast_data to insert into.
[in]childnameThe name of the child element to be added.
[in]valueThe value for the new node.
Return values:
NULLon error (memory exhaustion only).
non-NULLa newly allocated node.

Definition at line 2326 of file data.c.

References __ast_data_add(), and AST_DATA_UNSIGNED_INTEGER.

Referenced by __ast_data_add_structure(), and ast_channel_data_add_structure().

{
   return __ast_data_add(root, name, AST_DATA_UNSIGNED_INTEGER, &value);
}
void ast_data_free ( struct ast_data *  root)

Release the allocated memory of a tree.

Parameters:
[in]rootThe sub-tree pointer returned by a call to ast_data_get.
See also:
ast_data_get

Definition at line 2485 of file data.c.

References ao2_ref.

Referenced by ast_data_get_xml(), handle_cli_data_get(), and manager_data_get().

{
   /* destroy it, this will destroy all the internal nodes. */
   ao2_ref(root, -1);
}
struct ast_data* ast_data_get ( const struct ast_data_query *  query) [read]

Retrieve a subtree from the asterisk data API.

Parameters:
[in]queryThe query structure specifying what nodes to retrieve.
Return values:
NULLon error.
non-NULLThe dynamically allocated requested sub-tree (it needs to be released using ast_data_free.
See also:
ast_data_free, ast_data_get_xml

Definition at line 2060 of file data.c.

References ast_log(), data_read_lock, data_result_generate(), data_structure_compatible(), data_unlock, LOG_ERROR, ast_data_query::path, and ast_data_query::version.

Referenced by ast_data_get_xml(), handle_cli_data_get(), and manager_data_get().

{
   struct ast_data *res;

   /* check compatibility */
   if (!data_structure_compatible(query->version, latest_query_compatible_version,
      current_query_version)) {
      return NULL;
   }

   data_read_lock();
   res = data_result_generate(query, query->path);
   data_unlock();

   if (!res) {
      ast_log(LOG_ERROR, "Unable to get data from %s\n", query->path);
      return NULL;
   }

   return res;
}
struct ast_xml_doc* ast_data_get_xml ( const struct ast_data_query *  query) [read]

Retrieve a subtree from the asterisk data API in XML format..

Parameters:
[in]queryThe query structure specifying what nodes to retrieve.
Return values:
NULLon error.
non-NULLThe dynamically allocated requested sub-tree (it needs to be released using ast_data_free.
See also:
ast_data_free, ast_data_get

Definition at line 2176 of file data.c.

References ast_data_free(), ast_data_get(), ast_xml_close(), ast_xml_new(), ast_xml_new_node(), ast_xml_set_root(), data_get_xml_add_child(), and ast_data::name.

{
   struct ast_xml_doc *doc;
   struct ast_xml_node *root;
   struct ast_data *res;

   res = ast_data_get(query);
   if (!res) {
      return NULL;
   }

   doc = ast_xml_new();
   if (!doc) {
      return NULL;
   }

   root = ast_xml_new_node(res->name);
   if (!root) {
      ast_xml_close(doc);
   }

   ast_xml_set_root(doc, root);

   data_get_xml_add_child(res, root);

   ast_data_free(res);

   return doc;
}
void ast_data_iterator_end ( struct ast_data_iterator *  iterator)

Release (stop using) an iterator.

Parameters:
[in]iteratorThe iterator created by ast_data_iterator_start.
See also:
ast_data_iterator_start

Definition at line 2534 of file data.c.

References ao2_iterator_destroy(), ao2_ref, ast_free, ast_data_iterator::internal_iterator, ast_data_iterator::is_pattern, ast_data_iterator::last, and ast_data_iterator::regex_pattern.

{
   /* decrement the reference counter. */
   if (iterator->last) {
      ao2_ref(iterator->last, -1);
   }

   /* release the generated pattern. */
   if (iterator->is_pattern) {
      regfree(&(iterator->regex_pattern));
   }

   ao2_iterator_destroy(&(iterator->internal_iterator));

   ast_free(iterator);
   iterator = NULL;
}
struct ast_data_iterator* ast_data_iterator_init ( struct ast_data *  tree,
const char *  elements 
) [read]

Initialize an iterator.

Parameters:
[in]treeThe returned tree by a call to ast_data_get.
[in]elementsWhich elements to iterate through.
Return values:
NULLon error.
non-NULLA dinamically allocated iterator structure.

Definition at line 2491 of file data.c.

References ao2_iterator_init(), ast_calloc, ast_strdupa, data_result_get_node(), ast_data_iterator::internal_iterator, ast_data_iterator::is_pattern, ast_data_iterator::pattern, ast_data::ptr, and ast_data_iterator::regex_pattern.

{
   struct ast_data_iterator *iterator;
   struct ao2_iterator i;
   struct ast_data *internal = tree;
   char *path, *ptr = NULL;

   /* tree is the node we want to use to iterate? or we are going
    * to iterate thow an internal node? */
   if (elements) {
      path = ast_strdupa(elements);

      ptr = strrchr(path, '/');
      if (ptr) {
         *ptr = '\0';
         internal = data_result_get_node(tree, path);
         if (!internal) {
            return NULL;
         }
      }
   }

   iterator = ast_calloc(1, sizeof(*iterator));
   if (!iterator) {
      return NULL;
   }

   i = ao2_iterator_init(internal->children, 0);

   iterator->pattern = (ptr ? strrchr(elements, '/') + 1 : elements);

   /* is the last node a regular expression?, compile it! */
   if (!regcomp(&(iterator->regex_pattern), iterator->pattern,
         REG_EXTENDED | REG_NOSUB | REG_ICASE)) {
      iterator->is_pattern = 1;
   }

   iterator->internal_iterator = i;

   return iterator;
}
struct ast_data* ast_data_iterator_next ( struct ast_data_iterator *  iterator) [read]

Get the next node of the tree.

Parameters:
[in]iteratorThe iterator structure returned by ast_data_iterator_start.
Return values:
NULLwhen no more nodes to return.
non-NULLA node of the ast_data tree.
See also:
ast_data_iterator_start, ast_data_iterator_stop

Definition at line 2552 of file data.c.

References ao2_iterator_next, ao2_ref, ast_data_iterator::internal_iterator, ast_data_iterator::is_pattern, ast_data_iterator::last, ast_data::name, ast_data_iterator::pattern, and ast_data_iterator::regex_pattern.

{
   struct ast_data *res;

   if (iterator->last) {
      /* release the last retrieved node reference. */
      ao2_ref(iterator->last, -1);
   }

   while ((res = ao2_iterator_next(&iterator->internal_iterator))) {
      /* if there is no node name pattern specified, return
       * the next node. */
      if (!iterator->pattern) {
         break;
      }

      /* if the pattern is a regular expression, check if this node
       * matches. */
      if (iterator->is_pattern && !regexec(&(iterator->regex_pattern),
         res->name, 0, NULL, 0)) {
         break;
      }

      /* if there is a pattern specified, check if this node matches
       * the wanted node names. */
      if (!iterator->is_pattern && (iterator->pattern &&
            !strcasecmp(res->name, iterator->pattern))) {
         break;
      }

      ao2_ref(res, -1);
   }

   iterator->last = res;

   return res;
}
void ast_data_remove_node ( struct ast_data *  root,
struct ast_data *  child 
)

Remove a node that was added using ast_data_add_.

Parameters:
[in]rootThe root node of the node to be removed.
[in]childThe node pointer to remove.

Definition at line 2480 of file data.c.

References ao2_unlink, and ast_data::children.

Referenced by agents_data_provider_get(), dahdi_channels_data_provider_get(), dahdi_status_data_provider_get(), data_channels_provider_handler(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), users_data_provider_get(), and vm_users_data_provider_get_helper().

{
   ao2_unlink(root->children, child);
}
int ast_data_retrieve ( struct ast_data *  tree,
const char *  path,
struct ast_data_retrieve *  content 
)

Retrieve a value from a node in the tree.

Parameters:
[in]treeThe structure returned by a call to ast_data_get.
[in]pathThe path to the node.
[out]contentThe node content.
Return values:
0on success.
<0on error.

Definition at line 2590 of file data.c.

References AST_DATA_BOOLEAN, ast_data_retrieve::AST_DATA_BOOLEAN, AST_DATA_CHARACTER, ast_data_retrieve::AST_DATA_CHARACTER, AST_DATA_CONTAINER, AST_DATA_DOUBLE, ast_data_retrieve::AST_DATA_DOUBLE, AST_DATA_INTEGER, ast_data_retrieve::AST_DATA_INTEGER, AST_DATA_IPADDR, ast_data_retrieve::AST_DATA_IPADDR, AST_DATA_MILLISECONDS, ast_data_retrieve::AST_DATA_MILLISECONDS, AST_DATA_PASSWORD, ast_data_retrieve::AST_DATA_PASSWORD, AST_DATA_POINTER, ast_data_retrieve::AST_DATA_POINTER, AST_DATA_SECONDS, ast_data_retrieve::AST_DATA_SECONDS, AST_DATA_STRING, ast_data_retrieve::AST_DATA_STRING, AST_DATA_TIMESTAMP, ast_data_retrieve::AST_DATA_TIMESTAMP, AST_DATA_UNSIGNED_INTEGER, ast_data_retrieve::AST_DATA_UNSIGNED_INTEGER, ast_log(), ast_data::boolean, ast_data::character, data_result_get_node(), ast_data::dbl, ast_data::ipaddr, LOG_ERROR, ast_data::payload, ast_data::ptr, ast_data::sint, ast_data::str, ast_data::type, ast_data_retrieve::type, ast_data::uint, and ast_data_retrieve::value.

Referenced by ast_data_retrieve_bool(), ast_data_retrieve_char(), ast_data_retrieve_dbl(), ast_data_retrieve_int(), ast_data_retrieve_ipaddr(), ast_data_retrieve_password(), ast_data_retrieve_ptr(), ast_data_retrieve_string(), and ast_data_retrieve_uint().

{
   struct ast_data *node;

   if (!content) {
      return -1;
   }

   node = data_result_get_node(tree, path);
   if (!node) {
      ast_log(LOG_ERROR, "Invalid internal node %s\n", path);
      return -1;
   }

   content->type = node->type;
   switch (node->type) {
   case AST_DATA_STRING:
      content->value.AST_DATA_STRING = node->payload.str;
      break;
   case AST_DATA_PASSWORD:
      content->value.AST_DATA_PASSWORD = node->payload.str;
      break;
   case AST_DATA_TIMESTAMP:
      content->value.AST_DATA_TIMESTAMP = node->payload.uint;
      break;
   case AST_DATA_SECONDS:
      content->value.AST_DATA_SECONDS = node->payload.uint;
      break;
   case AST_DATA_MILLISECONDS:
      content->value.AST_DATA_MILLISECONDS = node->payload.uint;
      break;
   case AST_DATA_CHARACTER:
      content->value.AST_DATA_CHARACTER = node->payload.character;
      break;
   case AST_DATA_INTEGER:
      content->value.AST_DATA_INTEGER = node->payload.sint;
      break;
   case AST_DATA_UNSIGNED_INTEGER:
      content->value.AST_DATA_UNSIGNED_INTEGER = node->payload.uint;
      break;
   case AST_DATA_BOOLEAN:
      content->value.AST_DATA_BOOLEAN = node->payload.boolean;
      break;
   case AST_DATA_IPADDR:
      content->value.AST_DATA_IPADDR = node->payload.ipaddr;
      break;
   case AST_DATA_DOUBLE:
      content->value.AST_DATA_DOUBLE = node->payload.dbl;
      break;
   case AST_DATA_CONTAINER:
      break;
   case AST_DATA_POINTER:
      content->value.AST_DATA_POINTER = node->payload.ptr;
      break;
   }

   return 0;
}
static unsigned int ast_data_retrieve_bool ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the boolean value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 703 of file data.h.

References ast_data_retrieve::AST_DATA_BOOLEAN, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_BOOLEAN;
}
static char ast_data_retrieve_char ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the character value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 688 of file data.h.

References ast_data_retrieve::AST_DATA_CHARACTER, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_CHARACTER;
}
static double ast_data_retrieve_dbl ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the double value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 778 of file data.h.

References ast_data_retrieve::AST_DATA_DOUBLE, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_DOUBLE;
}
static int ast_data_retrieve_int ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the integer value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 673 of file data.h.

References ast_data_retrieve::AST_DATA_INTEGER, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_INTEGER;
}
static struct in_addr ast_data_retrieve_ipaddr ( struct ast_data *  tree,
const char *  path 
) [static, read]

Retrieve the ipv4 address value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 793 of file data.h.

References ast_data_retrieve::AST_DATA_IPADDR, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_IPADDR;
}
char* ast_data_retrieve_name ( struct ast_data *  node)

Get the node name.

Parameters:
[in]nodeThe node pointer.
Returns:
The node name.

Definition at line 2219 of file data.c.

References ast_data::name.

{
   return node->name;
}
static const char* ast_data_retrieve_password ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the password value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 733 of file data.h.

References ast_data_retrieve::AST_DATA_PASSWORD, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_PASSWORD;
}
static void* ast_data_retrieve_ptr ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the ptr value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 763 of file data.h.

References ast_data_retrieve::AST_DATA_POINTER, ast_data_retrieve(), and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_POINTER;
}
static const char* ast_data_retrieve_string ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the string value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 748 of file data.h.

References ast_data_retrieve(), ast_data_retrieve::AST_DATA_STRING, and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_STRING;
}
enum ast_data_type ast_data_retrieve_type ( struct ast_data *  res,
const char *  path 
)

Get a node type.

Parameters:
[in]resA pointer to the ast_data result set.
[in]pathA path to the node to get the type.
Returns:
The type of the requested node type.

Definition at line 2207 of file data.c.

References data_result_get_node().

{
   struct ast_data *internal;

   internal = data_result_get_node(node, path);
   if (!internal) {
      return -1;
   }

   return internal->type;
}
static unsigned int ast_data_retrieve_uint ( struct ast_data *  tree,
const char *  path 
) [inline, static]

Retrieve the unsigned integer value of a node.

Parameters:
[in]treeThe tree from where to get the value.
[in]pathThe node name or path.
Returns:
The value of the node.

Definition at line 718 of file data.h.

References ast_data_retrieve(), ast_data_retrieve::AST_DATA_UNSIGNED_INTEGER, and ast_data_retrieve::value.

{
   struct ast_data_retrieve ret;

   ast_data_retrieve(tree, path, &ret);

   return ret.value.AST_DATA_UNSIGNED_INTEGER;
}
int ast_data_search_match ( const struct ast_data_search *  search,
struct ast_data *  data 
)

Check the current generated node to know if it matches the search condition.

Parameters:
[in]searchThe search condition.
[in]dataThe AstData node generated.
Returns:
1 If the "data" node matches the search condition.
0 If the "data" node does not matches the search condition.
See also:
ast_data_remove_node

Definition at line 1453 of file data.c.

References ao2_container_count(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, AST_DATA_BOOLEAN, AST_DATA_CHARACTER, AST_DATA_CONTAINER, AST_DATA_DOUBLE, AST_DATA_INTEGER, AST_DATA_IPADDR, AST_DATA_MILLISECONDS, AST_DATA_PASSWORD, AST_DATA_POINTER, ast_data_search_match(), AST_DATA_SECONDS, AST_DATA_STRING, AST_DATA_TIMESTAMP, AST_DATA_UNSIGNED_INTEGER, ast_data::boolean, ast_data::character, ast_data::children, ast_data_search::children, data_result_find_child(), data_search_cmp_bool(), data_search_cmp_char(), data_search_cmp_int(), data_search_cmp_ipaddr(), data_search_cmp_ptr(), data_search_cmp_string(), data_search_cmp_uint(), data_search_find(), ast_data::dbl, ast_data::ipaddr, ast_data::name, ast_data_search::name, ast_data::payload, ast_data::ptr, ast_data::sint, ast_data::str, ast_data::type, and ast_data::uint.

Referenced by agents_data_provider_get(), ast_data_search_match(), dahdi_channels_data_provider_get(), dahdi_status_data_provider_get(), data_channels_provider_handler(), data_channeltypes_provider_handler(), data_odbc_provider_handler(), hints_data_provider_get(), meetme_data_provider_get(), peers_data_provider_get(), queues_data_provider_get_helper(), users_data_provider_get(), and vm_users_data_provider_get_helper().

{
   struct ao2_iterator i, ii;
   struct ast_data_search *s, *s_child;
   struct ast_data *d_child;
   int notmatch = 1;

   if (!search) {
      return 1;
   }

   s_child = data_search_find(search->children, data->name);
   if (!s_child) {
      /* nothing to compare */
      ao2_ref(s_child, -1);
      return 1;
   }

   i = ao2_iterator_init(s_child->children, 0);
   while ((s = ao2_iterator_next(&i))) {
      if (!ao2_container_count(s->children)) {
         /* compare this search node with every data node */
         d_child = data_result_find_child(data, s->name);
         if (!d_child) {
            ao2_ref(s, -1);
            notmatch = 1;
            continue;
         }

         switch (d_child->type) {
         case AST_DATA_PASSWORD:
         case AST_DATA_STRING:
            notmatch = data_search_cmp_string(s_child, d_child->name,
               d_child->payload.str);
            break;
         case AST_DATA_CHARACTER:
            notmatch = data_search_cmp_char(s_child, d_child->name,
               d_child->payload.character);
            break;
         case AST_DATA_INTEGER:
            notmatch = data_search_cmp_int(s_child, d_child->name,
               d_child->payload.sint);
            break;
         case AST_DATA_BOOLEAN:
            notmatch = data_search_cmp_bool(s_child, d_child->name,
               d_child->payload.boolean);
            break;
         case AST_DATA_UNSIGNED_INTEGER:
            notmatch = data_search_cmp_uint(s_child, d_child->name,
               d_child->payload.uint);
            break;
         case AST_DATA_TIMESTAMP:
         case AST_DATA_SECONDS:
         case AST_DATA_MILLISECONDS:
         case AST_DATA_DOUBLE:
            notmatch = data_search_cmp_uint(s_child, d_child->name,
               d_child->payload.dbl);
            break;
         case AST_DATA_IPADDR:
            notmatch = data_search_cmp_ipaddr(s_child, d_child->name,
               d_child->payload.ipaddr);
            break;
         case AST_DATA_POINTER:
            notmatch = data_search_cmp_ptr(s_child, d_child->name,
               d_child->payload.ptr);
            break;
         case AST_DATA_CONTAINER:
            break;
         }
         ao2_ref(d_child, -1);
      } else {
         ii = ao2_iterator_init(data->children, 0);
         while ((d_child = ao2_iterator_next(&ii))) {
            if (strcmp(d_child->name, s->name)) {
               ao2_ref(d_child, -1);
               continue;
            }
            if (!(notmatch = !ast_data_search_match(s_child, d_child))) {
               /* do not continue if we have a match. */
               ao2_ref(d_child, -1);
               break;
            }
            ao2_ref(d_child, -1);
         }
         ao2_iterator_destroy(&ii);
      }
      ao2_ref(s, -1);
      if (notmatch) {
         /* do not continue if we don't have a match. */
         break;
      }
   }
   ao2_iterator_destroy(&i);

   ao2_ref(s_child, -1);

   return !notmatch;
}