Asterisk - The Open Source Telephony Project
21.4.1
|
Core PBX routines and definitions. More...
#include "asterisk/channel.h"
#include "asterisk/sched.h"
#include "asterisk/devicestate.h"
#include "asterisk/presencestate.h"
#include "asterisk/chanvars.h"
#include "asterisk/hashtab.h"
#include "asterisk/stringfields.h"
#include "asterisk/xmldoc.h"
#include "asterisk/format.h"
Go to the source code of this file.
Data Structures | |
struct | ast_custom_function |
Data structure associated with a custom dialplan function. More... | |
struct | ast_device_state_info |
struct | ast_pbx |
struct | ast_pbx_args |
Options for ast_pbx_run() More... | |
struct | ast_state_cb_info |
struct | ast_switch |
struct | ast_timing |
struct | pbx_find_info |
Macros | |
#define | ast_custom_function_register(acf) __ast_custom_function_register(acf, AST_MODULE_SELF) |
Register a custom function. | |
#define | ast_custom_function_register_escalating(acf, escalation) __ast_custom_function_register_escalating(acf, escalation, AST_MODULE_SELF) |
Register a custom function which requires escalated privileges. More... | |
#define | AST_MAX_APP 32 |
#define | AST_PBX_GOTO_FAILED -3 |
#define | AST_PBX_KEEP 0 |
#define | AST_PBX_MAX_STACK 512 |
#define | AST_PBX_REPLACE 1 |
#define | PRIORITY_HINT -1 |
#define | STATUS_NO_CONTEXT 1 |
#define | STATUS_NO_EXTENSION 2 |
#define | STATUS_NO_LABEL 4 |
#define | STATUS_NO_PRIORITY 3 |
#define | STATUS_SUCCESS 5 |
#define | AST_PBX_HANGUP -1 |
Special return values from applications to the PBX. More... | |
#define | AST_PBX_OK 0 |
#define | AST_PBX_ERROR 1 |
#define | AST_PBX_INCOMPLETE 12 |
Typedefs | |
typedef void(* | ast_state_cb_destroy_type) (int id, void *data) |
Typedef for devicestate and hint callback removal indication callback. | |
typedef int(* | ast_state_cb_type) (const char *context, const char *exten, struct ast_state_cb_info *info, void *data) |
Typedef for devicestate and hint callbacks. | |
typedef int( | ast_switch_f) (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data) |
All switch functions have the same interface, so define a type for them. More... | |
Enumerations | |
enum | ast_custom_function_escalation { AST_CFE_NONE, AST_CFE_READ, AST_CFE_WRITE, AST_CFE_BOTH } |
Description of the ways in which a function may escalate privileges. | |
enum | ast_ext_matchcid_types { AST_EXT_MATCHCID_OFF = 0, AST_EXT_MATCHCID_ON = 1, AST_EXT_MATCHCID_ANY = 2 } |
extension matchcid types More... | |
enum | ast_extension_states { AST_EXTENSION_REMOVED = -2, AST_EXTENSION_DEACTIVATED = -1, AST_EXTENSION_NOT_INUSE = 0, AST_EXTENSION_INUSE = 1 << 0, AST_EXTENSION_BUSY = 1 << 1, AST_EXTENSION_UNAVAILABLE = 1 << 2, AST_EXTENSION_RINGING = 1 << 3, AST_EXTENSION_ONHOLD = 1 << 4, AST_EXTENSION_REMOVED = -2, AST_EXTENSION_DEACTIVATED = -1, AST_EXTENSION_NOT_INUSE = 0, AST_EXTENSION_INUSE = 1 << 0, AST_EXTENSION_BUSY = 1 << 1, AST_EXTENSION_UNAVAILABLE = 1 << 2, AST_EXTENSION_RINGING = 1 << 3, AST_EXTENSION_ONHOLD = 1 << 4 } |
Extension states. More... | |
enum | ast_pbx_outgoing_sync { AST_OUTGOING_NO_WAIT = 0, AST_OUTGOING_WAIT = 1, AST_OUTGOING_WAIT_COMPLETE = 2 } |
enum | ast_pbx_result { AST_PBX_SUCCESS = 0, AST_PBX_FAILED = -1, AST_PBX_CALL_LIMIT = -2 } |
The result codes when starting the PBX on a channel with ast_pbx_start. More... | |
enum | ast_state_cb_update_reason { AST_HINT_UPDATE_DEVICE = 1, AST_HINT_UPDATE_PRESENCE = 2 } |
enum | ext_match_t { E_MATCHMORE = 0x00, E_CANMATCH = 0x01, E_MATCH = 0x02, E_MATCH_MASK = 0x03, E_SPAWN = 0x12, E_FINDLABEL = 0x22, E_MATCHMORE = 0x00, E_CANMATCH = 0x01, E_MATCH = 0x02, E_MATCH_MASK = 0x03, E_SPAWN = 0x12, E_FINDLABEL = 0x22 } |
Functions | |
int | __ast_custom_function_register (struct ast_custom_function *acf, struct ast_module *mod) |
Register a custom function. | |
int | __ast_custom_function_register_escalating (struct ast_custom_function *acf, enum ast_custom_function_escalation escalation, struct ast_module *mod) |
Register a custom function which requires escalated privileges. More... | |
int | ast_active_calls (void) |
Retrieve the number of active calls. | |
int | ast_add_extension (const char *context, int replace, const char *extension, int priority, const char *label, const char *callerid, const char *application, void *data, void(*datad)(void *), const char *registrar) |
Add and extension to an extension context. More... | |
int | ast_add_extension2 (struct ast_context *con, int replace, const char *extension, int priority, const char *label, const char *callerid, const char *application, void *data, void(*datad)(void *), const char *registrar, const char *registrar_file, int registrar_line) |
Add an extension to an extension context, this time with an ast_context *. More... | |
int | ast_add_extension2_nolock (struct ast_context *con, int replace, const char *extension, int priority, const char *label, const char *callerid, const char *application, void *data, void(*datad)(void *), const char *registrar, const char *registrar_file, int registrar_line) |
Same as ast_add_extension2, but assumes you have already locked context. More... | |
int | ast_async_goto (struct ast_channel *chan, const char *context, const char *exten, int priority) |
Set the channel to next execute the specified dialplan location. More... | |
int | ast_async_goto_by_name (const char *chan, const char *context, const char *exten, int priority) |
Set the channel to next execute the specified dialplan location. | |
int | ast_async_goto_if_exists (struct ast_channel *chan, const char *context, const char *exten, int priority) |
int | ast_async_parseable_goto (struct ast_channel *chan, const char *goto_string) |
int | ast_build_timing (struct ast_timing *i, const char *info_in) |
Construct a timing bitmap, for use in time-based conditionals. More... | |
int | ast_canmatch_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid) |
Looks for a valid matching extension. More... | |
int | ast_check_timing (const struct ast_timing *i) |
Evaluate a pre-constructed bitmap as to whether the current time falls within the range specified. More... | |
int | ast_check_timing2 (const struct ast_timing *i, const struct timeval tv) |
Evaluate a pre-constructed bitmap as to whether a particular time falls within the range specified. More... | |
char * | ast_complete_applications (const char *line, const char *word, int state) |
Command completion for the list of installed applications. More... | |
int | ast_context_add_ignorepat (const char *context, const char *ignorepat, const char *registrar) |
Add an ignorepat. More... | |
int | ast_context_add_ignorepat2 (struct ast_context *con, const char *ignorepat, const char *registrar) |
int | ast_context_add_include (const char *context, const char *include, const char *registrar) |
Add a context include. More... | |
int | ast_context_add_include2 (struct ast_context *con, const char *value, const char *registrar) |
Add a context include. More... | |
int | ast_context_add_switch (const char *context, const char *sw, const char *data, int eval, const char *registrar) |
Add a switch. More... | |
int | ast_context_add_switch2 (struct ast_context *con, const char *sw, const char *data, int eval, const char *registrar) |
Adds a switch (first param is a ast_context) More... | |
void | ast_context_destroy (struct ast_context *con, const char *registrar) |
Destroy a context (matches the specified context or ANY context if NULL) More... | |
int | ast_context_destroy_by_name (const char *context, const char *registrar) |
Destroy a context by name. More... | |
struct ast_context * | ast_context_find (const char *name) |
Find a context. More... | |
struct ast_context * | ast_context_find_or_create (struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *name, const char *registrar) |
Register a new context or find an existing one. More... | |
int | ast_context_remove_ignorepat (const char *context, const char *ignorepat, const char *registrar) |
Remove an ignorepat. More... | |
int | ast_context_remove_ignorepat2 (struct ast_context *con, const char *ignorepat, const char *registrar) |
int | ast_context_remove_include (const char *context, const char *include, const char *registrar) |
Remove a context include. More... | |
int | ast_context_remove_include2 (struct ast_context *con, const char *include, const char *registrar) |
Removes an include by an ast_context structure. More... | |
int | ast_context_remove_switch (const char *context, const char *sw, const char *data, const char *registrar) |
Remove a switch. More... | |
int | ast_context_remove_switch2 (struct ast_context *con, const char *sw, const char *data, const char *registrar) |
This function locks given context, removes switch, unlock context and return. More... | |
void | ast_context_set_autohints (struct ast_context *con, int enabled) |
Enable or disable autohints support on a context. More... | |
int | ast_context_verify_includes (struct ast_context *con) |
Verifies includes in an ast_contect structure. More... | |
struct ast_custom_function * | ast_custom_function_find (const char *name) |
int | ast_custom_function_unregister (struct ast_custom_function *acf) |
Unregister a custom function. | |
int | ast_destroy_timing (struct ast_timing *i) |
Deallocates memory structures associated with a timing bitmap. More... | |
enum ast_extension_states | ast_devstate_to_extenstate (enum ast_device_state devstate) |
Map devstate to an extension state. More... | |
int | ast_exists_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid) |
Determine whether an extension exists. More... | |
int | ast_explicit_goto (struct ast_channel *chan, const char *context, const char *exten, int priority) |
int | ast_extension_close (const char *pattern, const char *data, int needmore) |
int | ast_extension_cmp (const char *a, const char *b) |
Determine if one extension should match before another. More... | |
int | ast_extension_match (const char *pattern, const char *extension) |
Determine if a given extension matches a given pattern (in NXX format) More... | |
int | ast_extension_patmatch (const char *pattern, const char *data) |
int | ast_extension_state (struct ast_channel *c, const char *context, const char *exten) |
Uses hint and devicestate callback to get the state of an extension. More... | |
const char * | ast_extension_state2str (int extension_state) |
Return string representation of the state of an extension. More... | |
int | ast_extension_state_add (const char *context, const char *exten, ast_state_cb_type change_cb, void *data) |
Add watcher for extension states. More... | |
int | ast_extension_state_add_destroy (const char *context, const char *exten, ast_state_cb_type change_cb, ast_state_cb_destroy_type destroy_cb, void *data) |
Add watcher for extension states with destructor. More... | |
int | ast_extension_state_add_destroy_extended (const char *context, const char *exten, ast_state_cb_type change_cb, ast_state_cb_destroy_type destroy_cb, void *data) |
Add watcher for extended extension states with destructor. More... | |
int | ast_extension_state_add_extended (const char *context, const char *exten, ast_state_cb_type change_cb, void *data) |
Add watcher for extended extension states. More... | |
int | ast_extension_state_del (int id, ast_state_cb_type change_cb) |
Deletes a state change watcher by ID. More... | |
int | ast_extension_state_extended (struct ast_channel *c, const char *context, const char *exten, struct ao2_container **device_state_info) |
Uses hint and devicestate callback to get the extended state of an extension. More... | |
int | ast_findlabel_extension (struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid) |
Find the priority of an extension that has the specified label. More... | |
int | ast_findlabel_extension2 (struct ast_channel *c, struct ast_context *con, const char *exten, const char *label, const char *callerid) |
Find the priority of an extension that has the specified label. More... | |
int | ast_func_read (struct ast_channel *chan, const char *function, char *workspace, size_t len) |
executes a read operation on a function More... | |
int | ast_func_read2 (struct ast_channel *chan, const char *function, struct ast_str **str, ssize_t maxlen) |
executes a read operation on a function More... | |
int | ast_func_write (struct ast_channel *chan, const char *function, const char *value) |
executes a write operation on a function More... | |
const char * | ast_get_extension_registrar_file (struct ast_exten *e) |
Get name of configuration file used by registrar to register this extension. More... | |
int | ast_get_extension_registrar_line (struct ast_exten *e) |
Get line number of configuration file used by registrar to register this extension. More... | |
int | ast_get_hint (char *hint, int hintsize, char *name, int namesize, struct ast_channel *c, const char *context, const char *exten) |
If an extension hint exists, return non-zero. More... | |
int | ast_goto_if_exists (struct ast_channel *chan, const char *context, const char *exten, int priority) |
int | ast_hint_presence_state (struct ast_channel *c, const char *context, const char *exten, char **subtype, char **message) |
Uses hint and presence state callback to get the presence state of an extension. More... | |
int | ast_ignore_pattern (const char *context, const char *pattern) |
Checks to see if a number should be ignored. More... | |
int | ast_matchmore_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid) |
Looks to see if adding anything to this extension might match something. (exists ^ canmatch) More... | |
void | ast_merge_contexts_and_delete (struct ast_context **extcontexts, struct ast_hashtab *exttable, const char *registrar) |
Merge the temporary contexts into a global contexts list and delete from the global list the ones that are being added. More... | |
int | ast_parseable_goto (struct ast_channel *chan, const char *goto_string) |
int | ast_pbx_exec_application (struct ast_channel *chan, const char *app_name, const char *app_args) |
Execute an application. More... | |
void | ast_pbx_h_exten_run (struct ast_channel *chan, const char *context) |
Run the h exten from the given context. More... | |
void | ast_pbx_hangup_handler_destroy (struct ast_channel *chan) |
Destroy the hangup handler container on a channel. More... | |
void | ast_pbx_hangup_handler_init (struct ast_channel *chan) |
Init the hangup handler container on a channel. More... | |
int | ast_pbx_hangup_handler_pop (struct ast_channel *chan) |
Pop the top of the channel hangup handler stack. More... | |
void | ast_pbx_hangup_handler_push (struct ast_channel *chan, const char *handler) |
Push the given hangup handler onto the channel hangup handler stack. More... | |
int | ast_pbx_hangup_handler_run (struct ast_channel *chan) |
Run all hangup handlers on the channel. More... | |
int | ast_pbx_outgoing_app (const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *app, const char *appdata, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, const struct ast_assigned_ids *assignedids) |
Synchronously or asynchronously make an outbound call and execute an application on the channel. More... | |
int | ast_pbx_outgoing_app_predial (const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *app, const char *appdata, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, const struct ast_assigned_ids *assignedids, const char *predial_callee) |
int | ast_pbx_outgoing_exten (const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *context, const char *exten, int priority, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, int early_media, const struct ast_assigned_ids *assignedids) |
Synchronously or asynchronously make an outbound call and send it to a particular extension. More... | |
int | ast_pbx_outgoing_exten_predial (const char *type, struct ast_format_cap *cap, const char *addr, int timeout, const char *context, const char *exten, int priority, int *reason, int synchronous, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel, int early_media, const struct ast_assigned_ids *assignedids, const char *predial_callee) |
enum ast_pbx_result | ast_pbx_run (struct ast_channel *c) |
Execute the PBX in the current thread. More... | |
enum ast_pbx_result | ast_pbx_run_args (struct ast_channel *c, struct ast_pbx_args *args) |
Execute the PBX in the current thread. More... | |
enum ast_pbx_result | ast_pbx_start (struct ast_channel *c) |
Create a new thread and start the PBX. More... | |
int | ast_processed_calls (void) |
Retrieve the total number of calls processed through the PBX since last restart. | |
int | ast_rdlock_context (struct ast_context *con) |
Read locks a given context. More... | |
int | ast_rdlock_contexts (void) |
Read locks the context list. More... | |
int | ast_register_switch (struct ast_switch *sw) |
Register an alternative dialplan switch. More... | |
int | ast_spawn_extension (struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid, int *found, int combined_find_spawn) |
Launch a new extension (i.e. new stack) More... | |
int | ast_str_get_hint (struct ast_str **hint, ssize_t hintsize, struct ast_str **name, ssize_t namesize, struct ast_channel *c, const char *context, const char *exten) |
If an extension hint exists, return non-zero. More... | |
int | ast_thread_inhibit_escalations (void) |
Inhibit (in the current thread) the execution of dialplan functions which cause privilege escalations. If pbx_live_dangerously() has been called, this function has no effect. More... | |
int | ast_thread_inhibit_escalations_swap (int inhibit) |
Swap the current thread escalation inhibit setting. More... | |
int | ast_unlock_context (struct ast_context *con) |
int | ast_unlock_contexts (void) |
Unlocks contexts. More... | |
void | ast_unregister_switch (struct ast_switch *sw) |
Unregister an alternative switch. More... | |
int | ast_wrlock_context (struct ast_context *con) |
Write locks a given context. More... | |
int | ast_wrlock_contexts (void) |
Write locks the context list. More... | |
void | pbx_builtin_clear_globals (void) |
const char * | pbx_builtin_getvar_helper (struct ast_channel *chan, const char *name) |
Return a pointer to the value of the corresponding channel variable. More... | |
void | pbx_builtin_pushvar_helper (struct ast_channel *chan, const char *name, const char *value) |
Add a variable to the channel variable stack, without removing any previously set value. More... | |
int | pbx_builtin_raise_exception (struct ast_channel *chan, const char *data) |
int | pbx_builtin_serialize_variables (struct ast_channel *chan, struct ast_str **buf) |
Create a human-readable string, specifying all variables and their corresponding values. More... | |
int | pbx_builtin_setvar (struct ast_channel *chan, const char *data) |
Parse and set a single channel variable, where the name and value are separated with an '=' character. More... | |
int | pbx_builtin_setvar_helper (struct ast_channel *chan, const char *name, const char *value) |
Add a variable to the channel variable stack, removing the most recently set value for the same name. More... | |
int | pbx_builtin_setvar_multiple (struct ast_channel *chan, const char *data) |
Parse and set multiple channel variables, where the pairs are separated by the ',' character, and name and value are separated with an '=' character. More... | |
int | pbx_checkcondition (const char *condition) |
Evaluate a condition. More... | |
int | pbx_exec (struct ast_channel *c, struct ast_app *app, const char *data) |
Execute an application. More... | |
struct ast_exten * | pbx_find_extension (struct ast_channel *chan, struct ast_context *bypass, struct pbx_find_info *q, const char *context, const char *exten, int priority, const char *label, const char *callerid, enum ext_match_t action) |
struct ast_app * | pbx_findapp (const char *app) |
Look up an application. More... | |
void | pbx_live_dangerously (int new_live_dangerously) |
Enable/disable the execution of 'dangerous' functions from external protocols (AMI, etc.). More... | |
int | pbx_parse_location (struct ast_channel *chan, char **context, char **exten, char **pri, int *ipri, int *mode, char *rest) |
Parses a dialplan location into context, extension, priority. More... | |
void | pbx_retrieve_variable (struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp) |
Retrieve the value of a builtin variable or variable from the channel variable stack. More... | |
int | pbx_set_autofallthrough (int newval) |
int | pbx_set_extenpatternmatchnew (int newval) |
void | pbx_set_overrideswitch (const char *newval) |
int | ast_context_remove_extension (const char *context, const char *extension, int priority, const char *registrar) |
Simply remove extension from context. More... | |
int | ast_context_remove_extension2 (struct ast_context *con, const char *extension, int priority, const char *registrar, int already_locked) |
This functionc locks given context, search for the right extension and fires out all peer in this extensions with given priority. If priority is set to 0, all peers are removed. After that, unlock context and return. More... | |
int | ast_context_remove_extension_callerid (const char *context, const char *extension, int priority, const char *callerid, int matchcid, const char *registrar) |
int | ast_context_remove_extension_callerid2 (struct ast_context *con, const char *extension, int priority, const char *callerid, int matchcid, const char *registrar, int already_locked) |
Functions for returning values from structures | |
const char * | ast_get_context_name (struct ast_context *con) |
const char * | ast_get_extension_name (struct ast_exten *exten) |
struct ast_context * | ast_get_extension_context (struct ast_exten *exten) |
const char * | ast_get_include_name (const struct ast_include *include) |
const char * | ast_get_ignorepat_name (const struct ast_ignorepat *ip) |
const char * | ast_get_switch_name (const struct ast_sw *sw) |
const char * | ast_get_switch_data (const struct ast_sw *sw) |
int | ast_get_switch_eval (const struct ast_sw *sw) |
Other Extension stuff | |
int | ast_get_extension_priority (struct ast_exten *exten) |
int | ast_get_extension_matchcid (struct ast_exten *e) |
const char * | ast_get_extension_cidmatch (struct ast_exten *e) |
const char * | ast_get_extension_app (struct ast_exten *e) |
const char * | ast_get_extension_label (struct ast_exten *e) |
void * | ast_get_extension_app_data (struct ast_exten *e) |
int | ast_get_extension_data (char *buf, int bufsize, struct ast_channel *c, const char *context, const char *exten, int priority) |
Fill a string buffer with the data at a dialplan extension. More... | |
Registrar info functions ... | |
const char * | ast_get_context_registrar (struct ast_context *c) |
const char * | ast_get_extension_registrar (struct ast_exten *e) |
const char * | ast_get_include_registrar (const struct ast_include *i) |
const char * | ast_get_ignorepat_registrar (const struct ast_ignorepat *ip) |
const char * | ast_get_switch_registrar (const struct ast_sw *sw) |
Walking functions ... | |
struct ast_context * | ast_walk_contexts (struct ast_context *con) |
struct ast_exten * | ast_walk_context_extensions (struct ast_context *con, struct ast_exten *priority) |
struct ast_exten * | ast_walk_extension_priorities (struct ast_exten *exten, struct ast_exten *priority) |
const struct ast_include * | ast_walk_context_includes (const struct ast_context *con, const struct ast_include *inc) |
const struct ast_ignorepat * | ast_walk_context_ignorepats (const struct ast_context *con, const struct ast_ignorepat *ip) |
const struct ast_sw * | ast_walk_context_switches (const struct ast_context *con, const struct ast_sw *sw) |
Iterator functions ... | |
int | ast_context_includes_count (const struct ast_context *con) |
const struct ast_include * | ast_context_includes_get (const struct ast_context *con, int idx) |
int | ast_context_ignorepats_count (const struct ast_context *con) |
const struct ast_ignorepat * | ast_context_ignorepats_get (const struct ast_context *con, int idx) |
int | ast_context_switches_count (const struct ast_context *con) |
const struct ast_sw * | ast_context_switches_get (const struct ast_context *con, int idx) |
Substitution routines, using static string buffers | |
void | pbx_substitute_variables_helper (struct ast_channel *c, const char *cp1, char *cp2, int count) |
void | pbx_substitute_variables_varshead (struct varshead *headp, const char *cp1, char *cp2, int count) |
void | pbx_substitute_variables_helper_full (struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int cp2_size, size_t *used) |
void | pbx_substitute_variables_helper_full_location (struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int cp2_size, size_t *used, const char *context, const char *exten, int pri) |
Substitutes variables, similar to pbx_substitute_variables_helper_full, but allows passing the context, extension, and priority in. | |
Substitution routines, using dynamic string buffers | |
const char * | ast_str_retrieve_variable (struct ast_str **buf, ssize_t maxlen, struct ast_channel *chan, struct varshead *headp, const char *var) |
void | ast_str_substitute_variables (struct ast_str **buf, ssize_t maxlen, struct ast_channel *chan, const char *templ) |
void | ast_str_substitute_variables_varshead (struct ast_str **buf, ssize_t maxlen, struct varshead *headp, const char *templ) |
void | ast_str_substitute_variables_full (struct ast_str **buf, ssize_t maxlen, struct ast_channel *c, struct varshead *headp, const char *templ, size_t *used) |
void | ast_str_substitute_variables_full2 (struct ast_str **buf, ssize_t maxlen, struct ast_channel *c, struct varshead *headp, const char *templ, size_t *used, int use_both) |
Perform variable/function/expression substitution on an ast_str. More... | |
int | ast_hashtab_compare_contexts (const void *ah_a, const void *ah_b) |
hashtable functions for contexts | |
unsigned int | ast_hashtab_hash_contexts (const void *obj) |
Core PBX routines and definitions.
Definition in file pbx.h.
#define ast_custom_function_register_escalating | ( | acf, | |
escalation | |||
) | __ast_custom_function_register_escalating(acf, escalation, AST_MODULE_SELF) |
Register a custom function which requires escalated privileges.
Examples would be SHELL() (for which a read needs permission to execute arbitrary code) or FILE() (for which write needs permission to change files on the filesystem).
Definition at line 1567 of file pbx.h.
Referenced by load_module().
#define AST_PBX_ERROR 1 |
#define AST_PBX_HANGUP -1 |
#define AST_PBX_INCOMPLETE 12 |
Return to PBX matching, allowing more digits for the extension
Definition at line 51 of file pbx.h.
Referenced by __ast_pbx_run(), and dial_exec_full().
#define PRIORITY_HINT -1 |
Special Priority for a hint
Definition at line 54 of file pbx.h.
Referenced by add_priority(), ast_add_extension2_lockopt(), ast_hint_extension_nolock(), ast_merge_contexts_and_delete(), handle_cli_dialplan_add_extension(), handle_cli_dialplan_remove_extension(), handle_cli_dialplan_save(), lua_register_hints(), manager_show_dialplan_helper(), parking_lot_cfg_create_extensions(), and print_ext().
typedef int( ast_switch_f) (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data) |
extension matchcid types
Enumerator | |
---|---|
AST_EXT_MATCHCID_OFF |
Match only extensions with matchcid=0 |
AST_EXT_MATCHCID_ON |
Match only extensions with matchcid=1 AND cidmatch matches |
AST_EXT_MATCHCID_ANY |
Match both - used only in functions manipulating ast_exten's |
enum ast_extension_states |
Extension states.
Enumerator | |
---|---|
AST_OUTGOING_NO_WAIT |
Don't wait for originated call to answer |
AST_OUTGOING_WAIT |
Wait for originated call to answer |
AST_OUTGOING_WAIT_COMPLETE |
Wait for originated call to answer and hangup |
enum ast_pbx_result |
The result codes when starting the PBX on a channel with ast_pbx_start.
enum ext_match_t |
int __ast_custom_function_register_escalating | ( | struct ast_custom_function * | acf, |
enum ast_custom_function_escalation | escalation, | ||
struct ast_module * | mod | ||
) |
Register a custom function which requires escalated privileges.
Examples would be SHELL() (for which a read needs permission to execute arbitrary code) or FILE() (for which write needs permission to change files on the filesystem).
Definition at line 418 of file pbx_functions.c.
References __ast_custom_function_register(), ast_custom_function::read_escalates, and ast_custom_function::write_escalates.
int ast_add_extension | ( | const char * | context, |
int | replace, | ||
const char * | extension, | ||
int | priority, | ||
const char * | label, | ||
const char * | callerid, | ||
const char * | application, | ||
void * | data, | ||
void(*)(void *) | datad, | ||
const char * | registrar | ||
) |
Add and extension to an extension context.
context | context to add the extension to |
replace | |
extension | extension to add |
priority | priority level of extension addition |
label | extension label |
callerid | pattern to match CallerID, or NULL to match any CallerID |
application | application to run on the extension with that priority level |
data | data to pass to the application |
datad | a pointer to a function that will deallocate data when needed or NULL if data does not need to be freed. |
registrar | who registered the extension |
datap
will be called and passed the data
pointer.0 | success |
-1 | failure |
Definition at line 6928 of file pbx.c.
References ast_add_extension2(), ast_unlock_contexts(), and find_context_locked().
Referenced by app_create(), ast_hint_presence_state(), handle_cli_dialplan_add_extension(), and join_conference_bridge().
int ast_add_extension2 | ( | struct ast_context * | con, |
int | replace, | ||
const char * | extension, | ||
int | priority, | ||
const char * | label, | ||
const char * | callerid, | ||
const char * | application, | ||
void * | data, | ||
void(*)(void *) | datad, | ||
const char * | registrar, | ||
const char * | registrar_file, | ||
int | registrar_line | ||
) |
Add an extension to an extension context, this time with an ast_context *.
con | context to add the extension to |
replace | |
extension | extension to add |
priority | priority level of extension addition |
label | extension label |
callerid | pattern to match CallerID, or NULL to match any CallerID |
application | application to run on the extension with that priority level |
data | data to pass to the application |
datad | a pointer to a function that will deallocate data when needed or NULL if data does not need to be freed. |
registrar | who registered the extension |
registrar_file | optional configuration file that defines this extension |
registrar_line | optional line number of configuration file that defines extension |
datap
will be called and passed the data
pointer.0 | success |
-1 | failure |
Add an extension to an extension context, this time with an ast_context *.
We sort extensions in order of matching preference, so that we can stop the search as soon as we find a suitable match. This ordering also takes care of wildcards such as '.' (meaning "one or more of any character") and '!' (which is 'earlymatch', meaning "zero or more of any character" but also impacts the return value from CANMATCH and EARLYMATCH.
The extension match rules defined in the devmeeting 2006.05.05 are quite simple: WE SELECT THE LONGEST MATCH. In detail, "longest" means the number of matched characters in the extension. In case of ties (e.g. _XXX and 333) in the length of a pattern, we give priority to entries with the smallest cardinality (e.g, [5-9] comes before [2-8] before the former has only 5 elements, while the latter has 7, etc. In case of same cardinality, the first element in the range counts. If we still have a tie, any final '!' will make this as a possibly less specific pattern.
EBUSY - can't lock EEXIST - extension with the same priority exist and no replace is set
Definition at line 7257 of file pbx.c.
References ast_add_extension2_lockopt().
Referenced by ast_add_extension(), lua_register_hints(), and pbx_load_users().
int ast_add_extension2_nolock | ( | struct ast_context * | con, |
int | replace, | ||
const char * | extension, | ||
int | priority, | ||
const char * | label, | ||
const char * | callerid, | ||
const char * | application, | ||
void * | data, | ||
void(*)(void *) | datad, | ||
const char * | registrar, | ||
const char * | registrar_file, | ||
int | registrar_line | ||
) |
Same as ast_add_extension2, but assumes you have already locked context.
Definition at line 7266 of file pbx.c.
References ast_add_extension2_lockopt().
int ast_async_goto | ( | struct ast_channel * | chan, |
const char * | context, | ||
const char * | exten, | ||
int | priority | ||
) |
Set the channel to next execute the specified dialplan location.
Definition at line 6969 of file pbx.c.
References ast_channel_is_bridged(), ast_channel_yank(), ast_explicit_goto(), AST_FLAG_IN_AUTOLOOP, ast_hangup(), ast_pbx_start(), AST_SOFTHANGUP_ASYNCGOTO, and ast_softhangup_nolock().
Referenced by action_redirect(), ast_async_goto_by_name(), chan_pjsip_cng_tone_detected(), comeback_goto(), and fax_detect_framehook().
int ast_async_goto_if_exists | ( | struct ast_channel * | chan, |
const char * | context, | ||
const char * | exten, | ||
int | priority | ||
) |
int ast_async_parseable_goto | ( | struct ast_channel * | chan, |
const char * | goto_string | ||
) |
Definition at line 8871 of file pbx.c.
Referenced by handle_redirect().
int ast_build_timing | ( | struct ast_timing * | i, |
const char * | info_in | ||
) |
Construct a timing bitmap, for use in time-based conditionals.
i | Pointer to an ast_timing structure. |
info_in | Standard string containing a timerange, weekday range, monthday range, and month range, as well as an optional timezone. |
1 | on success. |
0 | on failure. |
Definition at line 3806 of file extconf.c.
References ast_strdup, ast_strdupa, ast_timing::daymask, ast_timing::dowmask, get_range(), get_timerange(), ast_timing::monthmask, and ast_timing::timezone.
Referenced by include_alloc().
int ast_canmatch_extension | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
int | priority, | ||
const char * | callerid | ||
) |
Looks for a valid matching extension.
c | not really important |
context | context to search within |
exten | extension to check |
priority | priority of extension path |
callerid | callerid of extension being searched for |
Definition at line 4190 of file pbx.c.
References pbx_extension_helper().
Referenced by leave_voicemail(), and valid_exit().
int ast_check_timing | ( | const struct ast_timing * | i | ) |
Evaluate a pre-constructed bitmap as to whether the current time falls within the range specified.
i | Pointer to an ast_timing structure. |
1 | if the time matches. |
0 | if the current time falls outside of the specified range. |
Definition at line 4000 of file extconf.c.
References ast_check_timing2(), and ast_tvnow().
int ast_check_timing2 | ( | const struct ast_timing * | i, |
const struct timeval | tv | ||
) |
Evaluate a pre-constructed bitmap as to whether a particular time falls within the range specified.
i | Pointer to an ast_timing structure. |
tv | Specified time |
1 | if the time matches. |
0 | if the time falls outside of the specified range. |
Definition at line 245 of file pbx_timing.c.
References ast_localtime(), ast_timing::daymask, ast_timing::dowmask, ast_timing::minmask, ast_timing::monthmask, ast_timing::timezone, ast_tm::tm_hour, ast_tm::tm_mday, ast_tm::tm_min, ast_tm::tm_mon, and ast_tm::tm_wday.
Referenced by ast_check_timing().
char* ast_complete_applications | ( | const char * | line, |
const char * | word, | ||
int | state | ||
) |
Command completion for the list of installed applications.
This can be called from a CLI command completion function that wants to complete from the list of available applications.
Definition at line 429 of file pbx_app.c.
References ast_cli_completion_add(), AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, and ast_strdup.
Referenced by handle_orig(), and handle_show_application().
int ast_context_add_ignorepat | ( | const char * | context, |
const char * | ignorepat, | ||
const char * | registrar | ||
) |
Add an ignorepat.
context | which context to add the ignorepattern to |
ignorepat | ignorepattern to set up for the extension |
registrar | registrar of the ignore pattern |
Adds an ignore pattern to a particular context.
0 | on success |
-1 | on failure |
Definition at line 6835 of file pbx.c.
References ast_unlock_contexts(), and find_context_locked().
Referenced by handle_cli_dialplan_add_ignorepat().
int ast_context_add_include | ( | const char * | context, |
const char * | include, | ||
const char * | registrar | ||
) |
Add a context include.
context | context to add include to |
include | new include to add |
registrar | who's registering it |
Adds an include taking a char * string as the context parameter
0 | on success |
-1 | on error |
Definition at line 6664 of file pbx.c.
References ast_context_add_include2(), ast_unlock_contexts(), and find_context_locked().
Referenced by handle_cli_dialplan_add_include().
static int ast_context_add_include2 | ( | struct ast_context * | con, |
const char * | value, | ||
const char * | registrar | ||
) |
Add a context include.
Adds an include taking a struct ast_context as the first parameter
Definition at line 359 of file ael_main.c.
References ast_debug, ast_unlock_context(), AST_VECTOR_APPEND, ast_wrlock_context(), include_alloc(), include_free(), and ast_context::includes.
Referenced by ast_context_add_include().
int ast_context_add_switch | ( | const char * | context, |
const char * | sw, | ||
const char * | data, | ||
int | eval, | ||
const char * | registrar | ||
) |
Add a switch.
context | context to which to add the switch |
sw | switch to add |
data | data to pass to switch |
eval | whether to evaluate variables when running switch |
registrar | whoever registered the switch |
This function registers a switch with the asterisk switch architecture
0 | on success |
-1 | on failure |
Definition at line 6729 of file pbx.c.
References ast_context_add_switch2(), ast_unlock_contexts(), and find_context_locked().
static int ast_context_add_switch2 | ( | struct ast_context * | con, |
const char * | sw, | ||
const char * | data, | ||
int | eval, | ||
const char * | registrar | ||
) |
Adds a switch (first param is a ast_context)
Definition at line 370 of file ael_main.c.
References ast_context::alts, ast_unlock_context(), AST_VECTOR_APPEND, and ast_wrlock_context().
Referenced by ast_context_add_switch(), and lua_register_switches().
void ast_context_destroy | ( | struct ast_context * | con, |
const char * | registrar | ||
) |
Destroy a context (matches the specified context or ANY context if NULL)
con | context to destroy |
registrar | who registered it |
You can optionally leave out either parameter. It will find it based on either the ast_context or the registrar name.
Definition at line 8221 of file pbx.c.
References ast_unlock_contexts(), and ast_wrlock_contexts().
Referenced by ast_context_destroy_by_name(), lua_find_extension(), parking_lot_cfg_remove_extensions(), and unload_module().
int ast_context_destroy_by_name | ( | const char * | context, |
const char * | registrar | ||
) |
Destroy a context by name.
context | Name of the context to destroy |
registrar | who registered it |
You can optionally leave out the registrar parameter. It will find it based on the context name.
-1 | context not found |
0 | Success |
Definition at line 8205 of file pbx.c.
References ast_context_destroy(), ast_context_find(), ast_unlock_contexts(), and ast_wrlock_contexts().
Referenced by handle_cli_dialplan_remove_context().
static struct ast_context * ast_context_find | ( | const char * | name | ) |
Find a context.
name | name of the context to find |
Will search for the context with the given name.
Definition at line 4172 of file extconf.c.
References ast_context_find(), ast_hashtab_lookup(), ast_rdlock_contexts(), ast_unlock_contexts(), and ast_context::name.
Referenced by app_create(), ast_context_destroy_by_name(), ast_context_find(), ast_context_verify_includes(), ast_ignore_pattern(), context_included(), handle_cli_dialplan_add_extension(), and handle_cli_dialplan_add_include().
struct ast_context* ast_context_find_or_create | ( | struct ast_context ** | extcontexts, |
struct ast_hashtab * | exttable, | ||
const char * | name, | ||
const char * | registrar | ||
) |
Register a new context or find an existing one.
extcontexts | pointer to the ast_context structure pointer |
exttable | pointer to the hashtable that contains all the elements in extcontexts |
name | name of the new context |
registrar | registrar of the context |
This function allows you to play in two environments: the global contexts (active dialplan) or an external context set of your choosing. To act on the external set, make sure extcontexts and exttable are set; for the globals, make sure both extcontexts and exttable are NULL.
This will first search for a context with your name. If it exists already, it will not create a new one. If it does not exist, it will create a new one with the given name and registrar.
Definition at line 6149 of file pbx.c.
References ast_context::alts, ast_calloc, ast_debug, ast_hashtab_compare_contexts(), ast_hashtab_create, ast_hashtab_insert_immediate, ast_hashtab_lookup(), ast_hashtab_newsize_java(), ast_hashtab_resize_java(), ast_rdlock_contexts(), ast_rwlock_init, ast_unlock_contexts(), AST_VECTOR_INIT, ast_wrlock_contexts(), ast_context::data, ast_context::ignorepats, ast_context::includes, ast_context::lock, ast_context::name, ast_context::next, ast_context::refcount, ast_context::registrar, ast_context::root, and ast_context::root_table.
Referenced by app_create(), handle_cli_dialplan_add_extension(), handle_cli_dialplan_add_include(), lua_register_hints(), lua_register_switches(), parking_lot_cfg_create_extensions(), pbx_load_users(), and set_config().
int ast_context_remove_extension | ( | const char * | context, |
const char * | extension, | ||
int | priority, | ||
const char * | registrar | ||
) |
Simply remove extension from context.
context | context to remove extension from |
extension | which extension to remove |
priority | priority of extension to remove (0 to remove all) |
registrar | registrar of the extension |
This function removes an extension from a given context.
0 | on success |
-1 | on failure |
Definition at line 4948 of file pbx.c.
References AST_EXT_MATCHCID_ANY.
Referenced by conf_ended().
int ast_context_remove_extension2 | ( | struct ast_context * | con, |
const char * | extension, | ||
int | priority, | ||
const char * | registrar, | ||
int | already_locked | ||
) |
This functionc locks given context, search for the right extension and fires out all peer in this extensions with given priority. If priority is set to 0, all peers are removed. After that, unlock context and return.
Definition at line 4978 of file pbx.c.
References AST_EXT_MATCHCID_ANY.
int ast_context_remove_ignorepat | ( | const char * | context, |
const char * | ignorepat, | ||
const char * | registrar | ||
) |
Remove an ignorepat.
context | context from which to remove the pattern |
ignorepat | the pattern to remove |
registrar | the registrar of the ignore pattern |
This removes the given ignorepattern
0 | on success |
-1 | on failure |
Definition at line 6795 of file pbx.c.
References ast_unlock_contexts(), and find_context_locked().
int ast_context_remove_include | ( | const char * | context, |
const char * | include, | ||
const char * | registrar | ||
) |
Remove a context include.
Remove a context include.
Definition at line 4836 of file pbx.c.
References ast_context_remove_include2(), ast_unlock_contexts(), and find_context_locked().
Referenced by handle_cli_dialplan_remove_include().
int ast_context_remove_include2 | ( | struct ast_context * | con, |
const char * | include, | ||
const char * | registrar | ||
) |
Removes an include by an ast_context structure.
Removes an include by an ast_context structure.
0 | on success. |
-1 | on failure. |
Definition at line 4859 of file pbx.c.
References ast_unlock_context(), AST_VECTOR_GET, AST_VECTOR_REMOVE_ORDERED, ast_wrlock_context(), include_free(), and ast_context::includes.
Referenced by ast_context_remove_include().
int ast_context_remove_switch | ( | const char * | context, |
const char * | sw, | ||
const char * | data, | ||
const char * | registrar | ||
) |
Remove a switch.
Removes a switch with the given parameters
0 | on success |
-1 | on failure |
Definition at line 4894 of file pbx.c.
References ast_context_remove_switch2(), ast_unlock_contexts(), and find_context_locked().
int ast_context_remove_switch2 | ( | struct ast_context * | con, |
const char * | sw, | ||
const char * | data, | ||
const char * | registrar | ||
) |
This function locks given context, removes switch, unlock context and return.
Definition at line 4916 of file pbx.c.
References ast_context::alts, ast_unlock_context(), AST_VECTOR_GET, AST_VECTOR_REMOVE_ORDERED, and ast_wrlock_context().
Referenced by ast_context_remove_switch().
void ast_context_set_autohints | ( | struct ast_context * | con, |
int | enabled | ||
) |
Enable or disable autohints support on a context.
con | pointer to the context |
enabled | whether autohints are enabled |
Definition at line 6230 of file pbx.c.
References ast_context::autohints, and enabled.
int ast_context_verify_includes | ( | struct ast_context * | con | ) |
Verifies includes in an ast_contect structure.
con | context in which to verify the includes |
0 | if no problems found |
-1 | if there were any missing context |
Definition at line 8732 of file pbx.c.
References ast_context_find().
int ast_destroy_timing | ( | struct ast_timing * | i | ) |
Deallocates memory structures associated with a timing bitmap.
i | Pointer to an ast_timing structure. |
0 | success |
non-zero | failure (number suitable to pass to |
Definition at line 279 of file pbx_timing.c.
References ast_timing::timezone.
Referenced by include_free().
enum ast_extension_states ast_devstate_to_extenstate | ( | enum ast_device_state | devstate | ) |
Map devstate to an extension state.
[in] | devstate | device state |
Definition at line 3006 of file pbx.c.
References AST_DEVICE_BUSY, AST_DEVICE_INUSE, AST_DEVICE_INVALID, AST_DEVICE_NOT_INUSE, AST_DEVICE_ONHOLD, AST_DEVICE_RINGING, AST_DEVICE_RINGINUSE, AST_DEVICE_TOTAL, AST_DEVICE_UNAVAILABLE, AST_DEVICE_UNKNOWN, AST_EXTENSION_BUSY, AST_EXTENSION_INUSE, AST_EXTENSION_NOT_INUSE, AST_EXTENSION_ONHOLD, AST_EXTENSION_RINGING, and AST_EXTENSION_UNAVAILABLE.
int ast_exists_extension | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
int | priority, | ||
const char * | callerid | ||
) |
Determine whether an extension exists.
c | this is not important |
context | which context to look in |
exten | which extension to search for |
priority | priority of the action within the extension |
callerid | callerid to search for |
Definition at line 4175 of file pbx.c.
References pbx_extension_helper().
Referenced by __ast_pbx_run(), ast_app_dtget(), ast_bridge_setup_after_goto(), ast_pbx_outgoing_exten_predial(), chan_pjsip_cng_tone_detected(), comeback_goto(), dial_exec_full(), fax_detect_framehook(), grab_transfer(), jingle_new(), join_conference_bridge(), leave_voicemail(), local_call(), local_devicestate(), and waitstream_core().
int ast_explicit_goto | ( | struct ast_channel * | chan, |
const char * | context, | ||
const char * | exten, | ||
int | priority | ||
) |
Definition at line 6945 of file pbx.c.
References AST_FLAG_IN_AUTOLOOP.
Referenced by ast_async_goto(), and ast_bridge_setup_after_goto().
int ast_extension_cmp | ( | const char * | a, |
const char * | b | ||
) |
Determine if one extension should match before another.
a | extension to compare with b |
b | extension to compare with a |
Checks whether or extension a should match before extension b
0 | if the two extensions have equal matching priority |
1 | on a > b |
-1 | on a < b |
Definition at line 2197 of file pbx.c.
References ext_cmp().
Referenced by lua_extension_cmp().
static int ast_extension_match | ( | const char * | pattern, |
const char * | extension | ||
) |
Determine if a given extension matches a given pattern (in NXX format)
pattern | pattern to match |
extension | extension to check against the pattern. |
Checks whether or not the given extension matches the given pattern.
1 | on match |
0 | on failure |
Definition at line 4295 of file extconf.c.
References ast_extension_match().
Referenced by ast_extension_match(), ast_ignore_pattern(), do_say(), lua_find_extension(), manager_show_dialplan_helper(), and reload().
int ast_extension_state | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten | ||
) |
Uses hint and devicestate callback to get the state of an extension.
c | this is not important |
context | which context to look in |
exten | which extension to get state |
Uses hint and devicestate callback to get the state of an extension.
Definition at line 3170 of file pbx.c.
Referenced by get_queue_member_status().
const char* ast_extension_state2str | ( | int | extension_state | ) |
Return string representation of the state of an extension.
extension_state | is the numerical state delivered by ast_extension_state |
Return string representation of the state of an extension.
Definition at line 3126 of file pbx.c.
Referenced by handle_show_hint(), and handle_show_hints().
int ast_extension_state_add | ( | const char * | context, |
const char * | exten, | ||
ast_state_cb_type | change_cb, | ||
void * | data | ||
) |
Add watcher for extension states.
context | which context to look in |
exten | which extension to get state |
change_cb | callback to call if state changed |
data | to pass to callback |
-1 | on failure |
0 | Global watcher added successfully |
ID | on success |
Definition at line 3823 of file pbx.c.
Referenced by create_queue_member().
int ast_extension_state_add_destroy | ( | const char * | context, |
const char * | exten, | ||
ast_state_cb_type | change_cb, | ||
ast_state_cb_destroy_type | destroy_cb, | ||
void * | data | ||
) |
Add watcher for extension states with destructor.
context | which context to look in |
exten | which extension to get state |
change_cb | callback to call if state changed |
destroy_cb | callback to call when the watcher is destroyed. |
data | to pass to callbacks |
-1 | on failure |
0 | Global watcher added successfully |
ID | on success |
int ast_extension_state_add_destroy_extended | ( | const char * | context, |
const char * | exten, | ||
ast_state_cb_type | change_cb, | ||
ast_state_cb_destroy_type | destroy_cb, | ||
void * | data | ||
) |
Add watcher for extended extension states with destructor.
context | which context to look in |
exten | which extension to get state |
change_cb | callback to call if state changed |
destroy_cb | callback to call when the watcher is destroyed. |
data | to pass to callbacks |
-1 | on failure |
0 | Global watcher added successfully |
ID | on success |
int ast_extension_state_add_extended | ( | const char * | context, |
const char * | exten, | ||
ast_state_cb_type | change_cb, | ||
void * | data | ||
) |
Add watcher for extended extension states.
context | which context to look in |
exten | which extension to get state |
change_cb | callback to call if state changed |
data | to pass to callback |
-1 | on failure |
0 | Global watcher added successfully |
ID | on success |
int ast_extension_state_del | ( | int | id, |
ast_state_cb_type | change_cb | ||
) |
Deletes a state change watcher by ID.
id | of the state watcher to delete (0 for global watcher) |
change_cb | callback to call if state changed (Used if id == 0 (global)) |
0 | success |
-1 | failure |
Definition at line 3856 of file pbx.c.
References ao2_callback, ao2_ref, ast_hint::callbacks, find_hint_by_cb_id(), and OBJ_UNLINK.
int ast_extension_state_extended | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
struct ao2_container ** | device_state_info | ||
) |
Uses hint and devicestate callback to get the extended state of an extension.
c | this is not important | |
context | which context to look in | |
exten | which extension to get state | |
[out] | device_state_info | ptr to an ao2_container with extended state info, must be unref'd after use. |
Uses hint and devicestate callback to get the extended state of an extension.
Definition at line 3176 of file pbx.c.
References ao2_ref, and container.
int ast_findlabel_extension | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
const char * | label, | ||
const char * | callerid | ||
) |
Find the priority of an extension that has the specified label.
c | this is not important |
context | which context to look in |
exten | which extension to search for |
label | label of the action within the extension to match to priority |
callerid | callerid to search for |
the | priority which matches the given label in the extension |
-1 | if not found. |
Definition at line 4180 of file pbx.c.
References pbx_extension_helper().
Referenced by action_redirect(), ast_ari_channels_continue_in_dialplan(), and pbx_parse_location().
static int ast_findlabel_extension2 | ( | struct ast_channel * | c, |
struct ast_context * | con, | ||
const char * | exten, | ||
const char * | label, | ||
const char * | callerid | ||
) |
Find the priority of an extension that has the specified label.
Definition at line 4975 of file extconf.c.
References ast_findlabel_extension2(), and pbx_extension_helper().
Referenced by ast_findlabel_extension2().
int ast_func_read | ( | struct ast_channel * | chan, |
const char * | function, | ||
char * | workspace, | ||
size_t | len | ||
) |
executes a read operation on a function
chan | Channel to execute on |
function | Data containing the function call string (will be modified) |
workspace | A pointer to safe memory to use for a return value |
len | the number of bytes in workspace |
This application executes a function in read mode on a given channel.
0 | success |
non-zero | failure |
Definition at line 599 of file pbx_functions.c.
References ast_copy_string(), ast_str_buffer(), ast_str_create, ast_str_size(), ast_strdupa, copy(), func_args(), is_read_allowed(), ast_custom_function::mod, ast_custom_function::read, and ast_custom_function::read2.
Referenced by handle_eval_function(), lua_get_variable_value(), and pbx_substitute_variables_helper_full_location().
int ast_func_read2 | ( | struct ast_channel * | chan, |
const char * | function, | ||
struct ast_str ** | str, | ||
ssize_t | maxlen | ||
) |
executes a read operation on a function
chan | Channel to execute on |
function | Data containing the function call string (will be modified) |
str | A dynamic string buffer into which to place the result. |
maxlen | <0 if the dynamic buffer should not grow; >0 if the dynamic buffer should be limited to that number of bytes; 0 if the dynamic buffer has no upper limit |
This application executes a function in read mode on a given channel.
0 | success |
non-zero | failure |
Definition at line 642 of file pbx_functions.c.
References ast_str_buffer(), ast_str_reset(), ast_str_size(), ast_str_update(), ast_strdupa, copy(), func_args(), is_read_allowed(), ast_custom_function::mod, ast_custom_function::read, ast_custom_function::read2, and ast_custom_function::read_max.
Referenced by ast_ari_channels_get_channel_var(), and ast_str_substitute_variables_full2().
int ast_func_write | ( | struct ast_channel * | chan, |
const char * | function, | ||
const char * | value | ||
) |
executes a write operation on a function
chan | Channel to execute on |
function | Data containing the function call string (will be modified) |
value | A value parameter to pass for writing |
This application executes a function in write mode on a given channel.
0 | success |
non-zero | failure |
Definition at line 693 of file pbx_functions.c.
References ast_strdupa, copy(), func_args(), is_write_allowed(), ast_custom_function::mod, and ast_custom_function::write.
Referenced by ast_channel_hangupcause_hash_set(), confbridge_exec(), pbx_builtin_pushvar_helper(), and pbx_builtin_setvar_helper().
int ast_get_extension_data | ( | char * | buf, |
int | bufsize, | ||
struct ast_channel * | c, | ||
const char * | context, | ||
const char * | exten, | ||
int | priority | ||
) |
Fill a string buffer with the data at a dialplan extension.
buf | String buffer |
bufsize | Size of buf |
c | Channel |
context | Dialplan context |
exten | Dialplan extension |
priority | Dialplan priority |
-1 | Failed to obtain extension data |
0 | Successfully obtained extension data |
Definition at line 8567 of file pbx.c.
References ast_copy_string(), ast_rdlock_contexts(), and ast_unlock_contexts().
const char* ast_get_extension_registrar_file | ( | struct ast_exten * | e | ) |
Get name of configuration file used by registrar to register this extension.
NULL | if registrar did not indicate config file when registering the extension |
name | of the file used to register the extension |
Definition at line 8537 of file pbx.c.
References ast_exten::registrar_file.
Referenced by show_dialplan_helper_extension_output().
int ast_get_extension_registrar_line | ( | struct ast_exten * | e | ) |
Get line number of configuration file used by registrar to register this extension.
0 | if the line wasn't indicated when the extension was registered |
positive | integer indicating what line in the config file was responsible for registering the extension. |
Definition at line 8542 of file pbx.c.
References ast_exten::registrar_line.
Referenced by show_dialplan_helper_extension_output().
int ast_get_hint | ( | char * | hint, |
int | hintsize, | ||
char * | name, | ||
int | namesize, | ||
struct ast_channel * | c, | ||
const char * | context, | ||
const char * | exten | ||
) |
If an extension hint exists, return non-zero.
hint | buffer for hint |
hintsize | size of hint buffer, in bytes |
name | buffer for name portion of hint |
namesize | size of name buffer |
c | Channel from which to return the hint. This is only important when the hint or name contains an expression to be expanded. |
context | which context to look in |
exten | which extension to search for |
If an extension hint exists, return non-zero.
Definition at line 4137 of file pbx.c.
References ast_copy_string().
int ast_goto_if_exists | ( | struct ast_channel * | chan, |
const char * | context, | ||
const char * | exten, | ||
int | priority | ||
) |
Definition at line 8781 of file pbx.c.
Referenced by ast_bridge_setup_after_goto(), and valid_exit().
int ast_hint_presence_state | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
char ** | subtype, | ||
char ** | message | ||
) |
Uses hint and presence state callback to get the presence state of an extension.
c | this is not important | |
context | which context to look in | |
exten | which extension to get state | |
[out] | subtype | Further information regarding the presence returned |
[out] | message | Custom message further describing current presence |
Definition at line 3226 of file pbx.c.
References ast_exten::app, ast_add_extension(), ast_free_ptr(), ast_strdup, ast_exten::cidmatch, ast_exten::data, ast_exten::exten, ast_exten::label, ast_exten::matchcid, ast_context::name, ast_exten::parent, ast_exten::priority, and ast_exten::registrar.
int ast_ignore_pattern | ( | const char * | context, |
const char * | pattern | ||
) |
Checks to see if a number should be ignored.
context | context to search within |
pattern | to check whether it should be ignored or not |
Check if a number should be ignored with respect to dialtone cancellation.
0 | if the pattern should not be ignored |
non-zero | if the pattern should be ignored |
Definition at line 6879 of file pbx.c.
References ast_context_find(), ast_extension_match(), ast_rdlock_contexts(), and ast_unlock_contexts().
Referenced by ast_app_dtget().
int ast_matchmore_extension | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
int | priority, | ||
const char * | callerid | ||
) |
Looks to see if adding anything to this extension might match something. (exists ^ canmatch)
c | not really important XXX |
context | context to search within |
exten | extension to check |
priority | priority of extension path |
callerid | callerid of extension being searched for |
Definition at line 4195 of file pbx.c.
References pbx_extension_helper().
Referenced by __ast_pbx_run(), ast_app_dtget(), and collect_digits().
void ast_merge_contexts_and_delete | ( | struct ast_context ** | extcontexts, |
struct ast_hashtab * | exttable, | ||
const char * | registrar | ||
) |
Merge the temporary contexts into a global contexts list and delete from the global list the ones that are being added.
extcontexts | pointer to the ast_context structure |
exttable | pointer to the ast_hashtab structure that contains all the elements in extcontexts |
registrar | of the context; if it's set the routine will delete all contexts that belong to that registrar; if NULL only the contexts that are specified in extcontexts |
Definition at line 6426 of file pbx.c.
References ao2_callback, ao2_container_count(), ao2_iterator_destroy(), AO2_ITERATOR_DONTLOCK, ao2_iterator_init(), ao2_link, ao2_ref, ast_exten::app, ast_calloc, ast_copy_string(), ast_free_ptr(), ast_hashtab_destroy(), ast_hashtab_end_traversal(), ast_hashtab_next(), ast_hint_extension_nolock(), AST_HINT_UPDATE_DEVICE, AST_LIST_HEAD_NOLOCK_INIT_VALUE, AST_LIST_INSERT_HEAD, AST_LIST_INSERT_TAIL, AST_LIST_REMOVE_HEAD, ast_strdup, ast_tvdiff_us(), ast_tvnow(), ast_unlock_contexts(), ast_wrlock_contexts(), ast_hint::callbacks, ast_state_cb::change_cb, context_merge_lock, context_table_create_autohints(), ast_exten::data, ast_state_cb::data, ast_exten::exten, ast_hint::exten, ast_hint::last_presence_message, ast_hint::last_presence_state, ast_hint::last_presence_subtype, ast_hint::laststate, ast_context::name, ast_context::next, OBJ_UNLINK, ast_exten::parent, PRIORITY_HINT, and ast_exten::registrar.
Referenced by localized_merge_contexts_and_delete(), and lua_reload_extensions().
int ast_parseable_goto | ( | struct ast_channel * | chan, |
const char * | goto_string | ||
) |
Definition at line 8866 of file pbx.c.
Referenced by ast_bridge_setup_after_goto(), dial_exec_full(), and pbx_builtin_goto().
int ast_pbx_exec_application | ( | struct ast_channel * | chan, |
const char * | app_name, | ||
const char * | app_args | ||
) |
Execute an application.
chan | channel to execute on |
app_name | name of app to execute |
app_args | the data passed into the app |
This application executes an application by name on a given channel. It is a wrapper around pbx_exec that will perform variable substitution and then execute the application if it exists. If the application is not found, a warning is logged.
0 | success |
-1 | failure (including application not found) |
Definition at line 501 of file pbx_app.c.
References ast_channel_publish_snapshot(), ast_str_buffer(), ast_str_create, ast_str_substitute_variables(), pbx_exec(), and pbx_findapp().
Referenced by answer_exec_run(), and snoop_stasis_thread().
void ast_pbx_h_exten_run | ( | struct ast_channel * | chan, |
const char * | context | ||
) |
Run the h exten from the given context.
chan | Channel to run the h exten on. |
context | Context the h exten is in. |
Definition at line 4205 of file pbx.c.
References ast_debug, AST_FLAG_BRIDGE_HANGUP_RUN, AST_FLAG_IN_AUTOLOOP, AST_SOFTHANGUP_HANGUP_EXEC, ast_softhangup_nolock(), ast_spawn_extension(), and S_COR.
Referenced by __ast_pbx_run(), and ast_bridge_setup_after_goto().
void ast_pbx_hangup_handler_destroy | ( | struct ast_channel * | chan | ) |
Destroy the hangup handler container on a channel.
chan | Channel to destroy the hangup handler container on. |
Definition at line 103 of file pbx_hangup_handler.c.
References AST_LIST_REMOVE_HEAD.
Referenced by ast_channel_destructor(), and ast_dummy_channel_destructor().
void ast_pbx_hangup_handler_init | ( | struct ast_channel * | chan | ) |
Init the hangup handler container on a channel.
chan | Channel to init the hangup handler container on. |
Definition at line 95 of file pbx_hangup_handler.c.
References AST_LIST_HEAD_INIT_NOLOCK.
Referenced by __ast_channel_alloc_ap().
int ast_pbx_hangup_handler_pop | ( | struct ast_channel * | chan | ) |
Pop the top of the channel hangup handler stack.
chan | Channel to push the hangup handler onto. |
TRUE | if a handler was popped off of the stack. |
Definition at line 119 of file pbx_hangup_handler.c.
References ast_hangup_handler::args, and AST_LIST_REMOVE_HEAD.
void ast_pbx_hangup_handler_push | ( | struct ast_channel * | chan, |
const char * | handler | ||
) |
Push the given hangup handler onto the channel hangup handler stack.
chan | Channel to push the hangup handler onto. |
handler | Gosub application parameter string. |
Definition at line 138 of file pbx_hangup_handler.c.
References ast_hangup_handler::args, ast_app_expand_sub_args(), AST_LIST_INSERT_HEAD, and ast_malloc.
int ast_pbx_hangup_handler_run | ( | struct ast_channel * | chan | ) |
Run all hangup handlers on the channel.
chan | Channel to run the hangup handlers on. |
Zero | if no hangup handlers run. |
non-zero | if hangup handlers were run. |
Definition at line 58 of file pbx_hangup_handler.c.
References ast_hangup_handler::args, ast_app_exec_sub(), AST_LIST_EMPTY, AST_LIST_REMOVE_HEAD, AST_SOFTHANGUP_HANGUP_EXEC, and ast_softhangup_nolock().
Referenced by __ast_pbx_run(), and ast_hangup().
int ast_pbx_outgoing_app | ( | const char * | type, |
struct ast_format_cap * | cap, | ||
const char * | addr, | ||
int | timeout, | ||
const char * | app, | ||
const char * | appdata, | ||
int * | reason, | ||
int | synchronous, | ||
const char * | cid_num, | ||
const char * | cid_name, | ||
struct ast_variable * | vars, | ||
const char * | account, | ||
struct ast_channel ** | locked_channel, | ||
const struct ast_assigned_ids * | assignedids | ||
) |
Synchronously or asynchronously make an outbound call and execute an application on the channel.
Note that when the application stops executing, the channel is hungup.
type | The channel technology to create |
cap | The format capabilities for the channel |
addr | Address data to pass to the channel technology driver |
timeout | How long we should attempt to dial the outbound channel |
app | The name of the application to execute |
appdata | Data to pass to the application |
reason | Optional. If provided, the dialed status of the outgoing channel. Codes are AST_CONTROL_xxx values. Valid only if synchronous is non-zero. |
synchronous | defined by the ast_pbx_outgoing_sync enum. If AST_OUTGOING_NO_WAIT then don't wait for anything. If AST_OUTGOING_WAIT then block until the outbound channel answers or the call fails. If AST_OUTGOING_WAIT_COMPLETE then wait for the call to complete or fail. |
cid_num | The caller ID number to set on the outbound channel |
cid_name | The caller ID name to set on the outbound channel |
vars | Variables to set on the outbound channel |
account | The accountcode for the outbound channel |
locked_channel | Optional. The outbound channel that was created if success is returned. Otherwise it is set to NULL. This is returned both locked and reference bumped. |
assignedids | Optional. The uniqueid(s) to assign the channel(s) that are created. |
0 | on success |
-1 | on failure |
Definition at line 7980 of file pbx.c.
Referenced by orig_app().
int ast_pbx_outgoing_exten | ( | const char * | type, |
struct ast_format_cap * | cap, | ||
const char * | addr, | ||
int | timeout, | ||
const char * | context, | ||
const char * | exten, | ||
int | priority, | ||
int * | reason, | ||
int | synchronous, | ||
const char * | cid_num, | ||
const char * | cid_name, | ||
struct ast_variable * | vars, | ||
const char * | account, | ||
struct ast_channel ** | locked_channel, | ||
int | early_media, | ||
const struct ast_assigned_ids * | assignedids | ||
) |
Synchronously or asynchronously make an outbound call and send it to a particular extension.
type | The channel technology to create |
cap | The format capabilities for the channel |
addr | Address data to pass to the channel technology driver |
timeout | How long we should attempt to dial the outbound channel |
context | The destination context for the outbound channel |
exten | The destination extension for the outbound channel |
priority | The destination priority for the outbound channel |
reason | Optional. If provided, the dialed status of the outgoing channel. Codes are AST_CONTROL_xxx values. Valid only if synchronous is non-zero. |
synchronous | defined by the ast_pbx_outgoing_sync enum. If AST_OUTGOING_NO_WAIT then don't wait for anything. If AST_OUTGOING_WAIT then block until the outbound channel answers or the call fails. If AST_OUTGOING_WAIT_COMPLETE then wait for the call to complete or fail. If AST_OUTGOING_WAIT or AST_OUTGOING_WAIT_COMPLETE is specified, the call doesn't answer, and failed@context exists then run a channel named OutgoingSpoolFailed at failed@context . |
cid_num | The caller ID number to set on the outbound channel |
cid_name | The caller ID name to set on the outbound channel |
vars | Variables to set on the outbound channel |
account | The accountcode for the outbound channel |
locked_channel | Optional. The outbound channel that was created if success is returned. Otherwise it is set to NULL. This is returned both locked and reference bumped. |
early_media | If non-zero the channel "answers" when progress is indicated. |
assignedids | Optional. The uniqueid(s) to assign the channel(s) that are created. |
0 | on success |
-1 | on failure |
Definition at line 7916 of file pbx.c.
References ast_pbx_outgoing_exten_predial().
Referenced by orig_exten().
int ast_pbx_outgoing_exten_predial | ( | const char * | type, |
struct ast_format_cap * | cap, | ||
const char * | addr, | ||
int | timeout, | ||
const char * | context, | ||
const char * | exten, | ||
int | priority, | ||
int * | reason, | ||
int | synchronous, | ||
const char * | cid_num, | ||
const char * | cid_name, | ||
struct ast_variable * | vars, | ||
const char * | account, | ||
struct ast_channel ** | locked_channel, | ||
int | early_media, | ||
const struct ast_assigned_ids * | assignedids, | ||
const char * | predial_callee | ||
) |
Definition at line 7926 of file pbx.c.
References ast_channel_alloc, ast_exists_extension(), ast_hangup(), ast_pbx_run(), ast_set_variables(), AST_STATE_DOWN, and pbx_builtin_setvar_helper().
Referenced by ast_pbx_outgoing_exten().
enum ast_pbx_result ast_pbx_run | ( | struct ast_channel * | c | ) |
Execute the PBX in the current thread.
c | channel to run the pbx on |
This executes the PBX on a given channel. It allocates a new PBX structure for the channel, and provides all PBX functionality. See ast_pbx_start for an asynchronous function to run the PBX in a new thread as opposed to the current one.
Zero | on success |
non-zero | on failure |
Definition at line 4755 of file pbx.c.
References ast_pbx_run_args().
Referenced by ari_originate_dial(), ast_bridge_run_after_goto(), ast_pbx_outgoing_exten_predial(), and pbx_outgoing_exec().
enum ast_pbx_result ast_pbx_run_args | ( | struct ast_channel * | c, |
struct ast_pbx_args * | args | ||
) |
Execute the PBX in the current thread.
c | channel to run the pbx on |
args | options for the pbx |
This executes the PBX on a given channel. It allocates a new PBX structure for the channel, and provides all PBX functionality. See ast_pbx_start for an asynchronous function to run the PBX in a new thread as opposed to the current one.
Zero | on success |
non-zero | on failure |
Definition at line 4735 of file pbx.c.
References __ast_pbx_run(), AST_OPT_FLAG_FULLY_BOOTED, and increase_call_count().
Referenced by ast_pbx_run(), and stasis_app_exec().
enum ast_pbx_result ast_pbx_start | ( | struct ast_channel * | c | ) |
Create a new thread and start the PBX.
c | channel to start the pbx on |
Zero | on success |
non-zero | on failure |
Definition at line 4708 of file pbx.c.
References AST_OPT_FLAG_FULLY_BOOTED, and increase_call_count().
Referenced by ast_async_goto(), ast_iax2_new(), console_new(), dial_exec_full(), handle_response_clip(), handle_response_cmgr(), jingle_action_session_initiate(), local_call(), and unistim_new().
int ast_rdlock_context | ( | struct ast_context * | con | ) |
Read locks a given context.
con | context to lock |
0 | on success |
-1 | on failure |
Definition at line 8486 of file pbx.c.
References ast_context::lock.
Referenced by handle_cli_dialplan_save(), lookup_c_ip(), lookup_ci(), and manager_show_dialplan_helper().
int ast_rdlock_contexts | ( | void | ) |
Read locks the context list.
0 | on success |
-1 | on error |
Definition at line 8468 of file pbx.c.
References conlock.
Referenced by ast_context_find(), ast_context_find_or_create(), ast_get_extension_data(), ast_ignore_pattern(), ast_unregister_application(), complete_dialplan_add_extension(), find_context_locked(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), pbx_extension_helper(), and unreference_cached_app().
int ast_register_switch | ( | struct ast_switch * | sw | ) |
Register an alternative dialplan switch.
sw | switch to register |
This function registers a populated ast_switch structure with the asterisk switching architecture.
0 | success |
non-zero | failure |
Definition at line 58 of file pbx_switch.c.
References AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_switch::name.
Referenced by load_module(), and lua_find_extension().
int ast_spawn_extension | ( | struct ast_channel * | c, |
const char * | context, | ||
const char * | exten, | ||
int | priority, | ||
const char * | callerid, | ||
int * | found, | ||
int | combined_find_spawn | ||
) |
Launch a new extension (i.e. new stack)
c | not important |
context | which context to generate the extension within |
exten | new extension to add |
priority | priority of new extension |
callerid | callerid of extension |
found | |
combined_find_spawn | This adds a new extension to the asterisk extension list. |
0 | on success |
-1 | on failure. |
Definition at line 4200 of file pbx.c.
References pbx_extension_helper().
Referenced by __ast_pbx_run(), and ast_pbx_h_exten_run().
int ast_str_get_hint | ( | struct ast_str ** | hint, |
ssize_t | hintsize, | ||
struct ast_str ** | name, | ||
ssize_t | namesize, | ||
struct ast_channel * | c, | ||
const char * | context, | ||
const char * | exten | ||
) |
If an extension hint exists, return non-zero.
hint | buffer for hint |
hintsize | Maximum size of hint buffer (<0 to prevent growth, >0 to limit growth to that number of bytes, or 0 for unlimited growth) |
name | buffer for name portion of hint |
namesize | Maximum size of name buffer (<0 to prevent growth, >0 to limit growth to that number of bytes, or 0 for unlimited growth) |
c | Channel from which to return the hint. This is only important when the hint or name contains an expression to be expanded. |
context | which context to look in |
exten | which extension to search for |
If an extension hint exists, return non-zero.
Definition at line 4155 of file pbx.c.
References ast_str_set().
Referenced by ast_str_retrieve_variable().
const char* ast_str_retrieve_variable | ( | struct ast_str ** | buf, |
ssize_t | maxlen, | ||
struct ast_channel * | chan, | ||
struct varshead * | headp, | ||
const char * | var | ||
) |
buf | Result will be placed in this buffer. |
maxlen | -1 if the buffer should not grow, 0 if the buffer may grow to any size, and >0 if the buffer should grow only to that number of bytes. |
chan | Channel variables from which to extract values, and channel to pass to any dialplan functions. |
headp | If no channel is specified, a channel list from which to extract variable values |
var | Variable name to retrieve. |
Definition at line 250 of file pbx_variables.c.
References ast_debug, ast_eid_default, ast_eid_to_str(), AST_LIST_TRAVERSE, ast_party_id_presentation(), ast_str_buffer(), ast_str_get_hint(), ast_str_set(), ast_strdupa, and parse_variable_name().
Referenced by ast_ari_asterisk_get_global_var(), ast_ari_channels_get_channel_var(), ast_str_substitute_variables_full2(), and pbx_retrieve_variable().
void ast_str_substitute_variables | ( | struct ast_str ** | buf, |
ssize_t | maxlen, | ||
struct ast_channel * | chan, | ||
const char * | templ | ||
) |
buf | Result will be placed in this buffer. |
maxlen | -1 if the buffer should not grow, 0 if the buffer may grow to any size, and >0 if the buffer should grow only to that number of bytes. |
chan | Channel variables from which to extract values, and channel to pass to any dialplan functions. |
templ | Variable template to expand. |
Definition at line 650 of file pbx_variables.c.
References ast_str_substitute_variables_full().
Referenced by acf_odbc_write(), ast_pbx_exec_application(), destroy_curl(), handle_exec(), make_email_file(), realtime_curl(), realtime_multi_curl(), store_curl(), and update_curl().
void ast_str_substitute_variables_full | ( | struct ast_str ** | buf, |
ssize_t | maxlen, | ||
struct ast_channel * | c, | ||
struct varshead * | headp, | ||
const char * | templ, | ||
size_t * | used | ||
) |
buf | Result will be placed in this buffer. |
maxlen | -1 if the buffer should not grow, 0 if the buffer may grow to any size, and >0 if the buffer should grow only to that number of bytes. |
c | Channel variables from which to extract values, and channel to pass to any dialplan functions. |
headp | If no channel is specified, a channel list from which to extract variable values |
templ | Variable template to expand. |
used | Number of bytes read from the template. (May be NULL) |
Definition at line 644 of file pbx_variables.c.
References ast_str_substitute_variables_full2().
Referenced by ast_str_substitute_variables(), and ast_str_substitute_variables_varshead().
void ast_str_substitute_variables_full2 | ( | struct ast_str ** | buf, |
ssize_t | maxlen, | ||
struct ast_channel * | c, | ||
struct varshead * | headp, | ||
const char * | templ, | ||
size_t * | used, | ||
int | use_both | ||
) |
Perform variable/function/expression substitution on an ast_str.
buf | Result will be placed in this buffer. |
maxlen | -1 if the buffer should not grow, 0 if the buffer may grow to any size, and >0 if the buffer should grow only to that number of bytes. |
c | A channel from which to extract values, and to pass to any dialplan functions. |
headp | A channel variables list to also search for variables. |
templ | Variable template to expand. |
used | Number of bytes read from the template. (May be NULL) |
use_both | Normally, if a channel is specified, headp is ignored. If this parameter is set to 1 and both a channel and headp are specified, the channel will be searched for variables first and any not found will be searched for in headp. |
Definition at line 400 of file pbx_variables.c.
References ast_channel_unref, ast_debug, ast_dummy_channel_alloc, ast_func_read2(), ast_str_append(), ast_str_append_substr(), ast_str_buffer(), ast_str_create, ast_str_expr(), ast_str_reset(), ast_str_retrieve_variable(), ast_str_set_substr(), ast_str_strlen(), parse_variable_name(), and S_OR.
Referenced by ast_str_substitute_variables_full().
void ast_str_substitute_variables_varshead | ( | struct ast_str ** | buf, |
ssize_t | maxlen, | ||
struct varshead * | headp, | ||
const char * | templ | ||
) |
buf | Result will be placed in this buffer. |
maxlen | -1 if the buffer should not grow, 0 if the buffer may grow to any size, and >0 if the buffer should grow only to that number of bytes. |
headp | If no channel is specified, a channel list from which to extract variable values |
templ | Variable template to expand. |
Definition at line 655 of file pbx_variables.c.
References ast_str_substitute_variables_full().
int ast_thread_inhibit_escalations | ( | void | ) |
Inhibit (in the current thread) the execution of dialplan functions which cause privilege escalations. If pbx_live_dangerously() has been called, this function has no effect.
Definition at line 479 of file pbx_functions.c.
References ast_threadstorage_get().
Referenced by ast_add_extension2_lockopt(), and handle_tcptls_connection().
int ast_thread_inhibit_escalations_swap | ( | int | inhibit | ) |
Swap the current thread escalation inhibit setting.
inhibit | New setting. Non-zero to inhibit. |
1 | if dangerous function execution was inhibited. |
0 | if dangerous function execution was allowed. |
-1 | on error. |
Definition at line 494 of file pbx_functions.c.
References ast_threadstorage_get().
Referenced by ast_add_extension2_lockopt().
int ast_unlock_context | ( | struct ast_context * | con | ) |
Unlocks | the given context |
con | context to unlock |
0 | on success |
-1 | on failure |
Definition at line 8491 of file pbx.c.
References ast_context::lock.
Referenced by ast_add_extension2_lockopt(), ast_context_add_include2(), ast_context_add_switch2(), ast_context_remove_include2(), ast_context_remove_switch2(), handle_cli_dialplan_save(), lookup_c_ip(), lookup_ci(), manager_show_dialplan_helper(), and parking_lot_cfg_create_extensions().
int ast_unlock_contexts | ( | void | ) |
Unlocks contexts.
0 | on success |
-1 | on failure |
Definition at line 8473 of file pbx.c.
References conlock.
Referenced by ast_add_extension(), ast_context_add_ignorepat(), ast_context_add_include(), ast_context_add_switch(), ast_context_destroy(), ast_context_destroy_by_name(), ast_context_find(), ast_context_find_or_create(), ast_context_remove_ignorepat(), ast_context_remove_include(), ast_context_remove_switch(), ast_get_extension_data(), ast_ignore_pattern(), ast_merge_contexts_and_delete(), ast_unregister_application(), complete_dialplan_add_extension(), find_context_locked(), handle_cli_dialplan_save(), manager_show_dialplan_helper(), parking_lot_cfg_create_extensions(), pbx_extension_helper(), and unreference_cached_app().
void ast_unregister_switch | ( | struct ast_switch * | sw | ) |
Unregister an alternative switch.
sw | switch to unregister |
Unregisters a switch from asterisk.
Definition at line 76 of file pbx_switch.c.
References AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.
Referenced by lua_find_extension().
int ast_wrlock_context | ( | struct ast_context * | con | ) |
Write locks a given context.
con | context to lock |
0 | on success |
-1 | on failure |
Definition at line 8481 of file pbx.c.
References ast_context::lock.
Referenced by ast_add_extension2_lockopt(), ast_context_add_include2(), ast_context_add_switch2(), ast_context_remove_include2(), ast_context_remove_switch2(), and parking_lot_cfg_create_extensions().
int ast_wrlock_contexts | ( | void | ) |
Write locks the context list.
0 | on success |
-1 | on error |
Definition at line 8463 of file pbx.c.
References conlock.
Referenced by ast_context_destroy(), ast_context_destroy_by_name(), ast_context_find_or_create(), ast_merge_contexts_and_delete(), and parking_lot_cfg_create_extensions().
const char* pbx_builtin_getvar_helper | ( | struct ast_channel * | chan, |
const char * | name | ||
) |
Return a pointer to the value of the corresponding channel variable.
Definition at line 1117 of file pbx_variables.c.
References AST_LIST_TRAVERSE.
Referenced by __ast_pbx_run(), agent_request_exec(), ast_bridge_call_with_flags(), ast_bridge_timelimit(), ast_bridge_transfer_attended(), ast_call_forward(), ast_channel_connected_line_sub(), ast_channel_redirecting_sub(), ast_unreal_hangup(), dial_exec_full(), do_forward(), feature_blind_transfer(), find_by_mark(), find_channel_parking_lot_name(), generic_fax_exec(), handle_call_forward(), iax2_exec(), leave_voicemail(), notify_new_message(), permit_dtmf_interrupt(), pjsip_acf_parse_uri_read(), queue_exec(), receive_ademco_event(), report_receive_fax_status(), report_send_fax_status(), run_agi(), sig_pri_call(), speech_background(), and wait_for_answer().
void pbx_builtin_pushvar_helper | ( | struct ast_channel * | chan, |
const char * | name, | ||
const char * | value | ||
) |
Add a variable to the channel variable stack, without removing any previously set value.
Definition at line 1155 of file pbx_variables.c.
References ast_func_write(), AST_LIST_INSERT_HEAD, and ast_strdupa.
Referenced by acf_odbc_write().
int pbx_builtin_serialize_variables | ( | struct ast_channel * | chan, |
struct ast_str ** | buf | ||
) |
Create a human-readable string, specifying all variables and their corresponding values.
chan | Channel from which to read variables |
buf | Dynamic string in which to place the result (should be allocated with ast_str_create). |
Definition at line 1086 of file pbx_variables.c.
References AST_LIST_TRAVERSE, ast_str_append(), and ast_str_reset().
int pbx_builtin_setvar | ( | struct ast_channel * | chan, |
const char * | data | ||
) |
Parse and set a single channel variable, where the name and value are separated with an '=' character.
Definition at line 1246 of file pbx_variables.c.
References ast_strdupa, and pbx_builtin_setvar_helper().
Referenced by load_pbx_variables().
int pbx_builtin_setvar_helper | ( | struct ast_channel * | chan, |
const char * | name, | ||
const char * | value | ||
) |
Add a variable to the channel variable stack, removing the most recently set value for the same name.
True if the old value was not an empty string.
Definition at line 1188 of file pbx_variables.c.
References ast_channel_publish_varset(), ast_func_write(), AST_LIST_INSERT_HEAD, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, and ast_strdupa.
Referenced by __ast_pbx_run(), acf_odbc_write(), admin_exec(), agent_login_exec(), agent_request_exec(), app_exec(), aqm_exec(), ast_ari_asterisk_set_global_var(), ast_bridge_set_transfer_variables(), ast_bridge_vars_set(), ast_call_forward(), ast_cc_agent_set_interfaces_chanvar(), ast_iax2_new(), ast_pbx_outgoing_exten_predial(), ast_pickup_call(), ast_rtp_instance_set_stats_vars(), ast_set_cc_interfaces_chanvar(), ast_set_variables(), ast_unreal_hangup(), attended_transfer_bridge(), audiosocket_request(), begin_dial_channel(), bridge_exec(), chan_pjsip_cng_tone_detected(), chan_pjsip_new(), confbridge_exec(), count_exec(), dial_exec_full(), dial_transfer(), do_forward(), dtmf_store_framehook(), fax_detect_framehook(), handle_response_cmgr(), leave_queue(), leave_voicemail(), lua_set_variable(), lua_set_variable_value(), minivm_accmess_exec(), pbx_builtin_setvar(), pbx_builtin_setvar_multiple(), pqm_exec(), queue_exec(), read_mf_digits(), read_sf_digits(), receivefax_exec(), record_abandoned(), ring_entry(), rqm_exec(), sendfax_exec(), set_channel_variables(), set_queue_result(), sla_calc_trunk_timeouts(), speech_create(), unicast_rtp_request(), update_qe_rule(), upqm_exec(), and wait_for_answer().
int pbx_builtin_setvar_multiple | ( | struct ast_channel * | chan, |
const char * | data | ||
) |
Parse and set multiple channel variables, where the pairs are separated by the ',' character, and name and value are separated with an '=' character.
Definition at line 1272 of file pbx_variables.c.
References AST_APP_ARG, AST_DECLARE_APP_ARGS, AST_NONSTANDARD_APP_ARGS, AST_STANDARD_APP_ARGS, ast_strdupa, and pbx_builtin_setvar_helper().
Referenced by load_pbx_variables(), queue_function_var(), and set_queue_variables().
int pbx_checkcondition | ( | const char * | condition | ) |
Evaluate a condition.
0 | if the condition is NULL or of zero length |
int | If the string is an integer, the integer representation of the integer is returned |
1 | Any other non-empty string |
int pbx_exec | ( | struct ast_channel * | c, |
struct ast_app * | app, | ||
const char * | data | ||
) |
Execute an application.
c | channel to execute on |
app | which app to execute |
data | the data passed into the app |
This application executes an application on a given channel. It saves the stack and executes the given application passing in the given data.
0 | success |
-1 | failure |
c | Channel |
app | Application |
data | Data for execution |
Definition at line 471 of file pbx_app.c.
References ast_channel_publish_snapshot(), and S_OR.
Referenced by ari_channel_thread(), ari_originate_dial(), ast_pbx_exec_application(), forward_message(), handle_exec(), iax2_exec(), lua_pbx_exec(), pbx_extension_helper(), and pbx_outgoing_exec().
struct ast_app * pbx_findapp | ( | const char * | app | ) |
Look up an application.
app | name of the app |
This function searches for the ast_app structure within the apps that are registered for the one with the name you passed in.
Definition at line 165 of file ael_main.c.
References AST_RWLIST_RDLOCK, and AST_RWLIST_UNLOCK.
Referenced by ari_channel_thread(), ari_originate_dial(), ast_pbx_exec_application(), forward_message(), handle_exec(), iax2_exec(), lua_pbx_exec(), pbx_extension_helper(), and pbx_outgoing_exec().
void pbx_live_dangerously | ( | int | new_live_dangerously | ) |
Enable/disable the execution of 'dangerous' functions from external protocols (AMI, etc.).
These dialplan functions (such as SHELL
) provide an opportunity for privilege escalation. They are okay to invoke from the dialplan, but external protocols with permission controls should not normally invoke them.
This function can globally enable/disable the execution of dangerous functions from external protocols.
new_live_dangerously | If true, enable the execution of escalating functions from external protocols. |
Definition at line 466 of file pbx_functions.c.
References live_dangerously.
int pbx_parse_location | ( | struct ast_channel * | chan, |
char ** | context, | ||
char ** | exten, | ||
char ** | pri, | ||
int * | ipri, | ||
int * | mode, | ||
char * | rest | ||
) |
Parses a dialplan location into context, extension, priority.
chan | Channel to execute on |
context | Pointer to initial value for context. |
exten | Pointer to initial value for exten. |
pri | Pointer to initial value for pri |
ipri | Pointer to integer value of priority |
mode | Pointer to mode (or NULL if mode is not used) |
rest | Pointer to buffer to capture rest of parsing (or NULL if not used) |
strsep should be used to initially populate context, exten, and pri prior to calling this function. All arguments are modified in place.
0 | success |
non-zero | failure |
Definition at line 8791 of file pbx.c.
References ast_findlabel_extension(), ast_channel::context, ast_channel::exten, and S_COR.
void pbx_retrieve_variable | ( | struct ast_channel * | c, |
const char * | var, | ||
char ** | ret, | ||
char * | workspace, | ||
int | workspacelen, | ||
struct varshead * | headp | ||
) |
Retrieve the value of a builtin variable or variable from the channel variable stack.
Retrieve the value of a builtin variable or variable from the channel variable stack.
Definition at line 239 of file pbx_variables.c.
References ast_copy_string(), ast_str_buffer(), ast_str_create, and ast_str_retrieve_variable().
Referenced by lua_get_variable(), lua_get_variable_value(), and pbx_substitute_variables_helper_full_location().
int pbx_set_autofallthrough | ( | int | newval | ) |
Set "autofallthrough" flag, if newval is <0, does not actually set. If set to 1, sets to auto fall through. If newval set to 0, sets to no auto fall through (reads extension instead). Returns previous value.
int pbx_set_extenpatternmatchnew | ( | int | newval | ) |
Set "extenpatternmatchnew" flag, if newval is <0, does not actually set. If set to 1, sets to use the new Trie-based pattern matcher. If newval set to 0, sets to use the old linear-search algorithm. Returns previous value.
void pbx_set_overrideswitch | ( | const char * | newval | ) |
Set "overrideswitch" field. If set and of nonzero length, all contexts will be tried directly through the named switch prior to any other matching within that context.
Definition at line 4784 of file pbx.c.
References ast_strdup.