瀏覽代碼

pua: updated devel API documentation

- updated documentation to reflect latest source code
- patch by Nikita Kozlov
Daniel-Constantin Mierla 15 年之前
父節點
當前提交
bb5d5155da
共有 2 個文件被更改,包括 17 次插入23 次删除
  1. 8 10
      modules_k/pua/README
  2. 9 13
      modules_k/pua/doc/pua_devel.xml

+ 8 - 10
modules_k/pua/README

@@ -344,16 +344,7 @@ typedef struct publ_info
                           should match */
   str* extra_headers  /*  (optional) extra_headers that should be added
                           to Publish msg*/
-  publrpl_cb_t* cbrpl;/*  callback function to be called when receiving
-                          the reply for the sent request */
-  void* cbparam;      /*  extra parameter for tha callback function */
-
 }publ_info_t;
-...
-
-   The callback function type:
-...
-typedef int (publrpl_cb_t)(struct sip_msg* reply, void*  extra_param);
 ...
 
 3. send_subscribe
@@ -422,7 +413,7 @@ typedef int (*register_puacb_t)(int types, pua_cb f, void* param );
 ...
 
    This function registers a callback to be called on receiving the reply
-   message for a sent Subscribe request. The type parameter should be set
+   message for a sent Publish or Subscribe request. The type parameter should be set
    the same as the source_flag for that request. The function registered
    as callback for pua should be of type pua_cb , which is: typedef void
    (pua_cb)(ua_pres_t* hentity, struct msg_start * fl); The parameters are
@@ -438,6 +429,13 @@ typedef int (*register_puacb_t)(int types, pua_cb f, void* param );
         }
 ...
 
+   The callback function type:
+
+...
+typedef int (pua_cb)(ua_pres_t* hentity, struct sip_msg*);
+...
+
+
 6. add_event
 
    Field type:

+ 9 - 13
modules_k/pua/doc/pua_devel.xml

@@ -88,21 +88,9 @@ typedef struct publ_info
                           should match */
   str* extra_headers  /*  (optional) extra_headers that should be added
                           to Publish msg*/
-  publrpl_cb_t* cbrpl;/*  callback function to be called when receiving
-                          the reply for the sent request */
-  void* cbparam;      /*  extra parameter for tha callback function */					   
-
 }publ_info_t;
 ...
 		</programlisting>
-		<para>
-			The callback function type:
-						<programlisting format="linespecific">
-...
-typedef int (publrpl_cb_t)(struct sip_msg* reply, void*  extra_param);
-...
-		</programlisting>
-		</para>
 	</section>
 
 	<section>
@@ -199,7 +187,7 @@ typedef int (*register_puacb_t)(int types, pua_cb f, void* param );
 		
 		<para>
 			This function registers a callback to be called on receiving the reply message
-			for a sent Subscribe request.
+			for a sent Publish or Subscribe request.
 			The type parameter should be set the same as the source_flag for that request.
 			The function registered as callback for pua should be of type pua_cb , which is:
 			typedef void (pua_cb)(ua_pres_t* hentity, struct msg_start * fl);
@@ -217,6 +205,14 @@ typedef int (*register_puacb_t)(int types, pua_cb f, void* param );
 	}
 ...	
 	</programlisting>
+		<para>
+			The callback function type:
+						<programlisting format="linespecific">
+...
+typedef int (pua_cb)(ua_pres_t* hentity, struct sip_msg*);
+...
+		</programlisting>
+		</para>
 		</example>
 		</section>