Mon Jun 27 16:51:13 2011

Asterisk developer's documentation


data.h File Reference

Data retrieval API. More...

#include "asterisk/frame.h"

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.
ast_dataast_data_add_bool (struct ast_data *root, const char *childname, unsigned int boolean)
 Add a boolean node type.
ast_dataast_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.
ast_dataast_data_add_dbl (struct ast_data *root, const char *childname, double dbl)
 Add a floating point node type.
ast_dataast_data_add_int (struct ast_data *root, const char *childname, int value)
 Add an integer node type.
ast_dataast_data_add_ipaddr (struct ast_data *root, const char *childname, struct in_addr addr)
 Add a ipv4 address type.
ast_dataast_data_add_milliseconds (struct ast_data *root, const char *childname, unsigned int milliseconds)
 Add a milliseconds node type.
ast_dataast_data_add_node (struct ast_data *root, const char *childname)
 Add a container child.
ast_dataast_data_add_password (struct ast_data *root, const char *childname, const char *string)
 Add a password node type.
ast_dataast_data_add_ptr (struct ast_data *root, const char *childname, void *ptr)
 Add a ptr node type.
ast_dataast_data_add_seconds (struct ast_data *root, const char *childname, unsigned int seconds)
 Add a seconds node type.
ast_dataast_data_add_str (struct ast_data *root, const char *childname, const char *string)
 Add a string node type.
ast_dataast_data_add_timestamp (struct ast_data *root, const char *childname, unsigned int timestamp)
 Add a timestamp node type.
ast_dataast_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.
ast_dataast_data_get (const struct ast_data_query *query)
 Retrieve a subtree from the asterisk data API.
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.
ast_data_iteratorast_data_iterator_init (struct ast_data *tree, const char *elements)
 Initialize an iterator.
ast_dataast_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.


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] root Where to add the structure.
[in] mapping The structure mapping array.
[in] mapping_len The lenght of the mapping array.
[in] structure The structure pointer.
Return values:
0 on success.
1 on 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_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, name, and type.

02419 {
02420    int i;
02421 
02422    for (i = 0; i < mapping_len; i++) {
02423       switch (mapping[i].type) {
02424       case AST_DATA_INTEGER:
02425          ast_data_add_int(root, mapping[i].name,
02426             mapping[i].get.AST_DATA_INTEGER(structure));
02427          break;
02428       case AST_DATA_UNSIGNED_INTEGER:
02429          ast_data_add_uint(root, mapping[i].name,
02430             mapping[i].get.AST_DATA_UNSIGNED_INTEGER(structure));
02431          break;
02432       case AST_DATA_DOUBLE:
02433          ast_data_add_dbl(root, mapping[i].name,
02434             mapping[i].get.AST_DATA_DOUBLE(structure));
02435          break;
02436       case AST_DATA_BOOLEAN:
02437          ast_data_add_bool(root, mapping[i].name,
02438             mapping[i].get.AST_DATA_BOOLEAN(structure));
02439          break;
02440       case AST_DATA_PASSWORD:
02441          ast_data_add_password(root, mapping[i].name,
02442             mapping[i].get.AST_DATA_PASSWORD(structure));
02443          break;
02444       case AST_DATA_TIMESTAMP:
02445          ast_data_add_timestamp(root, mapping[i].name,
02446             mapping[i].get.AST_DATA_TIMESTAMP(structure));
02447          break;
02448       case AST_DATA_SECONDS:
02449          ast_data_add_seconds(root, mapping[i].name,
02450             mapping[i].get.AST_DATA_SECONDS(structure));
02451          break;
02452       case AST_DATA_MILLISECONDS:
02453          ast_data_add_milliseconds(root, mapping[i].name,
02454             mapping[i].get.AST_DATA_MILLISECONDS(structure));
02455          break;
02456       case AST_DATA_STRING:
02457          ast_data_add_str(root, mapping[i].name,
02458             mapping[i].get.AST_DATA_STRING(structure));
02459          break;
02460       case AST_DATA_CHARACTER:
02461          ast_data_add_char(root, mapping[i].name,
02462             mapping[i].get.AST_DATA_CHARACTER(structure));
02463          break;
02464       case AST_DATA_CONTAINER:
02465          break;
02466       case AST_DATA_IPADDR:
02467          ast_data_add_ipaddr(root, mapping[i].name,
02468             mapping[i].get.AST_DATA_IPADDR(structure));
02469          break;
02470       case AST_DATA_POINTER:
02471          ast_data_add_ptr(root, mapping[i].name,
02472             mapping[i].get.AST_DATA_POINTER(structure));
02473          break;
02474       }
02475    }
02476 
02477    return 0;
02478 }

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] path The path of the node to register.
[in] handler The structure defining this node handler.
[in] registrar Who is registering this node.
[in] mod The module registering this handler.
See also:
ast_data_unregister
Return values:
<0 on error.
0 on 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().

00516 {
00517    struct data_provider *node;
00518 
00519    if (!path) {
00520       return -1;
00521    }
00522 
00523    /* check if the handler structure is compatible. */
00524    if (!data_structure_compatible(handler->version,
00525       latest_handler_compatible_version,
00526       current_handler_version)) {
00527       return -1;
00528    }
00529 
00530    /* create the node structure for the registered handler. */
00531    data_write_lock();
00532 
00533    node = data_provider_create(root_data.container, path, registrar);
00534    if (!node) {
00535       ast_log(LOG_ERROR, "Unable to create the specified path (%s) "
00536          "for '%s'.\n", path, registrar);
00537       data_unlock();
00538       return -1;
00539    }
00540 
00541    if (ao2_container_count(node->children) || node->handler) {
00542       ast_log(LOG_ERROR, "The node '%s' was already registered. "
00543          "We were unable to register '%s' for registrar '%s'.\n",
00544          node->name, path, registrar);
00545       ao2_ref(node, -1);
00546       data_unlock();
00547       return -1;
00548    }
00549 
00550    /* add handler to that node. */
00551    node->handler = handler;
00552    node->module = mod;
00553 
00554    ao2_ref(node, -1);
00555 
00556    data_unlock();
00557 
00558    return 0;
00559 }

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_entries An array of data_entries structures.
[in] entries The number of entries in the data_entries array.
[in] registrar Who is registering this nodes.
[in] mod The module registering this handlers.
Return values:
<0 on error (none of the nodes are being registered on error).
0 on 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.

00563 {
00564    int i, res;
00565 
00566    for (i = 0; i < entries; i++) {
00567       res = __ast_data_register(data_entries[i].path, data_entries[i].handler,
00568             registrar, mod);
00569       if (res) {
00570          /* unregister all the already registered nodes, and make
00571           * this an atomic action. */
00572          while ((--i) >= 0) {
00573             __ast_data_unregister(data_entries[i].path, registrar);
00574          }
00575          return -1;
00576       }
00577    }
00578 
00579    return 0;
00580 }

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] search The search tree.
[in] mapping The structure mapping.
[in] mapping_len The lenght of the structure mapping.
[in] structure The structure pointer.
[in] structure_name The name of the structure to compare.
Return values:
0 If the structure matches.
1 If 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.

01270 {
01271    struct ao2_iterator i;
01272    struct ast_data_search *node, *struct_children;
01273    int member, notmatch = 0;
01274 
01275    if (!search) {
01276       return 0;
01277    }
01278 
01279    struct_children = data_search_get_node(search, structure_name);
01280    if (!struct_children) {
01281       return 0;
01282    }
01283 
01284    i = ao2_iterator_init(struct_children->children, 0);
01285    while ((node = ao2_iterator_next(&i))) {
01286       member = data_search_mapping_find(mapping, mapping_len, node->name);
01287       if (member < 0) {
01288          /* the structure member name doesn't match! */
01289          ao2_ref(node, -1);
01290          ao2_ref(struct_children, -1);
01291          ao2_iterator_destroy(&i);
01292          return 0;
01293       }
01294 
01295       notmatch = 0;
01296       switch (mapping[member].type) {
01297       case AST_DATA_PASSWORD:
01298          notmatch = data_search_cmp_string(struct_children,
01299             node->name,
01300             mapping[member].get.AST_DATA_PASSWORD(structure));
01301          break;
01302       case AST_DATA_TIMESTAMP:
01303          notmatch = data_search_cmp_uint(struct_children,
01304             node->name,
01305             mapping[member].get.AST_DATA_TIMESTAMP(structure));
01306          break;
01307       case AST_DATA_SECONDS:
01308          notmatch = data_search_cmp_uint(struct_children,
01309             node->name,
01310             mapping[member].get.AST_DATA_SECONDS(structure));
01311          break;
01312       case AST_DATA_MILLISECONDS:
01313          notmatch = data_search_cmp_uint(struct_children,
01314             node->name,
01315             mapping[member].get.AST_DATA_MILLISECONDS(structure));
01316          break;
01317       case AST_DATA_STRING:
01318          notmatch = data_search_cmp_string(struct_children,
01319             node->name,
01320             mapping[member].get.AST_DATA_STRING(structure));
01321          break;
01322       case AST_DATA_CHARACTER:
01323          notmatch = data_search_cmp_char(struct_children,
01324             node->name,
01325             mapping[member].get.AST_DATA_CHARACTER(structure));
01326          break;
01327       case AST_DATA_INTEGER:
01328          notmatch = data_search_cmp_int(struct_children,
01329             node->name,
01330             mapping[member].get.AST_DATA_INTEGER(structure));
01331          break;
01332       case AST_DATA_BOOLEAN:
01333          notmatch = data_search_cmp_bool(struct_children,
01334             node->name,
01335             mapping[member].get.AST_DATA_BOOLEAN(structure));
01336          break;
01337       case AST_DATA_UNSIGNED_INTEGER:
01338          notmatch = data_search_cmp_uint(struct_children,
01339             node->name,
01340             mapping[member].get.AST_DATA_UNSIGNED_INTEGER(structure));
01341          break;
01342       case AST_DATA_DOUBLE:
01343          notmatch = data_search_cmp_dbl(struct_children,
01344             node->name,
01345             mapping[member].get.AST_DATA_DOUBLE(structure));
01346          break;
01347       case AST_DATA_IPADDR:
01348          notmatch = data_search_cmp_ipaddr(struct_children,
01349             node->name,
01350             mapping[member].get.AST_DATA_IPADDR(structure));
01351          break;
01352       case AST_DATA_POINTER:
01353          notmatch = data_search_cmp_ptr(struct_children,
01354             node->name,
01355             mapping[member].get.AST_DATA_POINTER(structure));
01356          break;
01357       case AST_DATA_CONTAINER:
01358          break;
01359       }
01360 
01361       ao2_ref(node, -1);
01362    }
01363    ao2_iterator_destroy(&i);
01364 
01365    ao2_ref(struct_children, -1);
01366 
01367    return notmatch;
01368 }

int __ast_data_unregister ( const char *  path,
const char *  registrar 
)

Unregister a data provider.

Parameters:
[in] path Which node to unregister, if path is NULL unregister every node registered by the passed 'registrar'.
[in] registrar Who 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:
<0 on error.
0 on 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().

00583 {
00584    int ret = 0;
00585 
00586    data_write_lock();
00587    if (path) {
00588       ret = data_provider_release(root_data.container, path, registrar);
00589    } else {
00590       data_provider_release_all(root_data.container, registrar);
00591    }
00592    data_unlock();
00593 
00594    if (path && ret) {
00595       ast_log(LOG_ERROR, "Unable to unregister '%s' for '%s'\n",
00596          path, registrar);
00597    }
00598 
00599    return ret;
00600 }

struct ast_data* ast_data_add_bool ( struct ast_data root,
const char *  childname,
unsigned int  boolean 
)

Add a boolean node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] boolean The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02340 {
02341    return __ast_data_add(root, childname, AST_DATA_BOOLEAN, &boolean);
02342 }

struct ast_data* ast_data_add_char ( struct ast_data root,
const char *  childname,
char  value 
)

Add a char node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] value The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02322 {
02323    return __ast_data_add(root, name, AST_DATA_CHARACTER, &value);
02324 }

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] root The astdata root node where to add the codecs node.
[in] node_name The name of the node where we are going to add the list of codecs.
[in] capability The 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, 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().

03104 {
03105    struct ast_data *codecs, *codec;
03106    size_t fmlist_size;
03107    const struct ast_format_list *fmlist;
03108    int x;
03109 
03110    codecs = ast_data_add_node(root, node_name);
03111    if (!codecs) {
03112       return -1;
03113    }
03114    fmlist = ast_get_format_list(&fmlist_size);
03115    for (x = 0; x < fmlist_size; x++) {
03116       if (fmlist[x].bits & capability) {
03117          codec = ast_data_add_node(codecs, "codec");
03118          if (!codec) {
03119             return -1;
03120          }
03121          ast_data_add_str(codec, "name", fmlist[x].name);
03122          ast_data_add_int(codec, "samplespersecond", fmlist[x].samplespersecond);
03123          ast_data_add_str(codec, "description", fmlist[x].desc);
03124          ast_data_add_int(codec, "frame_length", fmlist[x].fr_len);
03125       }
03126    }
03127 
03128    return 0;
03129 }

struct ast_data* ast_data_add_dbl ( struct ast_data root,
const char *  childname,
double  dbl 
)

Add a floating point node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] dbl The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02334 {
02335    return __ast_data_add(root, childname, AST_DATA_DOUBLE, &dbl);
02336 }

struct ast_data* ast_data_add_int ( struct ast_data root,
const char *  childname,
int  value 
)

Add an integer node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] value The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02317 {
02318    return __ast_data_add(root, name, AST_DATA_INTEGER, &value);
02319 }

struct ast_data* ast_data_add_ipaddr ( struct ast_data root,
const char *  childname,
struct in_addr  addr 
)

Add a ipv4 address type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] addr The ipv4 address value.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02346 {
02347    return __ast_data_add(root, childname, AST_DATA_IPADDR, &addr);
02348 }

struct ast_data* ast_data_add_milliseconds ( struct ast_data root,
const char *  childname,
unsigned int  milliseconds 
)

Add a milliseconds node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] milliseconds The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02370 {
02371    return __ast_data_add(root, childname, AST_DATA_MILLISECONDS, &milliseconds);
02372 }

struct ast_data* ast_data_add_node ( struct ast_data root,
const char *  childname 
)

Add a container child.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02312 {
02313    return __ast_data_add(root, name, AST_DATA_CONTAINER, NULL);
02314 }

struct ast_data* ast_data_add_password ( struct ast_data root,
const char *  childname,
const char *  string 
)

Add a password node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] string The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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 name.

Referenced by __ast_data_add_structure(), and users_data_provider_get().

02376 {
02377    char *name;
02378    size_t namelen = 1 + (ast_strlen_zero(value) ? 0 : strlen(value));
02379    struct ast_data *res;
02380 
02381    if (!(name = ast_malloc(namelen))) {
02382       return NULL;
02383    }
02384 
02385    strcpy(name, (ast_strlen_zero(value) ? "" : value));
02386 
02387    res = __ast_data_add(root, childname, AST_DATA_PASSWORD, name);
02388    if (!res) {
02389       ast_free(name);
02390    }
02391 
02392    return res;
02393 }

struct ast_data* ast_data_add_ptr ( struct ast_data root,
const char *  childname,
void *  ptr 
)

Add a ptr node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] ptr The pointer value to add.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02352 {
02353    return __ast_data_add(root, childname, AST_DATA_POINTER, ptr);
02354 }

struct ast_data* ast_data_add_seconds ( struct ast_data root,
const char *  childname,
unsigned int  seconds 
)

Add a seconds node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] seconds The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02364 {
02365    return __ast_data_add(root, childname, AST_DATA_SECONDS, &seconds);
02366 }

struct ast_data* ast_data_add_str ( struct ast_data root,
const char *  childname,
const char *  string 
)

Add a string node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] string The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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 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().

02397 {
02398    char *name;
02399    size_t namelen = 1 + (ast_strlen_zero(value) ? 0 : strlen(value));
02400    struct ast_data *res;
02401 
02402    if (!(name = ast_malloc(namelen))) {
02403       return NULL;
02404    }
02405 
02406    strcpy(name, (ast_strlen_zero(value) ? "" : value));
02407 
02408    res = __ast_data_add(root, childname, AST_DATA_STRING, name);
02409    if (!res) {
02410       ast_free(name);
02411    }
02412 
02413    return res;
02414 }

struct ast_data* ast_data_add_timestamp ( struct ast_data root,
const char *  childname,
unsigned int  timestamp 
)

Add a timestamp node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] timestamp The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02358 {
02359    return __ast_data_add(root, childname, AST_DATA_TIMESTAMP, &timestamp);
02360 }

struct ast_data* ast_data_add_uint ( struct ast_data root,
const char *  childname,
unsigned int  value 
)

Add an unsigned integer node type.

Parameters:
[in] root The root of the ast_data to insert into.
[in] childname The name of the child element to be added.
[in] value The value for the new node.
Return values:
NULL on error (memory exhaustion only).
non-NULL a 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().

02328 {
02329    return __ast_data_add(root, name, AST_DATA_UNSIGNED_INTEGER, &value);
02330 }

void ast_data_free ( struct ast_data root  ) 

Release the allocated memory of a tree.

Parameters:
[in] root The 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().

02486 {
02487    /* destroy it, this will destroy all the internal nodes. */
02488    ao2_ref(root, -1);
02489 }

struct ast_data* ast_data_get ( const struct ast_data_query query  ) 

Retrieve a subtree from the asterisk data API.

Parameters:
[in] query The query structure specifying what nodes to retrieve.
Return values:
NULL on error.
non-NULL The 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().

02061 {
02062    struct ast_data *res;
02063 
02064    /* check compatibility */
02065    if (!data_structure_compatible(query->version, latest_query_compatible_version,
02066       current_query_version)) {
02067       return NULL;
02068    }
02069 
02070    data_read_lock();
02071    res = data_result_generate(query, query->path);
02072    data_unlock();
02073 
02074    if (!res) {
02075       ast_log(LOG_ERROR, "Unable to get data from %s\n", query->path);
02076       return NULL;
02077    }
02078 
02079    return res;
02080 }

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..

Parameters:
[in] query The query structure specifying what nodes to retrieve.
Return values:
NULL on error.
non-NULL The 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.

02177 {
02178    struct ast_xml_doc *doc;
02179    struct ast_xml_node *root;
02180    struct ast_data *res;
02181 
02182    res = ast_data_get(query);
02183    if (!res) {
02184       return NULL;
02185    }
02186 
02187    doc = ast_xml_new();
02188    if (!doc) {
02189       return NULL;
02190    }
02191 
02192    root = ast_xml_new_node(res->name);
02193    if (!root) {
02194       ast_xml_close(doc);
02195    }
02196 
02197    ast_xml_set_root(doc, root);
02198 
02199    data_get_xml_add_child(res, root);
02200 
02201    ast_data_free(res);
02202 
02203    return doc;
02204 }

void ast_data_iterator_end ( struct ast_data_iterator iterator  ) 

Release (stop using) an iterator.

Parameters:
[in] iterator The 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.

02535 {
02536    /* decrement the reference counter. */
02537    if (iterator->last) {
02538       ao2_ref(iterator->last, -1);
02539    }
02540 
02541    /* release the generated pattern. */
02542    if (iterator->is_pattern) {
02543       regfree(&(iterator->regex_pattern));
02544    }
02545 
02546    ao2_iterator_destroy(&(iterator->internal_iterator));
02547 
02548    ast_free(iterator);
02549    iterator = NULL;
02550 }

struct ast_data_iterator* ast_data_iterator_init ( struct ast_data tree,
const char *  elements 
)

Initialize an iterator.

Parameters:
[in] tree The returned tree by a call to ast_data_get.
[in] elements Which elements to iterate through.
Return values:
NULL on error.
non-NULL A dinamically allocated iterator structure.

Definition at line 2491 of file data.c.

References ao2_iterator_init(), ast_calloc, ast_strdupa, ast_data::children, data_result_get_node(), and ast_data::ptr.

02493 {
02494    struct ast_data_iterator *iterator;
02495    struct ao2_iterator i;
02496    struct ast_data *internal = tree;
02497    char *path, *ptr = NULL;
02498 
02499    /* tree is the node we want to use to iterate? or we are going
02500     * to iterate thow an internal node? */
02501    if (elements) {
02502       path = ast_strdupa(elements);
02503 
02504       ptr = strrchr(path, '/');
02505       if (ptr) {
02506          *ptr = '\0';
02507          internal = data_result_get_node(tree, path);
02508          if (!internal) {
02509             return NULL;
02510          }
02511       }
02512    }
02513 
02514    iterator = ast_calloc(1, sizeof(*iterator));
02515    if (!iterator) {
02516       return NULL;
02517    }
02518 
02519    i = ao2_iterator_init(internal->children, 0);
02520 
02521    iterator->pattern = (ptr ? strrchr(elements, '/') + 1 : elements);
02522 
02523    /* is the last node a regular expression?, compile it! */
02524    if (!regcomp(&(iterator->regex_pattern), iterator->pattern,
02525          REG_EXTENDED | REG_NOSUB | REG_ICASE)) {
02526       iterator->is_pattern = 1;
02527    }
02528 
02529    iterator->internal_iterator = i;
02530 
02531    return iterator;
02532 }

struct ast_data* ast_data_iterator_next ( struct ast_data_iterator iterator  ) 

Get the next node of the tree.

Parameters:
[in] iterator The iterator structure returned by ast_data_iterator_start.
Return values:
NULL when no more nodes to return.
non-NULL A 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.

02553 {
02554    struct ast_data *res;
02555 
02556    if (iterator->last) {
02557       /* release the last retrieved node reference. */
02558       ao2_ref(iterator->last, -1);
02559    }
02560 
02561    while ((res = ao2_iterator_next(&iterator->internal_iterator))) {
02562       /* if there is no node name pattern specified, return
02563        * the next node. */
02564       if (!iterator->pattern) {
02565          break;
02566       }
02567 
02568       /* if the pattern is a regular expression, check if this node
02569        * matches. */
02570       if (iterator->is_pattern && !regexec(&(iterator->regex_pattern),
02571          res->name, 0, NULL, 0)) {
02572          break;
02573       }
02574 
02575       /* if there is a pattern specified, check if this node matches
02576        * the wanted node names. */
02577       if (!iterator->is_pattern && (iterator->pattern &&
02578             !strcasecmp(res->name, iterator->pattern))) {
02579          break;
02580       }
02581 
02582       ao2_ref(res, -1);
02583    }
02584 
02585    iterator->last = res;
02586 
02587    return res;
02588 }

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] root The root node of the node to be removed.
[in] child The 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().

02481 {
02482    ao2_unlink(root->children, child);
02483 }

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] tree The structure returned by a call to ast_data_get.
[in] path The path to the node.
[out] content The node content.
Return values:
0 on success.
<0 on 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_retrieve::type, ast_data::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().

02592 {
02593    struct ast_data *node;
02594 
02595    if (!content) {
02596       return -1;
02597    }
02598 
02599    node = data_result_get_node(tree, path);
02600    if (!node) {
02601       ast_log(LOG_ERROR, "Invalid internal node %s\n", path);
02602       return -1;
02603    }
02604 
02605    content->type = node->type;
02606    switch (node->type) {
02607    case AST_DATA_STRING:
02608       content->value.AST_DATA_STRING = node->payload.str;
02609       break;
02610    case AST_DATA_PASSWORD:
02611       content->value.AST_DATA_PASSWORD = node->payload.str;
02612       break;
02613    case AST_DATA_TIMESTAMP:
02614       content->value.AST_DATA_TIMESTAMP = node->payload.uint;
02615       break;
02616    case AST_DATA_SECONDS:
02617       content->value.AST_DATA_SECONDS = node->payload.uint;
02618       break;
02619    case AST_DATA_MILLISECONDS:
02620       content->value.AST_DATA_MILLISECONDS = node->payload.uint;
02621       break;
02622    case AST_DATA_CHARACTER:
02623       content->value.AST_DATA_CHARACTER = node->payload.character;
02624       break;
02625    case AST_DATA_INTEGER:
02626       content->value.AST_DATA_INTEGER = node->payload.sint;
02627       break;
02628    case AST_DATA_UNSIGNED_INTEGER:
02629       content->value.AST_DATA_UNSIGNED_INTEGER = node->payload.uint;
02630       break;
02631    case AST_DATA_BOOLEAN:
02632       content->value.AST_DATA_BOOLEAN = node->payload.boolean;
02633       break;
02634    case AST_DATA_IPADDR:
02635       content->value.AST_DATA_IPADDR = node->payload.ipaddr;
02636       break;
02637    case AST_DATA_DOUBLE:
02638       content->value.AST_DATA_DOUBLE = node->payload.dbl;
02639       break;
02640    case AST_DATA_CONTAINER:
02641       break;
02642    case AST_DATA_POINTER:
02643       content->value.AST_DATA_POINTER = node->payload.ptr;
02644       break;
02645    }
02646 
02647    return 0;
02648 }

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] tree The tree from where to get the value.
[in] path The 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.

00704 {
00705    struct ast_data_retrieve ret;
00706 
00707    ast_data_retrieve(tree, path, &ret);
00708 
00709    return ret.value.AST_DATA_BOOLEAN;
00710 }

static char ast_data_retrieve_char ( struct ast_data tree,
const char *  path 
) [inline, static]

Retrieve the character value of a node.

Parameters:
[in] tree The tree from where to get the value.
[in] path The 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.

00689 {
00690    struct ast_data_retrieve ret;
00691 
00692    ast_data_retrieve(tree, path, &ret);
00693 
00694    return ret.value.AST_DATA_CHARACTER;
00695 }

static double ast_data_retrieve_dbl ( struct ast_data tree,
const char *  path 
) [inline, static]

Retrieve the double value of a node.

Parameters:
[in] tree The tree from where to get the value.
[in] path The 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.

00779 {
00780    struct ast_data_retrieve ret;
00781 
00782    ast_data_retrieve(tree, path, &ret);
00783 
00784    return ret.value.AST_DATA_DOUBLE;
00785 }

static int ast_data_retrieve_int ( struct ast_data tree,
const char *  path 
) [inline, static]

Retrieve the integer value of a node.

Parameters:
[in] tree The tree from where to get the value.
[in] path The 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.

00674 {
00675    struct ast_data_retrieve ret;
00676 
00677    ast_data_retrieve(tree, path, &ret);
00678 
00679    return ret.value.AST_DATA_INTEGER;
00680 }

static struct in_addr ast_data_retrieve_ipaddr ( struct ast_data tree,
const char *  path 
) [inline, static]

Retrieve the ipv4 address value of a node.

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

Definition at line 793 of file data.h.

References ast_data_retrieve().

00794 {
00795    struct ast_data_retrieve ret;
00796 
00797    ast_data_retrieve(tree, path, &ret);
00798 
00799    return ret.value.AST_DATA_IPADDR;
00800 }

char* ast_data_retrieve_name ( struct ast_data node  ) 

Get the node name.

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

Definition at line 2219 of file data.c.

References ast_data::name.

02220 {
02221    return node->name;
02222 }

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] tree The tree from where to get the value.
[in] path The 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.

00734 {
00735    struct ast_data_retrieve ret;
00736 
00737    ast_data_retrieve(tree, path, &ret);
00738 
00739    return ret.value.AST_DATA_PASSWORD;
00740 }

static void* ast_data_retrieve_ptr ( struct ast_data tree,
const char *  path 
) [inline, static]

Retrieve the ptr value of a node.

Parameters:
[in] tree The tree from where to get the value.
[in] path The 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.

00764 {
00765    struct ast_data_retrieve ret;
00766 
00767    ast_data_retrieve(tree, path, &ret);
00768 
00769    return ret.value.AST_DATA_POINTER;
00770 }

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] tree The tree from where to get the value.
[in] path The 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.

00749 {
00750    struct ast_data_retrieve ret;
00751 
00752    ast_data_retrieve(tree, path, &ret);
00753 
00754    return ret.value.AST_DATA_STRING;
00755 }

enum ast_data_type ast_data_retrieve_type ( struct ast_data res,
const char *  path 
)

Get a node type.

Parameters:
[in] res A pointer to the ast_data result set.
[in] path A 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(), and ast_data::type.

02208 {
02209    struct ast_data *internal;
02210 
02211    internal = data_result_get_node(node, path);
02212    if (!internal) {
02213       return -1;
02214    }
02215 
02216    return internal->type;
02217 }

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] tree The tree from where to get the value.
[in] path The 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.

00719 {
00720    struct ast_data_retrieve ret;
00721 
00722    ast_data_retrieve(tree, path, &ret);
00723 
00724    return ret.value.AST_DATA_UNSIGNED_INTEGER;
00725 }

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] search The search condition.
[in] data The 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_search::children, ast_data::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().

01454 {
01455    struct ao2_iterator i, ii;
01456    struct ast_data_search *s, *s_child;
01457    struct ast_data *d_child;
01458    int notmatch = 1;
01459 
01460    if (!search) {
01461       return 1;
01462    }
01463 
01464    s_child = data_search_find(search->children, data->name);
01465    if (!s_child) {
01466       /* nothing to compare */
01467       ao2_ref(s_child, -1);
01468       return 1;
01469    }
01470 
01471    i = ao2_iterator_init(s_child->children, 0);
01472    while ((s = ao2_iterator_next(&i))) {
01473       if (!ao2_container_count(s->children)) {
01474          /* compare this search node with every data node */
01475          d_child = data_result_find_child(data, s->name);
01476          if (!d_child) {
01477             ao2_ref(s, -1);
01478             notmatch = 1;
01479             continue;
01480          }
01481 
01482          switch (d_child->type) {
01483          case AST_DATA_PASSWORD:
01484          case AST_DATA_STRING:
01485             notmatch = data_search_cmp_string(s_child, d_child->name,
01486                d_child->payload.str);
01487             break;
01488          case AST_DATA_CHARACTER:
01489             notmatch = data_search_cmp_char(s_child, d_child->name,
01490                d_child->payload.character);
01491             break;
01492          case AST_DATA_INTEGER:
01493             notmatch = data_search_cmp_int(s_child, d_child->name,
01494                d_child->payload.sint);
01495             break;
01496          case AST_DATA_BOOLEAN:
01497             notmatch = data_search_cmp_bool(s_child, d_child->name,
01498                d_child->payload.boolean);
01499             break;
01500          case AST_DATA_UNSIGNED_INTEGER:
01501             notmatch = data_search_cmp_uint(s_child, d_child->name,
01502                d_child->payload.uint);
01503             break;
01504          case AST_DATA_TIMESTAMP:
01505          case AST_DATA_SECONDS:
01506          case AST_DATA_MILLISECONDS:
01507          case AST_DATA_DOUBLE:
01508             notmatch = data_search_cmp_uint(s_child, d_child->name,
01509                d_child->payload.dbl);
01510             break;
01511          case AST_DATA_IPADDR:
01512             notmatch = data_search_cmp_ipaddr(s_child, d_child->name,
01513                d_child->payload.ipaddr);
01514             break;
01515          case AST_DATA_POINTER:
01516             notmatch = data_search_cmp_ptr(s_child, d_child->name,
01517                d_child->payload.ptr);
01518             break;
01519          case AST_DATA_CONTAINER:
01520             break;
01521          }
01522          ao2_ref(d_child, -1);
01523       } else {
01524          ii = ao2_iterator_init(data->children, 0);
01525          while ((d_child = ao2_iterator_next(&ii))) {
01526             if (strcmp(d_child->name, s->name)) {
01527                ao2_ref(d_child, -1);
01528                continue;
01529             }
01530             if (!(notmatch = !ast_data_search_match(s_child, d_child))) {
01531                /* do not continue if we have a match. */
01532                ao2_ref(d_child, -1);
01533                break;
01534             }
01535             ao2_ref(d_child, -1);
01536          }
01537          ao2_iterator_destroy(&ii);
01538       }
01539       ao2_ref(s, -1);
01540       if (notmatch) {
01541          /* do not continue if we don't have a match. */
01542          break;
01543       }
01544    }
01545    ao2_iterator_destroy(&i);
01546 
01547    ao2_ref(s_child, -1);
01548 
01549    return !notmatch;
01550 }


Generated on Mon Jun 27 16:51:13 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7