res_mwi_external.h File Reference

Core external MWI support. More...

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

Go to the source code of this file.

Macros
#define	ast_mwi_mailbox_unref(mailbox)   ao2_ref((struct ast_mwi_mailbox_object *) mailbox, -1)
	Convenience unref function for mailbox object. More...

Functions
struct ast_mwi_mailbox_object *	ast_mwi_mailbox_alloc (const char *mailbox_id)
	Allocate an external MWI object. More...
struct ast_mwi_mailbox_object *	ast_mwi_mailbox_copy (const struct ast_mwi_mailbox_object *mailbox)
	Copy the external MWI counts object. More...
int	ast_mwi_mailbox_delete (const char *mailbox_id)
	Delete matching external MWI object. More...
int	ast_mwi_mailbox_delete_all (void)
	Delete all external MWI objects. More...
int	ast_mwi_mailbox_delete_by_regex (const char *regex)
	Delete all external MWI objects selected by the regular expression. More...
const struct ast_mwi_mailbox_object *	ast_mwi_mailbox_get (const char *mailbox_id)
	Get matching external MWI object. More...
struct ao2_container *	ast_mwi_mailbox_get_all (void)
	Get all external MWI objects. More...
struct ao2_container *	ast_mwi_mailbox_get_by_regex (const char *regex)
	Get all external MWI objects selected by the regular expression. More...
const char *	ast_mwi_mailbox_get_id (const struct ast_mwi_mailbox_object *mailbox)
	Get mailbox id. More...
unsigned int	ast_mwi_mailbox_get_msgs_new (const struct ast_mwi_mailbox_object *mailbox)
	Get the number of new messages. More...
unsigned int	ast_mwi_mailbox_get_msgs_old (const struct ast_mwi_mailbox_object *mailbox)
	Get the number of old messages. More...
void	ast_mwi_mailbox_set_msgs_new (struct ast_mwi_mailbox_object *mailbox, unsigned int num_msgs)
	Set the number of new messages. More...
void	ast_mwi_mailbox_set_msgs_old (struct ast_mwi_mailbox_object *mailbox, unsigned int num_msgs)
	Set the number of old messages. More...
int	ast_mwi_mailbox_update (struct ast_mwi_mailbox_object *mailbox)
	Update the external MWI counts with the given object. More...

Detailed Description

Core external MWI support.

Author

Richard Mudgett rmudg.nosp@m.ett@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

See Also:

• CREDITS

Definition in file res_mwi_external.h.

Macro Definition Documentation

ast_mwi_mailbox_unref

#define ast_mwi_mailbox_unref

(

mailbox

)

ao2_ref((struct ast_mwi_mailbox_object *) mailbox, -1)

Convenience unref function for mailbox object.

Definition at line 42 of file res_mwi_external.h.

Function Documentation

ast_mwi_mailbox_alloc()

struct ast_mwi_mailbox_object * ast_mwi_mailbox_alloc

(

const char *

mailbox_id

)

Allocate an external MWI object.

Since

12.1.0

Parameters

mailbox_id

Name of mailbox.

Returns

object on success. The object is an ao2 object.

Return values

NULL

on error.

Definition at line 192 of file res_mwi_external.c.

{
    if (ast_strlen_zero(mailbox_id)) {
        return NULL;
    }
 
    return ast_sorcery_alloc(mwi_sorcery, MWI_MAILBOX_TYPE, mailbox_id);
}

References ast_sorcery_alloc(), ast_strlen_zero(), MWI_MAILBOX_TYPE, mwi_sorcery, and NULL.

Referenced by mwi_mailbox_update(), and stasis_app_mailbox_update().

ast_mwi_mailbox_copy()

struct ast_mwi_mailbox_object * ast_mwi_mailbox_copy

(

const struct ast_mwi_mailbox_object *

mailbox

)

Copy the external MWI counts object.

Since

12.1.0

Parameters

mailbox

What to copy.

Returns

copy on success. The object is an ao2 object.

Return values

NULL

on error.

Definition at line 201 of file res_mwi_external.c.

{
    return ast_sorcery_copy(mwi_sorcery, mailbox);
}

References ast_sorcery_copy(), voicemailpwcheck::mailbox, and mwi_sorcery.

ast_mwi_mailbox_delete()

int ast_mwi_mailbox_delete

(

const char *

mailbox_id

)

Delete matching external MWI object.

Since

12.1.0

Parameters

mailbox_id

Name of mailbox to delete.

Return values

0	on success.
-1	on error.

Definition at line 302 of file res_mwi_external.c.

{
    const struct ast_mwi_mailbox_object *mailbox;
 
    if (ast_strlen_zero(mailbox_id)) {
        return -1;
    }
 
    mailbox = ast_mwi_mailbox_get(mailbox_id);
    if (mailbox) {
        mwi_mailbox_delete((struct ast_mwi_mailbox_object *) mailbox);
        ast_mwi_mailbox_unref(mailbox);
    }
    return 0;
}

References ast_mwi_mailbox_get(), ast_mwi_mailbox_unref, ast_strlen_zero(), voicemailpwcheck::mailbox, and mwi_mailbox_delete().

Referenced by mwi_mailbox_delete(), and stasis_app_mailbox_delete().

ast_mwi_mailbox_delete_all()

int ast_mwi_mailbox_delete_all

(

void

)

Delete all external MWI objects.

Since

12.1.0

Return values

0	on success.
-1	on error.

Definition at line 278 of file res_mwi_external.c.

{
    struct ao2_container *mailboxes;
 
    mailboxes = ast_mwi_mailbox_get_all();
    if (mailboxes) {
        mwi_mailbox_delete_all(mailboxes);
        ao2_ref(mailboxes, -1);
    }
    return 0;
}

References ao2_ref, ast_mwi_mailbox_get_all(), mailboxes, and mwi_mailbox_delete_all().

ast_mwi_mailbox_delete_by_regex()

int ast_mwi_mailbox_delete_by_regex

(

const char *

regex

)

Delete all external MWI objects selected by the regular expression.

Since

12.1.0

Parameters

regex

Regular expression in extended syntax. (NULL is same as "")

Note

The provided regex is treated as extended case sensitive.

Return values

0	on success.
-1	on error.

Definition at line 290 of file res_mwi_external.c.

{
    struct ao2_container *mailboxes;
 
    mailboxes = ast_mwi_mailbox_get_by_regex(regex);
    if (mailboxes) {
        mwi_mailbox_delete_all(mailboxes);
        ao2_ref(mailboxes, -1);
    }
    return 0;
}

References ao2_ref, ast_mwi_mailbox_get_by_regex(), mailboxes, mwi_mailbox_delete_all(), and regex().

Referenced by mwi_mailbox_delete().

ast_mwi_mailbox_get()

const struct ast_mwi_mailbox_object * ast_mwi_mailbox_get

(

const char *

mailbox_id

)

Get matching external MWI object.

Since

12.1.0

Parameters

mailbox_id

Name of mailbox to retrieve.

Returns

requested mailbox on success. The object is an ao2 object.

Return values

NULL	on error or no mailbox.

Note

The object must be treated as read-only.

Definition at line 183 of file res_mwi_external.c.

{
    if (ast_strlen_zero(mailbox_id)) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(mwi_sorcery, MWI_MAILBOX_TYPE, mailbox_id);
}

References ast_sorcery_retrieve_by_id(), ast_strlen_zero(), MWI_MAILBOX_TYPE, mwi_sorcery, and NULL.

Referenced by ast_mwi_mailbox_delete(), mwi_has_voicemail(), mwi_inboxcount(), mwi_mailbox_get(), mwi_messagecount(), stasis_app_mailbox_delete(), and stasis_app_mailbox_to_json().

ast_mwi_mailbox_get_all()

struct ao2_container * ast_mwi_mailbox_get_all

(

void

)

Get all external MWI objects.

Since

12.1.0

Returns

container of struct ast_mwi_mailbox_object on success.

Return values

NULL

on error.

Note

The objects in the container must be treated as read-only.

Definition at line 172 of file res_mwi_external.c.

{
    return ast_sorcery_retrieve_by_fields(mwi_sorcery, MWI_MAILBOX_TYPE,
        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
}

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), MWI_MAILBOX_TYPE, mwi_sorcery, and NULL.

Referenced by ast_mwi_mailbox_delete_all(), mwi_initial_events(), and stasis_app_mailboxes_to_json().

ast_mwi_mailbox_get_by_regex()

struct ao2_container * ast_mwi_mailbox_get_by_regex

(

const char *

regex

)

Get all external MWI objects selected by the regular expression.

Since

12.1.0

Parameters

regex

Regular expression in extended syntax. (NULL is same as "")

Note

The provided regex is treated as extended case sensitive.

Returns

container of struct ast_mwi_mailbox_object on success.

Return values

NULL

on error.

Note

The objects in the container must be treated as read-only.

Definition at line 178 of file res_mwi_external.c.

{
    return ast_sorcery_retrieve_by_regex(mwi_sorcery, MWI_MAILBOX_TYPE, regex ?: "");
}

References ast_sorcery_retrieve_by_regex(), MWI_MAILBOX_TYPE, mwi_sorcery, and regex().

Referenced by ast_mwi_mailbox_delete_by_regex(), and mwi_mailbox_get().

ast_mwi_mailbox_get_id()

const char * ast_mwi_mailbox_get_id

(

const struct ast_mwi_mailbox_object *

mailbox

)

Get mailbox id.

Since

12.1.0

Parameters

mailbox

Object to get id.

Returns

mailbox_id of the object.

Note

This should never return NULL unless there is a bug in sorcery.

Definition at line 206 of file res_mwi_external.c.

{
    return ast_sorcery_object_get_id(mailbox);
}

References ast_sorcery_object_get_id(), and voicemailpwcheck::mailbox.

Referenced by mailbox_to_json(), and mwi_mailbox_get().

ast_mwi_mailbox_get_msgs_new()

unsigned int ast_mwi_mailbox_get_msgs_new

(

const struct ast_mwi_mailbox_object *

mailbox

)

Get the number of new messages.

Since

12.1.0

Parameters

mailbox

Object to get number of new messages.

Returns

Number of new messages.

Definition at line 211 of file res_mwi_external.c.

{
    return mailbox->msgs_new;
}

References voicemailpwcheck::mailbox.

Referenced by mailbox_to_json(), and mwi_mailbox_get().

ast_mwi_mailbox_get_msgs_old()

unsigned int ast_mwi_mailbox_get_msgs_old

(

const struct ast_mwi_mailbox_object *

mailbox

)

Get the number of old messages.

Since

12.1.0

Parameters

mailbox

Object to get number of old messages.

Returns

Number of old messages.

Definition at line 216 of file res_mwi_external.c.

{
    return mailbox->msgs_old;
}

References voicemailpwcheck::mailbox.

Referenced by mailbox_to_json(), and mwi_mailbox_get().

ast_mwi_mailbox_set_msgs_new()

void ast_mwi_mailbox_set_msgs_new	(	struct ast_mwi_mailbox_object *	mailbox,
		unsigned int	num_msgs
	)

Set the number of new messages.

Since

12.1.0

Parameters

mailbox	Object to set number of new messages.
num_msgs	Number of messages to set.

Definition at line 221 of file res_mwi_external.c.

{
    mailbox->msgs_new = num_msgs;
}

References voicemailpwcheck::mailbox.

Referenced by mwi_mailbox_update(), and stasis_app_mailbox_update().

ast_mwi_mailbox_set_msgs_old()

void ast_mwi_mailbox_set_msgs_old	(	struct ast_mwi_mailbox_object *	mailbox,
		unsigned int	num_msgs
	)

Set the number of old messages.

Since

12.1.0

Parameters

mailbox	Object to set number of old messages.
num_msgs	Number of messages to set.

Definition at line 226 of file res_mwi_external.c.

{
    mailbox->msgs_old = num_msgs;
}

References voicemailpwcheck::mailbox.

Referenced by mwi_mailbox_update(), and stasis_app_mailbox_update().

ast_mwi_mailbox_update()

int ast_mwi_mailbox_update

(

struct ast_mwi_mailbox_object *

mailbox

)

Update the external MWI counts with the given object.

Since

12.1.0

Parameters

mailbox

What to update.

Return values

0	on success.
-1	on error.

Definition at line 231 of file res_mwi_external.c.

{
    const struct ast_mwi_mailbox_object *exists;
    int res;
 
    exists = ast_sorcery_retrieve_by_id(mwi_sorcery, MWI_MAILBOX_TYPE,
        ast_sorcery_object_get_id(mailbox));
    if (exists) {
        res = ast_sorcery_update(mwi_sorcery, mailbox);
        ast_mwi_mailbox_unref(exists);
    } else {
        res = ast_sorcery_create(mwi_sorcery, mailbox);
    }
    return res;
}

References ast_mwi_mailbox_unref, ast_sorcery_create(), ast_sorcery_object_get_id(), ast_sorcery_retrieve_by_id(), ast_sorcery_update(), exists(), voicemailpwcheck::mailbox, MWI_MAILBOX_TYPE, and mwi_sorcery.

Referenced by mwi_mailbox_update(), and stasis_app_mailbox_update().