浏览代码

Starting conversion of tm module to doxygen documentation

- including Jiri's memorial in doxygen docs.
oej 16 年之前
父节点
当前提交
43b929cb48
共有 10 个文件被更改,包括 140 次插入80 次删除
  1. 9 8
      modules/tm/callid.c
  2. 10 8
      modules/tm/callid.h
  3. 10 8
      modules/tm/config.c
  4. 9 8
      modules/tm/config.h
  5. 9 8
      modules/tm/defs.h
  6. 9 8
      modules/tm/dlg.c
  7. 10 8
      modules/tm/dlg.h
  8. 9 8
      modules/tm/h_table.c
  9. 10 8
      modules/tm/h_table.h
  10. 55 8
      modules/tm/tm.c

+ 9 - 8
modules/tm/callid.c

@@ -5,19 +5,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -32,6 +27,12 @@
  *  2003-10-24  updated to the new socket_info lists (andrei)
  */
 
+/*!
+ * \file 
+ * \brief TM :: Fast Call-ID generator
+ * \ingroup tm
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include "../../dprint.h"

+ 10 - 8
modules/tm/callid.h

@@ -5,19 +5,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -31,6 +26,13 @@
  * 2003-04-09 Created by janakj
  */
 
+/*!
+ * \file 
+ * \brief TM :: Fast Call-ID generator
+ * \ingroup tm
+ */
+
+
 #ifndef CALLID_H
 #define CALLID_H
 

+ 10 - 8
modules/tm/config.c

@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2008 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -29,6 +24,13 @@
  *  2008-02-05	adapting tm module for the configuration framework (Miklos)
  */
 
+/*!
+ * \file 
+ * \brief TM :: Configuration
+ * \ingroup tm
+ */
+
+
 #include "../../cfg/cfg.h"
 #include "../../parser/msg_parser.h" /* method types */
 #include "timer.h"

+ 9 - 8
modules/tm/config.h

@@ -4,19 +4,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -26,6 +21,12 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/*!
+ * \file 
+ * \brief TM :: Configuration
+ * \ingroup tm
+ */
+
 
 #ifndef _TM_CONFIG_H
 #define _TM_CONFIG_H

+ 9 - 8
modules/tm/defs.h

@@ -4,19 +4,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -30,6 +25,12 @@
  * 2003-01-27 t_uac deprecated (jiri)
  */
 
+/*!
+ * \file 
+ * \brief TM :: Definitions
+ * \ingroup tm
+ */
+
 
 #ifndef _TM_DEFS_H
 #define _TM_DEFS_H

+ 9 - 8
modules/tm/dlg.c

@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *   [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -32,6 +27,12 @@
  * 2007-05-16 added dialog callbacks destroy (andrei)
  */
 
+/*!
+ * \file 
+ * \brief TM :: 
+ * \ingroup tm
+ */
+
 
 #include <string.h>
 #include "../../mem/shm_mem.h"

+ 10 - 8
modules/tm/dlg.h

@@ -2,19 +2,14 @@
  * $Id$
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *   [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -29,6 +24,13 @@
  * 2007-04-13 added dialog callbacks (andrei)
  */
 
+/*!
+ * \file 
+ * \brief TM :: 
+ * \ingroup tm
+ */
+
+
 #ifndef DLG_H
 #define DLG_H
 

+ 9 - 8
modules/tm/h_table.c

@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -48,6 +43,12 @@
  * 2007-06-06  switched tm bucket list to a simpler and faster clist (andrei)
  */
 
+/*!
+ * \file 
+ * \brief TM :: 
+ * \ingroup tm
+ */
+
 #include <stdlib.h>
 
 

+ 10 - 8
modules/tm/h_table.h

@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -45,6 +40,13 @@
  *              inlined often used functions (andrei)
  */
 
+/*!
+ * \file 
+ * \brief TM :: 
+ * \ingroup tm
+ */
+
+
 #ifndef _H_TABLE_H
 #define _H_TABLE_H
 

+ 55 - 8
modules/tm/tm.c

@@ -30,19 +30,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    [email protected]
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
@@ -94,6 +89,58 @@
  *  2009-03-18  added a new param: auto_inv_100_reason (aheise) 
  */
 
+/*!
+ * \file 
+ * \brief TM :: Module API (core)
+ * \ingroup tm
+ */
+
+/*!
+ * \defgroup tm TM :: Transaction stateful proxy support
+ *
+   The TM module enables stateful processing of SIP transactions. The main use
+   of stateful logic, which is costly in terms of memory and CPU, is some
+   services that inherently need state. 
+
+   For example, transaction-based accounting (module acc) needs to process 
+   transaction state as opposed to individual messages, and any kinds of 
+   forking must be implemented statefully. Other use of stateful processing 
+   is it trading CPU caused by retransmission processing for memory. 
+   That however only makes sense if CPU consumption per request is huge. 
+   For example, if you want to avoid costly DNS resolution for every 
+   retransmission of a request to an unresolvable destination, use stateful 
+   mode. Then, only the initial message burdens server by DNS queries, 
+   subsequent retransmissions will be dropped and will not result in more 
+   processes blocked by DNS resolution. The price is more memory consumption 
+   and higher processing latency.
+
+ *
+\code
+ * ***************************************************
+ * * Jiri's Source Memorial                          *
+ * *                                                 *
+ * * Welcome, pilgrim ! This is the greatest place   *
+ * * where dramatic changes happend. There are not   *
+ * * many places with a history like this, as there  *
+ * * are not so many people like Jiri, one of the    *
+ * * ser's fathers, who brought everywhere the wind  *
+ * * of change, the flood of clean-up. We all felt   *
+ * * his fatherly eye watching over us day and night.*
+ * *                                                 *
+ * * Please, preserve this codework heritage, as     *
+ * * it's unlikely for fresh, juicy pieces of code to  *
+ * * arise to give him the again the chance to       *
+ * * demonstrate his clean-up and improvement skills.*
+ * *                                                 *
+ * * Hereby, we solicit you to adopt this historical *
+ * * piece of code. For $100, your name will be      *
+ * * be printed in this banner and we will use       *
+ * * collected funds to create and display an ASCII  *
+ * * statue of Jiri  .                               *
+ * ***************************************************
+\endcode
+ */
+
 
 #include "defs.h"