kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-09 14:36:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document the input for ast_realtime_require_field()

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@122766 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Tilghman Lesher
2008-06-13 22:52:20 +00:00
parent 4d322f7bd3
commit 043a15afa7
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/asterisk/config.h
View File

@@ -227,8 +227,22 @@ int ast_unload_realtime(const char *family);
* exist in the backend. The backends may take various actions, such as
* creating new fields in the data store or warning the administrator that
* new fields may need to be created, in order to ensure proper function.
*
* The arguments are specified in groups of 3: column name, column type,
* and column size. The column types are specified as integer constants,
* defined by the enum require_type. Note that the size is specified as
* the number of equivalent character fields that a field may take up, even
* if a field is otherwise specified as an integer type. This is due to
* the fact that some fields have historically been specified as character
* types, even if they contained integer values.
*
* A family should always specify its fields to the minimum necessary
* requirements to fulfill all possible values (within reason; for example,
* a timeout value may reasonably be specified as an INTEGER2, with size 5.
* Even though values above 32767 seconds are possible, they are unlikely
* to be useful, and we should not complain about that size).
*/
int ast_require_realtime_fields(const char *family, ...) attribute_sentinel;
int ast_realtime_require_field(const char *family, ...) attribute_sentinel;
/*!
* \brief Retrieve realtime configuration
@@ -277,8 +291,6 @@ int ast_destroy_realtime(const char *family, const char *keyfield, const char *l
*/
int ast_check_realtime(const char *family);
int ast_realtime_require_field(const char *family, ...) attribute_sentinel;
/*! \brief Check if there's any realtime engines loaded */
int ast_realtime_enabled(void);