Asterisk - The Open Source Telephony Project  21.4.1
Data Fields
ast_sorcery_wizard Struct Reference

Interface for a sorcery wizard. More...

#include <sorcery.h>

Data Fields

void(* close )(void *data)
 Callback for closing a wizard.
 
int(* create )(const struct ast_sorcery *sorcery, void *data, void *object)
 Callback for creating an object.
 
int(* delete )(const struct ast_sorcery *sorcery, void *data, void *object)
 Callback for deleting an object.
 
void(* force_reload )(void *data, const struct ast_sorcery *sorcery, const char *type)
 Optional callback for forcing a reload to occur, even if wizard has determined no changes.
 
int(* is_stale )(const struct ast_sorcery *sorcery, void *data, void *object)
 Callback for whether or not the wizard believes the object is stale.
 
void(* load )(void *data, const struct ast_sorcery *sorcery, const char *type)
 Optional callback for loading persistent objects.
 
struct ast_modulemodule
 Pointer to the Asterisk module this wizard is implemented by.
 
const char * name
 Name of the wizard.
 
void *(* open )(const char *data)
 Callback for opening a wizard.
 
void(* reload )(void *data, const struct ast_sorcery *sorcery, const char *type)
 Optional callback for reloading persistent objects.
 
void *(* retrieve_fields )(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields)
 Optional callback for retrieving an object using fields.
 
void *(* retrieve_id )(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id)
 Callback for retrieving an object using an id.
 
void(* retrieve_multiple )(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const struct ast_variable *fields)
 Optional callback for retrieving multiple objects using some optional field criteria.
 
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)
 Optional callback for retrieving multiple objects by matching their id with a prefix.
 
void(* retrieve_regex )(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex)
 Callback for retrieving multiple objects using a regex on their id.
 
int(* update )(const struct ast_sorcery *sorcery, void *data, void *object)
 Callback for updating an object.
 

Detailed Description

Interface for a sorcery wizard.

Definition at line 276 of file sorcery.h.


The documentation for this struct was generated from the following file: