mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-05 04:11:08 +00:00
350ffcb02b
Currently, if using the CLI to delete a DB entry, "Database entry removed" is always returned, regardless of whether or not the entry actually existed in the first place. This meant that users were never told if entries did not exist. The same issue occurs if trying to delete a DB key using AMI. To address this, new API is added that is more stringent in deleting values from AstDB, which will not return success if the value did not exist in the first place, and will print out specific error details if available. ASTERISK-30001 #close Change-Id: Ic84e3eddcd66c7a6ed7fea91cdfd402568378b18
115 lines
3.4 KiB
C
115 lines
3.4 KiB
C
/*
|
|
* 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 Persistent 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 Same as ast_db_del, but with more stringent error checking
|
|
*
|
|
* \details
|
|
* Unlike ast_db_del, if the key does not exist in the first place,
|
|
* an error is emitted and -1 is returned.
|
|
*
|
|
* \retval -1 An error occured (including key not found to begin with)
|
|
* \retval 0 Successfully deleted
|
|
*/
|
|
int ast_db_del2(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 */
|