Browse code

http_async_client Add doxygen templates

Please update with better descriptions

Olle E. Johansson authored on 13/02/2016 18:58:31
Showing 8 changed files
... ...
@@ -1,6 +1,6 @@
1 1
 
2 2
 
3
-Kamailio v4.3
3
+Kamailio v4.4
4 4
 =============
5 5
 
6 6
 http://www.kamailio.org
... ...
@@ -22,6 +22,12 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: Include file
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+
25 31
 #include <stdio.h>
26 32
 #include <unistd.h>
27 33
 #include <stdlib.h>
... ...
@@ -305,7 +311,7 @@ int async_send_query(sip_msg_t *msg, str *query, str *post, cfg_action_t *act)
305 311
 	}
306 312
 	memset(aq,0,dsize);
307 313
 
308
-    if(shm_str_dup(&aq->query, query)<0) {
314
+	if(shm_str_dup(&aq->query, query)<0) {
309 315
 		goto error;
310 316
 	}
311 317
 
... ...
@@ -361,17 +367,19 @@ int async_send_query(sip_msg_t *msg, str *query, str *post, cfg_action_t *act)
361 367
 		goto error;
362 368
 	}
363 369
 
364
-	if (suspend) 
370
+	if (suspend)  {
365 371
 		/* force exit in config */
366 372
 		return 0;
373
+	}
367 374
 	
368 375
 	/* continue route processing */
369 376
 	return 1;
370 377
 
371 378
 error:
372 379
 
373
-	if (suspend)
380
+	if (suspend) {
374 381
 		tmb.t_cancel_suspend(tindex, tlabel);
382
+	}
375 383
 	free_async_query(aq);
376 384
 	return -1;
377 385
 }
... ...
@@ -22,6 +22,12 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: Async HTTP
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+
25 31
 #ifndef _ASYNC_HTTP_
26 32
 #define _ASYNC_HTTP_
27 33
 
... ...
@@ -22,6 +22,12 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: Hash functions
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+
25 31
 #include "hm_hash.h"
26 32
 
27 33
 extern int hash_size;
... ...
@@ -53,6 +59,7 @@ int init_http_m_table(unsigned int size)
53 59
 	LM_DBG("hash table %p initialized with size %d\n", hm_table, size);
54 60
 	return 0;
55 61
 }
62
+
56 63
 unsigned int build_hash_key(void *p)
57 64
 {
58 65
 	str			*hash_str;
... ...
@@ -22,6 +22,12 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: Hash functions
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+
25 31
 #ifndef _HM_HASH_
26 32
 #define _HM_HASH_
27 33
 
... ...
@@ -22,6 +22,18 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: The module interface file
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+/*! \defgroup http_async_client Kamailio :: Async module interface to Curl/HTTP
31
+ *
32
+ * http://curl.haxx.se
33
+ * A generic library for many protocols
34
+ *
35
+ */
36
+
25 37
 #include <stdio.h>
26 38
 #include <unistd.h>
27 39
 #include <stdlib.h>
... ...
@@ -22,6 +22,12 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: multi interface
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+
25 31
 #include "../../dprint.h"
26 32
 #include "../../mem/mem.h"
27 33
 #include "../../ut.h"
... ...
@@ -22,6 +22,12 @@
22 22
  *
23 23
  */
24 24
 
25
+/*! \file
26
+ * \brief  Kamailio http_async_client :: Multi interface
27
+ * \ingroup http_async_client
28
+ */
29
+
30
+
25 31
 #ifndef _HTTP_MULTI_
26 32
 #define _HTTP_MULTI_
27 33