A lot of doxygen updates
[asterisk/asterisk.git] / include / asterisk / astdb.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Persistant data storage (akin to *doze registry)
21  */
22
23 #ifndef _ASTERISK_ASTDB_H
24 #define _ASTERISK_ASTDB_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 struct ast_db_entry {
31         struct ast_db_entry *next;
32         char *key;
33         char data[0];
34 };
35
36 /*! \brief Get key value specified by family/key */
37 int ast_db_get(const char *family, const char *key, char *out, int outlen);
38
39 /*! \brief Store value addressed by family/key*/
40 int ast_db_put(const char *family, const char *key, const char *value);
41
42 /*! \brief Delete entry in astdb */
43 int ast_db_del(const char *family, const char *key);
44
45 /*! \brief Delete a whole family (for some reason also called "tree" */
46 int ast_db_deltree(const char *family, const char *keytree);
47
48 /*! \brief Get a whole family */
49 struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree);
50
51 /*! \brief Free in-memory data */
52 void ast_db_freetree(struct ast_db_entry *entry);
53
54 #if defined(__cplusplus) || defined(c_plusplus)
55 }
56 #endif
57
58 #endif /* _ASTERISK_ASTDB_H */