diff options
| author | Joshua Colp <jcolp@digium.com> | 2017-11-16 10:59:23 -0600 |
|---|---|---|
| committer | Gerrit Code Review <gerrit2@gerrit.digium.api> | 2017-11-16 10:59:23 -0600 |
| commit | 8d55b132b94c830f3dae18e4c5519e5ce5af9a33 (patch) | |
| tree | 27d318e39b293f5ca8c23ccf6122d79ce93d976e /include | |
| parent | 9fb2da7963f9e02f8502db104c0e2dc0ddfc870a (diff) | |
| parent | cf062303e35e4baa0dc2aa3dfb68b2c25b1ed2c2 (diff) | |
Merge "sorcery: Add ast_sorcery_retrieve_by_prefix()" into 13
Diffstat (limited to 'include')
| -rw-r--r-- | include/asterisk/sorcery.h | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/include/asterisk/sorcery.h b/include/asterisk/sorcery.h index 0cb434766..73ed06078 100644 --- a/include/asterisk/sorcery.h +++ b/include/asterisk/sorcery.h @@ -312,6 +312,14 @@ struct ast_sorcery_wizard { /*! \brief Callback for closing a wizard */ void (*close)(void *data); + + /*! \brief Optional callback for retrieving multiple objects by matching their id with a prefix */ + void (*retrieve_prefix)(const struct ast_sorcery *sorcery, + void *data, + const char *type, + struct ao2_container *objects, + const char *prefix, + const size_t prefix_len); }; /*! \brief Interface for a sorcery object type observer */ @@ -364,9 +372,20 @@ int ast_sorcery_init(void); int __ast_sorcery_wizard_register(const struct ast_sorcery_wizard *interface, struct ast_module *module); /*! + * \brief Register a sorcery wizard + * + * \param interface Pointer to a wizard interface + * \param module Pointer to the module implementing the interface + * + * \retval 0 success + * \retval -1 failure + */ +int __ast_sorcery_wizard_register_with_prefix(const struct ast_sorcery_wizard *interface, struct ast_module *module); + +/*! * \brief See \ref __ast_sorcery_wizard_register() */ -#define ast_sorcery_wizard_register(interface) __ast_sorcery_wizard_register(interface, ast_module_info ? ast_module_info->self : NULL) +#define ast_sorcery_wizard_register(interface) __ast_sorcery_wizard_register_with_prefix(interface, ast_module_info ? ast_module_info->self : NULL) /*! * \brief Unregister a sorcery wizard @@ -1218,6 +1237,22 @@ void *ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const ch struct ao2_container *ast_sorcery_retrieve_by_regex(const struct ast_sorcery *sorcery, const char *type, const char *regex); /*! + * \brief Retrieve multiple objects whose id begins with the specified prefix + * \since 13.19.0 + * + * \param sorcery Pointer to a sorcery structure + * \param type Type of object to retrieve + * \param prefix Object id prefix + * \param prefix_len The length of prefix in bytes + * + * \retval non-NULL if error occurs + * \retval NULL success + * + * \note The prefix is matched in a case sensitive manner. + */ +struct ao2_container *ast_sorcery_retrieve_by_prefix(const struct ast_sorcery *sorcery, const char *type, const char *prefix, const size_t prefix_len); + +/*! * \brief Update an object * * \param sorcery Pointer to a sorcery structure |