Changeset 141 for pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h

Timestamp:

Feb 7, 2006 6:48:01 PM (18 years ago)

Author:

bennylp

Message:

Tested initial implementation: basic UAC, client registration, authentication, etc

File:

• pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h (modified) (7 diffs)

pjproject/trunk/pjsip/include/pjsip-ua/sip_regc.h

@@ -27 +27 @@
 #include <pjsip/sip_types.h>
 #include <pjsip/sip_auth.h>
-#include <pjsip_mod_ua/sip_ua.h>
+//#include <pjsip/sip_ua.h>
 
 PJ_BEGIN_DECL
@@ -86 +86 @@
  * @param token     A data to be associated with the client registration struct.
  * @param cb        Pointer to callback function to receive registration status.
- *
- * @return          client registration structure.
- */
-PJ_DECL(pjsip_regc*) pjsip_regc_create( pjsip_endpoint *endpt, void *token,
-                                        pjsip_regc_cb *cb);
+ * @param p_regc    Pointer to receive client registration structure.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_regc_create( pjsip_endpoint *endpt, void *token,
+                                        pjsip_regc_cb *cb, 
+                                        pjsip_regc **p_regc);
 
 
@@ -99 +101 @@
  *
  * @param regc      The client registration structure.
- */
-PJ_DECL(void) pjsip_regc_destroy(pjsip_regc *regc);
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_regc_destroy(pjsip_regc *regc);
 
 /**
@@ -138 +142 @@
  * Set authentication credentials to use by this registration.
  *
- * @param dlg           The registration structure.
- * @param count         Number of credentials in the array.
- * @param cred          Array of credentials.
- *
- * @return              Zero on success.
+ * @param dlg       The registration structure.
+ * @param count     Number of credentials in the array.
+ * @param cred      Array of credentials.
+ *
+ * @return          PJ_SUCCESS on success.
  */
 PJ_DECL(pj_status_t) pjsip_regc_set_credentials( pjsip_regc *regc,
@@ -158 +162 @@
  * @param autoreg   If non zero, the library will automatically refresh the
  *                  next registration until application unregister.
- *
- * @return          SIP REGISTER request.
- */
-PJ_DECL(pjsip_tx_data*) pjsip_regc_register(pjsip_regc *regc, pj_bool_t autoreg);
+ * @param p_tdata   Pointer to receive the REGISTER request.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_regc_register(pjsip_regc *regc, pj_bool_t autoreg,
+                                         pjsip_tx_data **p_tdata);
 
 
@@ -168 +174 @@
  *
  * @param regc      The client registration structure.
- *
- * @return          SIP REGISTER request.
- */
-PJ_DECL(pjsip_tx_data*) pjsip_regc_unregister(pjsip_regc *regc);
+ * @param p_tdata   Pointer to receive the REGISTER request.
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_regc_unregister(pjsip_regc *regc,
+                                           pjsip_tx_data **p_tdata);
 
 /**
@@ -202 +210 @@
  * @param regc      The client registration structure.
  * @param tdata     Transmit data.
- */
-PJ_DECL(void) pjsip_regc_send(pjsip_regc *regc, pjsip_tx_data *tdata);
+ *
+ * @return          PJ_SUCCESS on success.
+ */
+PJ_DECL(pj_status_t) pjsip_regc_send(pjsip_regc *regc, pjsip_tx_data *tdata);