[sr-dev] git:master: Updates (doxygen documentation) to message waiting indication module

Module: sip-router Branch: master Commit: 3f9a5599b58ae23aaea5fc160a65b157566d3721 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=3f9a559… Author: oej &lt;oej(a)edvina.net&gt; Committer: oej &lt;oej(a)edvina.net&gt; Date: Sun Oct 25 21:03:57 2009 +0100 Updates (doxygen documentation) to message waiting indication module --- modules_k/presence_mwi/README | 70 ++++++++++++--------- modules_k/presence_mwi/add_events.c | 14 +++- modules_k/presence_mwi/add_events.h | 8 +++ modules_k/presence_mwi/doc/presence_mwi_admin.xml | 6 +- modules_k/presence_mwi/presence_mwi.c | 8 +++ modules_k/presence_mwi/presence_mwi.h | 8 +++ 6 files changed, 79 insertions(+), 35 deletions(-) diff --git a/modules_k/presence_mwi/README b/modules_k/presence_mwi/README index ea03c92..44557ff 100644 --- a/modules_k/presence_mwi/README +++ b/modules_k/presence_mwi/README @@ -12,60 +12,72 @@ Juha Heinanen Copyright � 2007 Juha Heinanen Revision History - Revision $Revision: 1 $ $Date: 2007-04-30 14:05:57 +0200 (Mon, - 30 Jan 2007) $ - __________________________________________________________ + Revision $Revision: 1 $ $Date: 2007-04-30 14:05:57 +0200 (Mon, 30 Jan + 2007) $ + __________________________________________________________________ Table of Contents 1. Admin Guide - 1.1. Overview - 1.2. Dependencies + 1. Overview + 2. Dependencies - 1.2.1. Kamailio Modules - 1.2.2. External Libraries or Applications + 2.1. Kamailio Modules + 2.2. External Libraries or Applications - 1.3. Exported Parameters - 1.4. Exported Functions + 3. Exported Parameters + 4. Exported Functions Chapter 1. Admin Guide -1.1. Overview + Table of Contents + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications - The module does specific handling for notify-subscribe - message-summary (message waiting indication) events as - specified in RFC 3842. It is used with the general event - handling module, presence. It constructs and adds - message-summary event to it. + 3. Exported Parameters + 4. Exported Functions - The module does not currently implement any authorization - rules. It assumes that publish requests are only issued by a - voicemail application and subscribe requests only by the owner - of voicemail box. Authorization can thus be easily done by - Kamailio configuration file before calling handle_publish() and - handle_subscribe() functions. +1. Overview + + The module does specific handling for notify-subscribe message-summary + (message waiting indication) events as specified in RFC 3842. It is + used with the general event handling module, presence. It constructs + and adds message-summary event to it. + + The module does not currently implement any authorization rules. It + assumes that publish requests are only issued by a voicemail + application and subscribe requests only by the owner of voicemail box. + Authorization can thus be easily done by Kamailio configuration file + before calling handle_publish() and handle_subscribe() functions. The module implements a simple check of content type - application/simple-message-summary: Content must start with - Messages-Waiting status line followed by zero or more lines - that consist of tabs and printable ASCII characters. + "application/simple-message-summary:" Content must start with + "Messages-Waiting" status line followed by zero or more lines that + consist of tabs and printable ASCII characters. + +2. Dependencies -1.2. Dependencies + 2.1. Kamailio Modules + 2.2. External Libraries or Applications -1.2.1. Kamailio Modules +2.1. Kamailio Modules The following modules must be loaded before this module: * presence. -1.2.2. External Libraries or Applications +2.2. External Libraries or Applications None. -1.3. Exported Parameters +3. Exported Parameters None. -1.4. Exported Functions +4. Exported Functions None to be used in configuration file. diff --git a/modules_k/presence_mwi/add_events.c b/modules_k/presence_mwi/add_events.c index 2fcee56..fb0b44a 100644 --- a/modules_k/presence_mwi/add_events.c +++ b/modules_k/presence_mwi/add_events.c @@ -24,6 +24,14 @@ * 2007-05-1 initial version (jih) */ +/*! + * \file + * \brief SIP-router Presence :: Message-waiting indication support + * \ingroup presence + * Module: \ref presence + */ + + #include <stdio.h> #include <stdlib.h> #include <string.h> @@ -31,14 +39,14 @@ #include "../presence/event_list.h" #include "presence_mwi.h" -/* utility function that skips spaces and tabs */ +/*! \brief utility function that skips spaces and tabs */ inline char *eat_sp_tab(char *at, char *over) { while((at < over) && ((*at == ' ') || (*at == '\t'))) at++; return at; } -/* utility function that skips printable ascii chars */ +/*! \brief utility function that skips printable ascii chars */ inline char *eat_printable(char *at, char *over) { while ((at < over) && ((*at == '\t') || ((*at >= 32) && (*at <= 126)))) @@ -46,7 +54,7 @@ inline char *eat_printable(char *at, char *over) return at; } -/* +/*! \brief * event specific publish handling - check if body format is ok */ int mwi_publ_handl(struct sip_msg* msg) diff --git a/modules_k/presence_mwi/add_events.h b/modules_k/presence_mwi/add_events.h index b44fa17..e63b425 100644 --- a/modules_k/presence_mwi/add_events.h +++ b/modules_k/presence_mwi/add_events.h @@ -24,6 +24,14 @@ * 2007-05-1 initial version (jih) */ +/*! + * \file + * \brief SIP-router Presence :: Message Waiting indication + * \ingroup presence + * Module: \ref presence + */ + + #ifndef _MWI_ADD_EV_H_ #define _MWI_ADD_EV_H_ diff --git a/modules_k/presence_mwi/doc/presence_mwi_admin.xml b/modules_k/presence_mwi/doc/presence_mwi_admin.xml index c99d95f..acd66a5 100644 --- a/modules_k/presence_mwi/doc/presence_mwi_admin.xml +++ b/modules_k/presence_mwi/doc/presence_mwi_admin.xml @@ -28,15 +28,15 @@ The module does not currently implement any authorization rules. It assumes that publish requests are only issued by a voicemail application and subscribe requests only by - the owner of voicemail box. Authorization can thus + the owner of voicemail box. Authorization can thus be easily done by &kamailio; configuration file before calling handle_publish() and handle_subscribe() functions. </para> <para> The module implements a simple check of content type - application/simple-message-summary: Content must start - with Messages-Waiting status line followed by zero or + <quote>application/simple-message-summary:</quote> Content must start + with <quote>Messages-Waiting</quote> status line followed by zero or more lines that consist of tabs and printable ASCII characters. </para> diff --git a/modules_k/presence_mwi/presence_mwi.c b/modules_k/presence_mwi/presence_mwi.c index ea4ad2b..fc03c7f 100644 --- a/modules_k/presence_mwi/presence_mwi.c +++ b/modules_k/presence_mwi/presence_mwi.c @@ -24,6 +24,14 @@ * 2007-05-1 initial version (jih) */ +/*! + * \file + * \brief SIP-router Presence :: Message waiting indication + * \ingroup presence + * Module: \ref presence + */ + + #include <stdio.h> #include <stdlib.h> #include <string.h> diff --git a/modules_k/presence_mwi/presence_mwi.h b/modules_k/presence_mwi/presence_mwi.h index 9d7a664..f77ab8b 100644 --- a/modules_k/presence_mwi/presence_mwi.h +++ b/modules_k/presence_mwi/presence_mwi.h @@ -24,6 +24,14 @@ * 2007-05-1 initial version (jih) */ +/*! + * \file + * \brief SIP-router Presence :: Message waiting indication + * \ingroup presence + * Module: \ref presence + */ + + #ifndef _PRES_MWI_H_ #define _PRES_MWI_H_