diff options
author | tilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-06-13 22:52:20 +0000 |
---|---|---|
committer | tilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-06-13 22:52:20 +0000 |
commit | 3fe169d130010e34cfd4b76ec210aa271b97cad3 (patch) | |
tree | a7bae0783871656cb6fed330ef83b97f40f875ad | |
parent | 7f93a2e6d827924b1ecae81f33ef2b5acd4ab9b3 (diff) |
Document the input for ast_realtime_require_field()
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@122766 f38db490-d61c-443f-a65b-d21fe96a405b
-rw-r--r-- | include/asterisk/config.h | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/include/asterisk/config.h b/include/asterisk/config.h index fdcd28a40..b6c5dbd14 100644 --- a/include/asterisk/config.h +++ b/include/asterisk/config.h @@ -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); |