Changeset 3763 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Sep 21, 2011 10:20:01 AM (13 years ago)

Author:

ming

Message:

Re #1266: Asynchronous media transport creation

• Add feature that allows ICE media transport to be created asynchronously.

• Add new callback, e.g. on_call_media_transport_state(call_id, state_struct) to report media transport status.

• Handle outgoing calls while creating media transport asynchronously.

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (3 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -462 +462 @@
                                                  registration callback. */
 } pjsua_reg_info;
+
+
+/** 
+ * Enumeration of media transport state types.
+ */
+typedef enum pjsua_med_tp_st
+{
+    /** Null, this is the state before media transport is created. */
+    PJSUA_MED_TP_NULL,
+
+    /**
+     * Just before media transport is created, which can finish
+     * asynchronously later.
+     */
+    PJSUA_MED_TP_CREATING,
+
+    /** Media transport creation is completed, but not initialized yet. */
+    PJSUA_MED_TP_IDLE,
+
+    /** Initialized (media_create() has been called). */
+    PJSUA_MED_TP_INIT,
+
+    /** Running (media_start() has been called). */
+    PJSUA_MED_TP_RUNNING,
+
+    /** Disabled (transport is initialized, but media is being disabled). */
+    PJSUA_MED_TP_DISABLED
+
+} pjsua_med_tp_st;
+
+
+/**
+ * Structure to be passed on media transport state callback.
+ */
+typedef struct pjsua_med_tp_state_info
+{
+    /**
+     * The media index.
+     */
+    unsigned             med_idx;
+
+    /**
+     * The media transport state
+     */
+    pjsua_med_tp_st      state;
+
+    /**
+     * The last error code related to the media transport state.
+     */
+    pj_status_t          status;
+
+    /**
+     * Optional SIP error code.
+     */
+    int                  sip_err_code;
+
+    /**
+     * Optional extended info, the content is specific for each transport type.
+     */
+    void                *ext_info;
+
+} pjsua_med_tp_state_info;
+
+
+/**
+  * Type of callback to be called when media transport state is changed.
+  *
+  * @param call_id      The call ID.
+  * @param info         The media transport state info.
+  */
+typedef void (*pjsua_med_tp_state_cb)(pjsua_call_id call_id,
+                                      const pjsua_med_tp_state_info *info);
 
 
@@ -950 +1022 @@
 
     /**
+     * This callback is called when media transport state is changed. See
+     * also #pjsua_med_tp_state_cb.
+     */
+    pjsua_med_tp_state_cb on_call_media_transport_state;
+
+    /**
      * This callback is called to report error in ICE media transport.
      * Currently it is used to report TURN Refresh error.
@@ -1363 +1441 @@
  */
 PJ_DECL(void) pjsua_msg_data_init(pjsua_msg_data *msg_data);
+
+
+/**
+ * Clone message data.
+ *
+ * @param pool      Pool to allocate memory for the new message data.
+ * @param rhs       Message data to be cloned.
+ *
+ * @return          The new message data.
+ */
+PJ_DECL(pjsua_msg_data*) pjsua_msg_data_clone(pj_pool_t *pool,
+                                              const pjsua_msg_data *rhs);