Browse code

dialog remove history, fix doxygen, fix spelling errors, remove svn IDs

Olle E. Johansson authored on 06/01/2015 10:06:47
Showing 22 changed files
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * dialog module - basic support for dialog tracking
5 3
  *
6 4
  * Copyright (C) 2006 Voice Sistem SRL
... ...
@@ -22,20 +20,13 @@
22 22
  * along with this program; if not, write to the Free Software 
23 23
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
24 24
  *
25
- * History:
26
- * --------
27
- *  2006-04-14 initial version (bogdan)
28
- *  2006-11-28 Added statistic support for the number of early and failed
29
- *              dialogs. (Jeffrey Magder - SOMA Networks) 
30
- *  2007-04-30 added dialog matching without DID (dialog ID), but based only
31
- *              on RFC3261 elements - based on an original patch submitted 
32
- *              by Michel Bensoussan <michel@extricom.com> (bogdan)
33
- *  2007-05-15 added saving dialogs' information to database (ancuta)
34
- *  2007-07-04 added saving dialog cseq, contact, record route 
35
- *              and bind_addresses(sock_info) for caller and callee (ancuta)
36
- *  2008-04-14 added new type of callback to be triggered when dialogs are 
37
- *              loaded from DB (bogdan)
38
- *  2010-06-16 added sip-router rpc interface (osas)
25
+ */
26
+
27
+/*!
28
+ * \file
29
+ * \brief Module interface
30
+ * \ingroup dialog
31
+ * Module: \ref dialog
39 32
  */
40 33
 
41 34
 /**
... ...
@@ -376,7 +367,7 @@ static int fixup_profile(void** param, int param_no)
376 376
 	if (param_no==1) {
377 377
 		profile = search_dlg_profile( &s );
378 378
 		if (profile==NULL) {
379
-			LM_CRIT("profile <%s> not definited\n",s.s);
379
+			LM_CRIT("profile <%s> not defined\n",s.s);
380 380
 			return E_CFG;
381 381
 		}
382 382
 		pkg_free(*param);
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2006 Voice Sistem SRL
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -19,14 +17,14 @@
19 19
  * along with this program; if not, write to the Free Software 
20 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 21
  *
22
- * History:
23
- * --------
24
- * 2006-04-14  initial version (bogdan)
25
- * 2008-04-04  added direction reporting in dlg callbacks (bogdan)
26
- * 2008-04-14  DLGCB_CREATED may be registered before the module 
27
- *              initialization (bogdan)
28
- * 2008-04-15  added new type of callback to be triggered when dialogs are 
29
- *              loaded from DB (bogdan)
22
+ */
23
+
24
+
25
+/*!
26
+ * \file
27
+ * \brief Callbacks
28
+ * \ingroup dialog
29
+ * Module: \ref dialog
30 30
  */
31 31
 
32 32
 
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2006 Voice Sistem SRLs
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -19,14 +17,13 @@
19 19
  * along with this program; if not, write to the Free Software 
20 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 21
  *
22
- * History:
23
- * --------
24
- * 2006-04-11  initial version (bogdan)
25
- * 2008-04-04  added direction reporting in dlg callbacks (bogdan)
26
- * 2008-04-14  added new type of callback to be triggered when dialogs are 
27
- *              loaded from DB (bogdan)
28
- * 2008-04-17  added new type of callback to be triggered right before the
29
- *              dialog is destroyed (deleted from memory) (bogdan)
22
+ */
23
+
24
+/*!
25
+ * \file
26
+ * \brief Callbacks
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
30 29
  */
31 30
 
32 31
 #ifndef _DIALOG_DLG_CB_H_
... ...
@@ -1,4 +1,4 @@
1
-/**
1
+/*
2 2
  * Copyright (C) 2014 Daniel-Constantin Mierla (asipto.com)
3 3
  *
4 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -20,6 +20,14 @@
20 20
  *
21 21
  */
22 22
 
23
+
24
+/*!
25
+ * \file
26
+ * \brief Cseq handling
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
30
+
23 31
 #include <stdio.h>
24 32
 #include <unistd.h>
25 33
 #include <stdlib.h>
... ...
@@ -20,6 +20,14 @@
20 20
  *
21 21
  */
22 22
 
23
+
24
+/*!
25
+ * \file
26
+ * \brief CSeq handling
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
30
+
23 31
 #ifndef _DLG_CSEQ_H_
24 32
 #define _DLG_CSEQ_H_
25 33
 
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2007 Voice System SRL
5 3
  * Copyright (C) 2011 Carsten Bock, carsten@ng-voice.com
6 4
  *
... ...
@@ -20,11 +18,13 @@
20 20
  * along with this program; if not, write to the Free Software 
21 21
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 22
  *
23
- * History:
24
- * --------
25
- * 2007-05-10  initial version (ancuta)
26
- * 2007-07-06 additional information saved in the database: cseq, contact, 
27
- *  		   route set and socket_info for both caller and callee (ancuta)
23
+ */
24
+
25
+/*!
26
+ * \file
27
+ * \brief Database interface
28
+ * \ingroup dialog
29
+ * Module: \ref dialog
28 30
  */
29 31
 
30 32
 #include <stdlib.h>
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2007 Voice System SRL
5 3
  * Copyright (C) 2011 Carsten Bock, carsten@ng-voice.com
6 4
  *
... ...
@@ -20,11 +18,14 @@
20 20
  * along with this program; if not, write to the Free Software 
21 21
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 22
  *
23
- * History:
24
- * --------
25
- * 2007-05-10  initial version (ancuta)
26 23
  */
27 24
 
25
+/*!
26
+ * \file
27
+ * \brief Database interface
28
+ * \ingroup dialog
29
+ * Module: \ref dialog
30
+ */
28 31
 
29 32
 #ifndef _DLG_DB_HANDLER_H_
30 33
 #define _DLG_DB_HANDLER_H_
... ...
@@ -17,28 +17,6 @@
17 17
  * along with this program; if not, write to the Free Software
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 19
  *
20
- * History:
21
- * --------
22
- * 2006-04-14  initial version (bogdan)
23
- * 2006-11-28  Added support for tracking the number of early dialogs, and the
24
- *             number of failed dialogs. This involved updates to dlg_onreply()
25
- *             (Jeffrey Magder - SOMA Networks)
26
- * 2007-03-06  syncronized state machine added for dialog state. New tranzition
27
- *             design based on events; removed num_1xx and num_2xx (bogdan)
28
- * 2007-04-30  added dialog matching without DID (dialog ID), but based only
29
- *             on RFC3261 elements - based on an original patch submitted
30
- *             by Michel Bensoussan <michel@extricom.com> (bogdan)
31
- * 2007-05-17  new feature: saving dialog info into a database if
32
- *             realtime update is set(ancuta)
33
- * 2007-07-06  support for saving additional dialog info : cseq, contact,
34
- *             route_set and socket_info for both caller and callee (ancuta)
35
- * 2007-07-10  Optimized dlg_match_mode 2 (DID_NONE), it now employs a proper
36
- *             hash table lookup and isn't dependant on the is_direction
37
- *             function (which requires an RR param like dlg_match_mode 0
38
- *             anyways.. ;) ; based on a patch from
39
- *             Tavis Paquette <tavis@galaxytelecom.net>
40
- *             and Peter Baer <pbaer@galaxytelecom.net>  (bogdan)
41
- * 2008-04-04  added direction reporting in dlg callbacks (bogdan)
42 20
  */
43 21
 
44 22
 
... ...
@@ -17,11 +17,6 @@
17 17
  * along with this program; if not, write to the Free Software 
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 19
  *
20
- * History:
21
- * --------
22
- * 2006-04-14  initial version (bogdan)
23
- * 2007-03-06  syncronized state machine added for dialog state. New tranzition
24
- *             design based on events; removed num_1xx and num_2xx (bogdan)
25 20
  */
26 21
 
27 22
 
... ...
@@ -18,27 +18,6 @@
18 18
  * along with this program; if not, write to the Free Software 
19 19
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20 20
  *
21
- * History:
22
- * --------
23
- * 2006-04-14  initial version (bogdan)
24
- * 2007-03-06  syncronized state machine added for dialog state. New tranzition
25
- *             design based on events; removed num_1xx and num_2xx (bogdan)
26
- * 2007-04-30  added dialog matching without DID (dialog ID), but based only
27
- *             on RFC3261 elements - based on an original patch submitted 
28
- *             by Michel Bensoussan <michel@extricom.com> (bogdan)
29
- * 2007-07-06  additional information stored in order to save it in the db:
30
- *             cseq, route_set, contact and sock_info for both caller and 
31
- *             callee (ancuta)
32
- * 2007-07-10  Optimized dlg_match_mode 2 (DID_NONE), it now employs a proper
33
- *             hash table lookup and isn't dependant on the is_direction 
34
- *             function (which requires an RR param like dlg_match_mode 0 
35
- *             anyways.. ;) ; based on a patch from 
36
- *             Tavis Paquette <tavis@galaxytelecom.net> 
37
- *             and Peter Baer <pbaer@galaxytelecom.net>  (bogdan)
38
- * 2008-04-17  added new type of callback to be triggered right before the
39
- *              dialog is destroyed (deleted from memory) (bogdan)
40
- * 2008-04-17  added new dialog flag to avoid state tranzitions from DELETED to
41
- *             CONFIRMED_NA due delayed "200 OK" (bogdan)
42 21
  */
43 22
 
44 23
 
... ...
@@ -18,19 +18,6 @@
18 18
  * along with this program; if not, write to the Free Software 
19 19
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20 20
  *
21
- * History:
22
- * --------
23
- * 2006-04-14  initial version (bogdan)
24
- * 2006-11-28  Added num_100s and num_200s to dlg_cell, to aid in adding 
25
- *             statistics tracking of the number of early, and active dialogs.
26
- *             (Jeffrey Magder - SOMA Networks)
27
- * 2007-03-06  syncronized state machine added for dialog state. New tranzition
28
- *             design based on events; removed num_1xx and num_2xx (bogdan)
29
- * 2007-07-06  added flags, cseq, contact, route_set and bind_addr 
30
- *             to struct dlg_cell in order to store these information into db
31
- *             (ancuta)
32
- * 2008-04-17  added new dialog flag to avoid state tranzitions from DELETED to
33
- *             CONFIRMED_NA due delayed "200 OK" (bogdan)
34 21
  */
35 22
 
36 23
 /*!
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * dialog module - basic support for dialog tracking
5 3
  *
6 4
  * Copyright (C) 2006 Voice Sistem SRL
... ...
@@ -21,9 +19,14 @@
21 21
  * along with this program; if not, write to the Free Software 
22 22
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
23 23
  *
24
- * History:
25
- * --------
26
- *  2006-04-14  initial version (bogdan)
24
+ */
25
+
26
+
27
+/*!
28
+ * \file
29
+ * \brief Functions related to dialog handling
30
+ * \ingroup dialog
31
+ * Module: \ref dialog
27 32
  */
28 33
 
29 34
 #ifndef _DIALOG_DLG_LOAD_H_
... ...
@@ -17,10 +17,6 @@
17 17
  * along with this program; if not, write to the Free Software 
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 19
  *
20
- * History:
21
- * --------
22
- * 2008-04-20  initial version (bogdan)
23
- *
24 20
  */
25 21
 
26 22
 
... ...
@@ -17,13 +17,16 @@
17 17
  * along with this program; if not, write to the Free Software 
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 19
  *
20
- * History:
21
- * --------
22
- * 2008-04-20  initial version (bogdan)
23
- *
24 20
  */
25 21
 
26 22
 
23
+/*!
24
+ * \file
25
+ * \brief Profile handling
26
+ * \ingroup dialog
27
+ * Module: \ref dialog
28
+ */
29
+
27 30
 
28 31
 #ifndef _DIALOG_DLG_PROFILE_H_
29 32
 #define _DIALOG_DLG_PROFILE_H_
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2007 Voice System SRL
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -19,12 +17,16 @@
19 19
  * along with this program; if not, write to the Free Software 
20 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 21
  *
22
- * History:
23
- * --------
24
- * 2007-07-10  initial version (ancuta)
25
- * 2008-04-04  added direction reporting in dlg callbacks (bogdan)
26 22
 */
27 23
 
24
+
25
+/*!
26
+ * \file
27
+ * \brief Requests
28
+ * \ingroup dialog
29
+ * Module: \ref dialog
30
+ */
31
+
28 32
 #include <stdlib.h>
29 33
 #include <string.h>
30 34
 
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2007 Voice System SRL
5 3
  *
6 4
  * This file is part of Kamailio, a free SIP server.
... ...
@@ -19,13 +17,14 @@
19 19
  * along with this program; if not, write to the Free Software 
20 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 21
  *
22
- * History:
23
- * --------
24
- * 2007-07-10  initial version (ancuta)
25 22
 */
26 23
 
27
-
28
-
24
+/*!
25
+ * \file
26
+ * \brief Request
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
29 30
 
30 31
 #ifndef DLG_REQUEST_WITHIN_H
31 32
 #define DLG_REQUEST_WITHIN_H
... ...
@@ -17,11 +17,6 @@
17 17
  * along with this program; if not, write to the Free Software 
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 19
  *
20
- * History:
21
- * --------
22
- * 2006-04-14  initial version (bogdan)
23
- * 2007-03-06  to avoid races, tests on timer links are done under locks
24
- *             (bogdan)
25 20
  */
26 21
 
27 22
 /*!
... ...
@@ -17,9 +17,6 @@
17 17
  * along with this program; if not, write to the Free Software 
18 18
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19 19
  *
20
- * History:
21
- * --------
22
- * 2006-04-14  initial version (bogdan)
23 20
  */
24 21
 
25 22
 /*!
... ...
@@ -1,6 +1,4 @@
1
-/**
2
- * $Id$
3
- *
1
+/*
4 2
  * Copyright (C) 2009 Daniel-Constantin Mierla (asipto.com)
5 3
  *
6 4
  * This file is part of kamailio, a free SIP server.
... ...
@@ -20,6 +18,14 @@
20 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 21
  */
22 22
 
23
+
24
+/*!
25
+ * \file
26
+ * \brief Call transfer
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
30
+
23 31
 #include <stdio.h>
24 32
 #include <string.h>
25 33
 #include <stdlib.h>
... ...
@@ -1,6 +1,4 @@
1 1
 /**
2
- * $Id$
3
- *
4 2
  * Copyright (C) 2009 Daniel-Constantin Mierla (asipto.com)
5 3
  *
6 4
  * This file is part of kamailio, a free SIP server.
... ...
@@ -19,6 +17,14 @@
19 19
  * along with this program; if not, write to the Free Software
20 20
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 21
  */
22
+
23
+
24
+/*!
25
+ * \file
26
+ * \brief Call transfer
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
22 30
 		       
23 31
 #ifndef _DLG_TRANSFER_H_
24 32
 #define _DLG_TRANSFER_H_
... ...
@@ -1,6 +1,4 @@
1
-/**
2
- * $Id$
3
- *
1
+/*
4 2
  * Copyright (C) 2009 Daniel-Constantin Mierla (asipto.com)
5 3
  * Copyright (C) 2011 Carsten Bock, carsten@ng-voice.com
6 4
  *
... ...
@@ -20,6 +18,13 @@
20 20
  * along with this program; if not, write to the Free Software
21 21
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 22
  */
23
+
24
+/*!
25
+ * \file
26
+ * \brief Dialog variables
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
23 30
 		       
24 31
 #include "../../route.h"
25 32
 #include "../../script_cb.h"
... ...
@@ -51,10 +56,10 @@ int dlg_cfg_cb(sip_msg_t *msg, unsigned int flags, void *cbp)
51 51
 					/* release to destroy dialog if created by this process
52 52
 					 * and request was not forwarded */
53 53
 					if(dlg->state==DLG_STATE_UNCONFIRMED) {
54
-						LM_DBG("new dialog with no trasaction after config"
54
+						LM_DBG("new dialog with no transaction after config"
55 55
 									" execution\n");
56 56
 					} else {
57
-						LM_DBG("dialog with no expected trasaction after"
57
+						LM_DBG("dialog with no expected transaction after"
58 58
 								" config execution\n");
59 59
 					}
60 60
 					dlg_release(dlg);
... ...
@@ -1,6 +1,4 @@
1
-/**
2
- * $Id$
3
- *
1
+/*
4 2
  * Copyright (C) 2009 Daniel-Constantin Mierla (asipto.com)
5 3
  * Copyright (C) 2011 Carsten Bock, carsten@ng-voice.com
6 4
  *
... ...
@@ -20,6 +18,13 @@
20 20
  * along with this program; if not, write to the Free Software
21 21
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 22
  */
23
+
24
+/*!
25
+ * \file
26
+ * \brief Dialog variables
27
+ * \ingroup dialog
28
+ * Module: \ref dialog
29
+ */
23 30
 		       
24 31
 #ifndef _DLG_VAR_H_
25 32
 #define _DLG_VAR_H_