[asterisk-commits] file: branch file/res_sip_registrar_expire r390436 - /team/file/res_sip_regis...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Tue Jun 4 16:58:34 CDT 2013
Author: file
Date: Tue Jun 4 16:58:32 2013
New Revision: 390436
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=390436
Log:
Add a module which observes contacts and automatically expires/deletes them when they should expire.
Added:
team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c (with props)
Added: team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c
URL: http://svnview.digium.com/svn/asterisk/team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c?view=auto&rev=390436
==============================================================================
--- team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c (added)
+++ team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c Tue Jun 4 16:58:32 2013
@@ -1,0 +1,219 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013, Digium, Inc.
+ *
+ * Joshua Colp <jcolp at digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*** MODULEINFO
+ <depend>pjproject</depend>
+ <depend>res_sip</depend>
+ <support_level>core</support_level>
+ ***/
+
+#include "asterisk.h"
+
+#include <pjsip.h>
+
+#include "asterisk/res_sip.h"
+#include "asterisk/module.h"
+#include "asterisk/sched.h"
+
+#define CONTACT_AUTOEXPIRE_BUCKETS 977
+
+static struct ao2_container *contact_autoexpire;
+
+/*! \brief Scheduler used for automatically expiring contacts */
+static struct ast_sched_context *sched;
+
+/*! \brief Structure used for contact auto-expiration */
+struct contact_expiration {
+ /*! \brief Contact that is being auto-expired */
+ struct ast_sip_contact *contact;
+
+ /*! \brief Scheduled item for performing expiration */
+ int sched;
+};
+
+/*! \brief Destructor function for contact auto-expiration */
+static void contact_expiration_destroy(void *obj)
+{
+ struct contact_expiration *expiration = obj;
+
+ ao2_cleanup(expiration->contact);
+}
+
+/*! \brief Hashing function for contact auto-expiration */
+static int contact_expiration_hash(const void *obj, const int flags)
+{
+ const struct contact_expiration *expiration = obj;
+ const char *id = obj;
+
+ return ast_str_hash(flags & OBJ_KEY ? id : ast_sorcery_object_get_id(expiration->contact));
+}
+
+/*! \brief Comparison function for contact auto-expiration */
+static int contact_expiration_cmp(void *obj, void *arg, int flags)
+{
+ struct contact_expiration *expiration1 = obj, *expiration2 = arg;
+ const char *id = arg;
+
+ return !strcmp(ast_sorcery_object_get_id(expiration1->contact), flags & OBJ_KEY ? id : ast_sorcery_object_get_id(expiration2)) ? CMP_MATCH | CMP_STOP : 0;
+}
+
+/*! \brief Scheduler function which deletes a contact */
+static int contact_expiration_expire(const void *data)
+{
+ RAII_VAR(struct contact_expiration *, expiration, (void*)data, ao2_cleanup);
+
+ expiration->sched = -1;
+
+ /* This will end up invoking the deleted observer callback, which will perform the unlinking and such */
+ ast_sorcery_delete(ast_sip_get_sorcery(), expiration->contact);
+
+ return 0;
+}
+
+/*! \brief Observer callback for when a contact is created */
+static void contact_expiration_observer_created(const void *object)
+{
+ const struct ast_sip_contact *contact = object;
+ RAII_VAR(struct contact_expiration *, expiration, NULL, ao2_cleanup);
+ int expires = MAX(0, ast_tvdiff_ms(contact->expiration_time, ast_tvnow()));
+
+ if (!(expiration = ao2_alloc_options(sizeof(*expiration), contact_expiration_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK))) {
+ return;
+ }
+
+ expiration->contact = (struct ast_sip_contact*)contact;
+ ao2_ref(expiration->contact, +1);
+
+ ao2_ref(expiration, +1);
+ if ((expiration->sched = ast_sched_add(sched, expires, contact_expiration_expire, expiration)) < 0) {
+ ao2_cleanup(expiration);
+ }
+
+ ao2_link(contact_autoexpire, expiration);
+}
+
+/*! \brief Observer callback for when a contact is updated */
+static void contact_expiration_observer_updated(const void *object)
+{
+ const struct ast_sip_contact *contact = object;
+ RAII_VAR(struct contact_expiration *, expiration, ao2_find(contact_autoexpire, ast_sorcery_object_get_id(contact), OBJ_KEY), ao2_cleanup);
+ int expires = MAX(0, ast_tvdiff_ms(contact->expiration_time, ast_tvnow()));
+
+ if (!expiration) {
+ return;
+ }
+
+ AST_SCHED_REPLACE_UNREF(expiration->sched, sched, expires, contact_expiration_expire, expiration, ao2_cleanup(expiration), NULL, ao2_ref(expiration, +1));
+}
+
+/*! \brief Observer callback for when a contact is deleted */
+static void contact_expiration_observer_deleted(const void *object)
+{
+ RAII_VAR(struct contact_expiration *, expiration, ao2_find(contact_autoexpire, ast_sorcery_object_get_id(object), OBJ_KEY | OBJ_UNLINK), ao2_cleanup);
+
+ if (!expiration) {
+ return;
+ }
+
+ AST_SCHED_DEL_UNREF(sched, expiration->sched, ao2_cleanup(expiration));
+}
+
+/*! \brief Observer callbacks for autoexpiring contacts */
+static struct ast_sorcery_observer contact_expiration_observer = {
+ .created = contact_expiration_observer_created,
+ .updated = contact_expiration_observer_updated,
+ .deleted = contact_expiration_observer_deleted,
+};
+
+/*! \brief Callback function which deletes a contact if it has expired or sets up auto-expiry */
+static int contact_expiration_setup(void *obj, void *arg, int flags)
+{
+ struct ast_sip_contact *contact = obj;
+ int expires = MAX(0, ast_tvdiff_ms(contact->expiration_time, ast_tvnow()));
+
+ if (!expires) {
+ ast_sorcery_delete(ast_sip_get_sorcery(), contact);
+ } else {
+ contact_expiration_observer_created(contact);
+ }
+
+ return 0;
+}
+
+/*! \brief Initialize auto-expiration of any existing contacts */
+static void contact_expiration_initialize_existing(void)
+{
+ RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
+
+ if (!(contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL))) {
+ return;
+ }
+
+ ao2_callback(contacts, OBJ_NODATA, contact_expiration_setup, NULL);
+}
+
+static int load_module(void)
+{
+ if (!(contact_autoexpire = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, CONTACT_AUTOEXPIRE_BUCKETS,
+ contact_expiration_hash, contact_expiration_cmp))) {
+ ast_log(LOG_ERROR, "Could not create container for contact auto-expiration\n");
+ return AST_MODULE_LOAD_FAILURE;
+ }
+
+ if (!(sched = ast_sched_context_create())) {
+ ast_log(LOG_ERROR, "Could not create scheduler for contact auto-expiration\n");
+ goto error;
+ }
+
+ if (ast_sched_start_thread(sched)) {
+ ast_log(LOG_ERROR, "Could not start scheduler thread for contact auto-expiration\n");
+ goto error;
+ }
+
+ contact_expiration_initialize_existing();
+
+ if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &contact_expiration_observer)) {
+ ast_log(LOG_ERROR, "Could not add observer for notifications about contacts for contact auto-expiration\n");
+ goto error;
+ }
+
+ return AST_MODULE_LOAD_SUCCESS;
+
+error:
+ if (sched) {
+ ast_sched_context_destroy(sched);
+ }
+
+ ao2_cleanup(contact_autoexpire);
+ return AST_MODULE_LOAD_FAILURE;
+}
+
+static int unload_module(void)
+{
+ ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &contact_expiration_observer);
+ ast_sched_context_destroy(sched);
+ ao2_cleanup(contact_autoexpire);
+
+ return 0;
+}
+
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SIP Contact Auto-Expiration",
+ .load = load_module,
+ .unload = unload_module,
+ .load_pri = AST_MODPRI_APP_DEPEND,
+ );
Propchange: team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: team/file/res_sip_registrar_expire/res/res_sip_registrar_expire.c
------------------------------------------------------------------------------
svn:mime-type = text/plain
More information about the asterisk-commits
mailing list