ast_sorcery_wizard Struct Reference

Interface for a sorcery wizard. More...

#include <sorcery.h>

Collaboration diagram for ast_sorcery_wizard:

Collaboration graph
[legend]

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(* 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_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.


Field Documentation

void(* close)(void *data)

Callback for closing a wizard.

Referenced by sorcery_object_wizard_destructor().

int(* create)(const struct ast_sorcery *sorcery, void *data, void *object)

int(* delete)(const struct ast_sorcery *sorcery, void *data, void *object)

void(* load)(void *data, const struct ast_sorcery *sorcery, const char *type)

Optional callback for loading persistent objects.

Referenced by sorcery_wizard_load().

struct ast_module* module [read]

Pointer to the Asterisk module this wizard is implemented by.

Definition at line 281 of file sorcery.h.

Referenced by __ast_sorcery_wizard_register(), and sorcery_object_wizard_destructor().

const char* name

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.

Referenced by sorcery_wizard_load().

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.

Referenced by ast_sorcery_retrieve_by_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.

Referenced by __ast_bucket_scheme_register(), ast_sorcery_retrieve_by_id(), handle_auth(), handle_identify(), and handle_phoneprov().

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.

Referenced by ast_sorcery_retrieve_by_fields(), handle_registrations(), and object_type_loaded_observer().

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.

Referenced by ast_sorcery_retrieve_by_regex().

int(* update)(const struct ast_sorcery *sorcery, void *data, void *object)


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

Generated on Thu Apr 16 06:35:40 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6