1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2005, Digium, Inc.
*
* Mark Spencer <markster@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*!
* \file
* \brief Persistant data storage (akin to *doze registry)
*/
#ifndef _ASTERISK_ASTDB_H
#define _ASTERISK_ASTDB_H
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
struct ast_db_entry {
struct ast_db_entry *next;
char *key;
char data[0];
};
/*! \brief Get key value specified by family/key */
int ast_db_get(const char *family, const char *key, char *value, int valuelen);
/*!
* \brief Get key value specified by family/key as a heap allocated string.
*
* \details
* Given a \a family and \a key, sets \a out to a pointer to a heap
* allocated string. In the event of an error, \a out will be set to
* NULL. The string must be freed by calling ast_free().
*
* \retval -1 An error occurred
* \retval 0 Success
*/
int ast_db_get_allocated(const char *family, const char *key, char **out);
/*! \brief Store value addressed by family/key */
int ast_db_put(const char *family, const char *key, const char *value);
/*! \brief Delete entry in astdb */
int ast_db_del(const char *family, const char *key);
/*!
* \brief Delete one or more entries in astdb
*
* \details
* If both parameters are NULL, the entire database will be purged. If
* only keytree is NULL, all entries within the family will be purged.
* It is an error for keytree to have a value when family is NULL.
*
* \retval -1 An error occurred
* \retval >= 0 Number of records deleted
*/
int ast_db_deltree(const char *family, const char *keytree);
/*!
* \brief Get a list of values within the astdb tree
*
* \details
* If family is specified, only those keys will be returned. If keytree
* is specified, subkeys are expected to exist (separated from the key with
* a slash). If subkeys do not exist and keytree is specified, the tree will
* consist of either a single entry or NULL will be returned.
*
* Resulting tree should be freed by passing the return value to ast_db_freetree()
* when usage is concluded.
*/
struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree);
/*!
* \brief Get a list of values with the given key prefix
*
* \param family The family to search under
* \param key_prefix The key prefix to search under
*
* \retval NULL An error occurred
*/
struct ast_db_entry *ast_db_gettree_by_prefix(const char *family, const char *key_prefix);
/*! \brief Free structure created by ast_db_gettree() */
void ast_db_freetree(struct ast_db_entry *entry);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif /* _ASTERISK_ASTDB_H */
|
