pbx_private.h File Reference

Private include file for pbx. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	VAR_BUF_SIZE   4096

Functions
const char *	app_name (struct ast_app *app)
	AST_VECTOR (ast_ignorepats, struct ast_ignorepat *)
	AST_VECTOR (ast_includes, struct ast_include *)
	AST_VECTOR (ast_sws, struct ast_sw *)
struct ast_ignorepat *	ignorepat_alloc (const char *value, const char *registrar)
void	ignorepat_free (struct ast_ignorepat *ip)
struct ast_include *	include_alloc (const char *value, const char *registrar)
void	include_free (struct ast_include *inc)
const char *	include_rname (const struct ast_include *inc)
int	include_valid (const struct ast_include *inc)
int	indicate_busy (struct ast_channel *, const char *)
int	indicate_congestion (struct ast_channel *, const char *)
void	pbx_extension_state_autohint_remove (struct ast_context *context, unsigned int forced)
void	pbx_extension_state_autohint_set (struct ast_context *context)
void	pbx_extension_state_hint_remove (struct ast_exten *exten, struct ast_context *context)
void	pbx_extension_state_hint_set (struct ast_exten *exten, struct ast_context *context)
struct ast_switch *	pbx_findswitch (const char *sw)
int	raise_exception (struct ast_channel *chan, const char *reason, int priority)
void	set_ext_pri (struct ast_channel *c, const char *exten, int pri)
struct ast_sw *	sw_alloc (const char *value, const char *data, int eval, const char *registrar)
void	sw_free (struct ast_sw *sw)
void	unreference_cached_app (struct ast_app *app)
void	wait_for_hangup (struct ast_channel *chan, const void *data)

Detailed Description

Private include file for pbx.

Definition in file pbx_private.h.

Macro Definition Documentation

VAR_BUF_SIZE

#define VAR_BUF_SIZE   4096

Definition at line 76 of file pbx_private.h.

Function Documentation

app_name()

const char * app_name

(

struct ast_app *

app

)

pbx_app.c functions needed by pbx.c

Definition at line 475 of file pbx_app.c.

{
    return app->name;
}

References app.

Referenced by __stasis_app_register(), app_exec(), app_handle_subscriptions(), app_subscribe(), app_unsubscribe(), application_tuple_alloc(), ari_conf_get_owc_for_app(), ari_websocket_process_request(), ari_websocket_send_event(), ast_ari_callback(), ast_ari_close_per_call_websocket(), ast_ari_create_per_call_websocket(), ast_bridge_channel_queue_app(), ast_bridge_channel_run_app(), ast_bridge_channel_write_app(), ast_json_dialplan_cep_app(), ast_pbx_exec_application(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), bridge_stasis_run_cb(), device_state_subscription_create(), device_to_json_cb(), dynamic_dtmf_hook_add(), find_app_by_name(), handle_exec(), is_app_subscribed(), lua_pbx_exec(), lua_pbx_findapp(), messaging_app_subscribe_endpoint(), messaging_app_unsubscribe_endpoint(), payload_helper_app(), pbx_extension_helper(), run_app_helper(), send_broadcast_event(), send_rest_response(), session_find_by_app(), session_register_apps(), session_send_app_event(), session_send_or_queue(), session_unregister_app_cb(), stasis_app_claim_channel(), stasis_app_control_move(), stasis_app_event_allowed(), stasis_app_exec(), stasis_app_get_debug_by_name(), stasis_app_message_handler(), stasis_app_register(), stasis_app_register_all(), stasis_app_send(), stasis_app_set_debug_by_name(), stasis_app_set_global_debug(), stasis_app_subscribe(), stasis_app_subscribe_channel(), stasis_app_to_json(), stasis_app_unregister(), stasis_app_unsubscribe(), and stasis_app_user_event().

AST_VECTOR() [1/3]

AST_VECTOR	(	ast_ignorepats	,
		struct ast_ignorepat *
	)

AST_VECTOR() [2/3]

AST_VECTOR	(	ast_includes	,
		struct ast_include *
	)

AST_VECTOR() [3/3]

AST_VECTOR	(	ast_sws	,
		struct ast_sw *
	)

ignorepat_alloc()

struct ast_ignorepat * ignorepat_alloc	(	const char *	value,
		const char *	registrar
	)

Definition at line 52 of file pbx_ignorepat.c.

{
    struct ast_ignorepat *ignorepat;
    int length = strlen(value) + 1;
    char *pattern;
 
    /* allocate new include structure ... */
    ignorepat = ast_calloc(1, sizeof(*ignorepat) + length);
    if (!ignorepat) {
        return NULL;
    }
 
    /* The cast to char * is because we need to write the initial value.
     * The field is not supposed to be modified otherwise.  Also, gcc 4.2
     * sees the cast as dereferencing a type-punned pointer and warns about
     * it.  This is the workaround (we're telling gcc, yes, that's really
     * what we wanted to do).
     */
    pattern = (char *) ignorepat->pattern;
    strcpy(pattern, value);
    ignorepat->registrar = registrar;
 
    return ignorepat;
}

References ast_calloc, NULL, ast_ignorepat::pattern, registrar, ast_ignorepat::registrar, and value.

Referenced by ast_context_add_ignorepat2().

ignorepat_free()

void ignorepat_free

(

struct ast_ignorepat *

ip

)

Definition at line 77 of file pbx_ignorepat.c.

{
    ast_free(ip);
}

References ast_free.

Referenced by __ast_context_destroy(), __ast_internal_context_destroy(), ast_context_add_ignorepat2(), and ast_context_remove_ignorepat2().

include_alloc()

struct ast_include * include_alloc	(	const char *	value,
		const char *	registrar
	)

Allocate and initialize an ast_include.

Definition at line 74 of file pbx_include.c.

{
    struct ast_include *new_include;
    char *c;
    int valuebufsz = strlen(value) + 1;
    char *p;
 
    /* allocate new include structure ... */
    new_include = ast_calloc(1, sizeof(*new_include) + (valuebufsz * 2));
    if (!new_include) {
        return NULL;
    }
 
    /* Fill in this structure. Use 'p' for assignments, as the fields
     * in the structure are 'const char *'
     */
    p = new_include->stuff;
    new_include->name = p;
    strcpy(p, value);
    p += valuebufsz;
    new_include->rname = p;
    strcpy(p, value);
    /* Strip off timing info, and process if it is there */
    if ( (c = strchr(p, '|')) || (c = strchr(p, ',')) ) {
        *c++ = '\0';
        new_include->hastime = ast_build_timing(&(new_include->timing), c);
    }
    new_include->registrar = registrar;
 
    return new_include;
}

References ast_build_timing(), ast_calloc, c, ast_include::hastime, ast_include::name, NULL, registrar, ast_include::registrar, ast_include::rname, ast_include::stuff, ast_include::timing, and value.

Referenced by ast_context_add_include2().

include_free()

void include_free

(

struct ast_include *

inc

)

Free an ast_include and associated data.

Definition at line 106 of file pbx_include.c.

{
    ast_destroy_timing(&(inc->timing));
    ast_free(inc);
}

References ast_destroy_timing(), ast_free, and ast_include::timing.

Referenced by __ast_context_destroy(), __ast_internal_context_destroy(), ast_context_add_include2(), and ast_context_remove_include2().

include_rname()

const char * include_rname

(

const struct ast_include *

inc

)

Definition at line 55 of file pbx_include.c.

{
    return inc ? inc->rname : NULL;
}

References NULL, and ast_include::rname.

Referenced by ast_context_verify_includes(), and pbx_find_extension().

include_valid()

int include_valid

(

const struct ast_include *

inc

)

Definition at line 65 of file pbx_include.c.

{
    if (!inc->hastime) {
        return 1;
    }
 
    return ast_check_timing(&(inc->timing));
}

References ast_check_timing(), ast_include::hastime, and ast_include::timing.

Referenced by pbx_find_extension().

pbx_extension_state_autohint_remove()

void pbx_extension_state_autohint_remove	(	struct ast_context *	context,
		unsigned int	forced
	)

Definition at line 133 of file extension_state_autohints.c.

{
    int removed;
 
    ast_wrlock_contexts();
 
    ast_mutex_lock(&extension_state_autohints_lock);
    if (!forced) {
        removed = AST_VECTOR_REMOVE_CMP_UNORDERED(&extension_state_autohints, context, AST_VECTOR_ELEM_DEFAULT_CMP,
            AST_VECTOR_ELEM_CLEANUP_NOOP);
    } else {
        removed = AST_VECTOR_REMOVE_CMP_UNORDERED(&extension_state_autohints, ast_get_context_name(context), AUTOHINT_CMP_CONTEXT_NAME,
            AST_VECTOR_ELEM_CLEANUP_NOOP);
    }
    if (removed) {
        ast_context_destroy_by_name(ast_get_context_name(context), registrar);
    }
    if (!AST_VECTOR_SIZE(&extension_state_autohints) && autohints_subscription) {
        /* There's no more autohint enabled contexts, so unsubscribe */
        autohints_subscription = stasis_unsubscribe(autohints_subscription);
    }
    ast_mutex_unlock(&extension_state_autohints_lock);
 
    ast_unlock_contexts();
}

References ast_context_destroy_by_name(), ast_get_context_name(), ast_mutex_lock, ast_mutex_unlock, ast_unlock_contexts(), AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_ELEM_DEFAULT_CMP, AST_VECTOR_REMOVE_CMP_UNORDERED, AST_VECTOR_SIZE, ast_wrlock_contexts(), AUTOHINT_CMP_CONTEXT_NAME, autohints_subscription, extension_state_autohints, extension_state_autohints_lock, registrar, and stasis_unsubscribe().

Referenced by __ast_internal_context_destroy(), ast_context_set_autohints(), and context_promote().

pbx_extension_state_autohint_set()

void pbx_extension_state_autohint_set

(

struct ast_context *

context

)

extension_state_autohints.c functions needed by pbx.c

Definition at line 113 of file extension_state_autohints.c.

{
    ast_rdlock_contexts();
 
    ast_mutex_lock(&extension_state_autohints_lock);
 
    /* Since we store a pointer to the context we remove the old one by name and append the new one, easy */
    AST_VECTOR_REMOVE_CMP_UNORDERED(&extension_state_autohints, ast_get_context_name(context), AUTOHINT_CMP_CONTEXT_NAME,
        AST_VECTOR_ELEM_CLEANUP_NOOP);
    AST_VECTOR_APPEND(&extension_state_autohints, context);
 
    if (AST_VECTOR_SIZE(&extension_state_autohints) && !autohints_subscription) {
        /* We have at least one context enabled with autohints and no subscription, so subscribe */
        autohints_subscription = stasis_subscribe(ast_device_state_topic_all(), extension_state_autohints_device_state_cb, NULL);
    }
    ast_mutex_unlock(&extension_state_autohints_lock);
 
    ast_unlock_contexts();
}

References ast_device_state_topic_all(), ast_get_context_name(), ast_mutex_lock, ast_mutex_unlock, ast_rdlock_contexts(), ast_unlock_contexts(), AST_VECTOR_APPEND, AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_REMOVE_CMP_UNORDERED, AST_VECTOR_SIZE, AUTOHINT_CMP_CONTEXT_NAME, autohints_subscription, extension_state_autohints, extension_state_autohints_device_state_cb(), extension_state_autohints_lock, NULL, and stasis_subscribe.

Referenced by ast_context_set_autohints(), context_merge(), and context_promote().

pbx_extension_state_hint_remove()

void pbx_extension_state_hint_remove	(	struct ast_exten *	exten,
		struct ast_context *	context
	)

Definition at line 1269 of file extension_state.c.

{
    char extension[AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2];
    struct extension_state *state;
 
    snprintf(extension, sizeof(extension), "%s@%s", ast_get_extension_name(exten), ast_get_context_name(context));
 
    ao2_lock(extension_states);
 
    state = ao2_find(extension_states, extension, OBJ_SEARCH_KEY | OBJ_NOLOCK);
 
    /* If this is not the latest hint extension that configured this extension state it can't remove it */
    if (!state || state->hint_extension != exten) {
        ao2_unlock(extension_states);
        ao2_cleanup(state);
        return;
    }
 
    extension_state_shutdown(state);
    ao2_unlink_flags(extension_states, state, OBJ_NOLOCK);
    ao2_ref(state, -1);
 
    ao2_unlock(extension_states);
}

References ao2_cleanup, ao2_find, ao2_lock, ao2_ref, ao2_unlink_flags, ao2_unlock, ast_get_context_name(), ast_get_extension_name(), AST_MAX_CONTEXT, AST_MAX_EXTENSION, extension_state_shutdown(), extension_states, OBJ_NOLOCK, and OBJ_SEARCH_KEY.

Referenced by ast_change_hint(), and ast_remove_hint().

pbx_extension_state_hint_set()

void pbx_extension_state_hint_set	(	struct ast_exten *	exten,
		struct ast_context *	context
	)

extension_state.c functions needed by pbx.c

Definition at line 1239 of file extension_state.c.

{
    char extension[AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2];
    struct extension_state *state;
 
    snprintf(extension, sizeof(extension), "%s@%s", ast_get_extension_name(exten), ast_get_context_name(context));
 
    ao2_lock(extension_states);
 
    state = ao2_find(extension_states, extension, OBJ_SEARCH_KEY | OBJ_NOLOCK);
    if (!state) {
        state = extension_state_alloc(exten, context);
        if (!state) {
            ast_log(LOG_WARNING, "Could not create extension state for hint '%s', it will be unavailable\n",
                extension);
            ao2_unlock(extension_states);
            return;
        }
        ao2_link_flags(extension_states, state, OBJ_NOLOCK);
    }
 
    state->hint_extension = exten;
    if (extension[0] != '_') {
        extension_state_update_sources(state, exten);
    }
    ao2_ref(state, -1);
 
    ao2_unlock(extension_states);
}

References ao2_find, ao2_link_flags, ao2_lock, ao2_ref, ao2_unlock, ast_get_context_name(), ast_get_extension_name(), ast_log, AST_MAX_CONTEXT, AST_MAX_EXTENSION, extension_state_alloc(), extension_state_update_sources(), extension_states, LOG_WARNING, OBJ_NOLOCK, and OBJ_SEARCH_KEY.

Referenced by ast_add_hint(), ast_change_hint(), and context_promote().

pbx_findswitch()

struct ast_switch * pbx_findswitch

(

const char *

sw

)

pbx_switch.c functions needed by pbx.c

Definition at line 40 of file pbx_switch.c.

{
    struct ast_switch *asw;
 
    AST_RWLIST_RDLOCK(&switches);
    AST_RWLIST_TRAVERSE(&switches, asw, list) {
        if (!strcasecmp(asw->name, sw))
            break;
    }
    AST_RWLIST_UNLOCK(&switches);
 
    return asw;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_switch::list, and ast_switch::name.

Referenced by pbx_find_extension(), and pbx_find_extension().

raise_exception()

int raise_exception	(	struct ast_channel *	chan,
		const char *	reason,
		int	priority
	)

pbx.c functions needed by pbx_builtins.c

Definition at line 2432 of file pbx.c.

{
    struct ast_datastore *ds;
    struct pbx_exception *exception;
 
    ast_channel_lock(chan);
    ds = ast_channel_datastore_find(chan, &exception_store_info, NULL);
    if (!ds) {
        ds = ast_datastore_alloc(&exception_store_info, NULL);
        if (!ds) {
            ast_channel_unlock(chan);
            return -1;
        }
        if (!(exception = ast_calloc_with_stringfields(1, struct pbx_exception, 128))) {
            ast_datastore_free(ds);
            ast_channel_unlock(chan);
            return -1;
        }
        ds->data = exception;
        ast_channel_datastore_add(chan, ds);
    } else
        exception = ds->data;
 
    ast_string_field_set(exception, reason, reason);
    ast_string_field_set(exception, context, ast_channel_context(chan));
    ast_string_field_set(exception, exten, ast_channel_exten(chan));
    exception->priority = ast_channel_priority(chan);
    ast_channel_unlock(chan);
 
    set_ext_pri(chan, "e", priority);
    return 0;
}

References ast_calloc_with_stringfields, ast_channel_context(), ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_exten(), ast_channel_lock, ast_channel_priority(), ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), ast_string_field_set, pbx_exception::context, ast_datastore::data, exception_store_info, pbx_exception::exten, NULL, priority, pbx_exception::priority, pbx_exception::reason, and set_ext_pri().

Referenced by __ast_pbx_run(), pbx_builtin_raise_exception(), and pbx_builtin_waitexten().

set_ext_pri()

void set_ext_pri	(	struct ast_channel *	c,
		const char *	exten,
		int	pri
	)

helper function to set extension and priority

Definition at line 2824 of file pbx.c.

{
    ast_channel_lock(c);
    ast_channel_exten_set(c, exten);
    ast_channel_priority_set(c, pri);
    ast_channel_unlock(c);
}

References ast_channel_exten_set(), ast_channel_lock, ast_channel_priority_set(), ast_channel_unlock, c, and ast_exten::exten.

Referenced by __ast_pbx_run(), pbx_builtin_waitexten(), and raise_exception().

sw_alloc()

struct ast_sw * sw_alloc	(	const char *	value,
		const char *	data,
		int	eval,
		const char *	registrar
	)

Definition at line 68 of file pbx_sw.c.

{
    struct ast_sw *new_sw;
    int length;
    char *p;
 
    if (!data) {
        data = "";
    }
    length = sizeof(struct ast_sw);
    length += strlen(value) + 1;
    length += strlen(data) + 1;
 
    /* allocate new sw structure ... */
    if (!(new_sw = ast_calloc(1, length))) {
        return NULL;
    }
 
    /* ... fill in this structure ... */
    p = new_sw->stuff;
    new_sw->name = p;
    strcpy(p, value);
 
    p += strlen(value) + 1;
    new_sw->data = p;
    strcpy(p, data);
 
    new_sw->eval      = eval;
    new_sw->registrar = registrar;
 
    return new_sw;
}

References ast_calloc, ast_sw::data, ast_sw::eval, ast_sw::name, NULL, registrar, ast_sw::registrar, ast_sw::stuff, and value.

Referenced by ast_context_add_switch2().

sw_free()

void sw_free

(

struct ast_sw *

sw

)

Definition at line 101 of file pbx_sw.c.

{
    ast_free(sw);
}

References ast_free.

Referenced by __ast_context_destroy(), __ast_internal_context_destroy(), ast_context_add_switch2(), and ast_context_remove_switch2().

unreference_cached_app()

void unreference_cached_app

(

struct ast_app *

app

)

pbx.c function needed by pbx_app.c

Definition at line 4523 of file pbx.c.

{
    struct ast_context *context = NULL;
    struct ast_exten *eroot = NULL, *e = NULL;
 
    ast_rdlock_contexts();
    while ((context = ast_walk_contexts(context))) {
        while ((eroot = ast_walk_context_extensions(context, eroot))) {
            while ((e = ast_walk_extension_priorities(eroot, e))) {
                if (e->cached_app == app)
                    e->cached_app = NULL;
            }
        }
    }
    ast_unlock_contexts();
 
    return;
}

References app, ast_rdlock_contexts(), ast_unlock_contexts(), ast_walk_context_extensions(), ast_walk_contexts(), ast_walk_extension_priorities(), and NULL.

Referenced by ast_unregister_application().

wait_for_hangup()

void wait_for_hangup	(	struct ast_channel *	chan,
		const void *	data
	)

Definition at line 6514 of file pbx.c.

{
    int res;
    struct ast_frame *f;
    double waitsec;
    int waittime;
 
    if (ast_strlen_zero(data) || (sscanf(data, "%30lg", &waitsec) != 1) || (waitsec < 0))
        waitsec = -1;
    if (waitsec > -1) {
        waittime = waitsec * 1000.0;
        ast_safe_sleep_without_silence(chan, waittime);
    } else do {
        res = ast_waitfor(chan, -1);
        if (res < 0)
            return;
        f = ast_read(chan);
        if (f)
            ast_frfree(f);
    } while(f);
}

References ast_frfree, ast_read(), ast_safe_sleep_without_silence(), ast_strlen_zero(), ast_waitfor(), and ast_frame::data.

Referenced by indicate_busy(), and indicate_congestion().