Changes between Version 23 and Version 24 of pjsip-doc/intro_pjsua2

Timestamp:

Jul 31, 2018 8:40:30 AM (6 years ago)

Author:

ming

Comment:

--

pjsip-doc/intro_pjsua2

@@ -5 +5 @@
 PJSUA2 is an object-oriented abstraction above ​PJSUA API. It provides high level API for constructing ​Session Initiation Protocol (SIP) multimedia user agent applications (a.k.a Voice over IP/VoIP softphones). It wraps together the signaling, media, and NAT traversal functionality into easy to use call control API, account management, buddy list management, presence, and instant messaging, along with multimedia features such as local conferencing, file streaming, local playback, and voice recording, and powerful NAT traversal techniques utilizing ​STUN, ​TURN, and ​ICE.
 
-PJSUA2 is implemented on top of PJSUA-LIB API. The SIP and media features and object modelling follows what PJSUA-LIB provides (for example, we still have accounts, call, buddy, and so on), but the API to access them is different. These features will be described later in this chapter. PJSUA2 is a C++ library, which you can find under ``pjsip`` directory in the PJSIP distribution. The C++ library can be used by native C++ applications directly. But PJSUA2 is not just a C++ library. From the beginning, it has been designed to be accessible from high level non-native languages such as Java and Python. This is achieved by SWIG binding. And thanks to SWIG, binding to other languages can be added relatively easily in the future.
+PJSUA2 is implemented on top of PJSUA-LIB API. The SIP and media features and object modelling follows what PJSUA-LIB provides (for example, we still have accounts, call, buddy, and so on), but the API to access them is different. These features will be described later in this chapter. PJSUA2 is a C++ library, which you can find under ``pjsip`` directory in the PJSIP distribution. The C++ library can be used by native C++ applications directly. But PJSUA2 is not just a C++ library. From the beginning, it has been designed to be accessible from high level non-native languages such as Java and Python. This is achieved by SWIG binding. And thanks to SWIG, binding to other languages can be added relatively easily in the future, as the recent addition of C# binding has shown.
 
 PJSUA2 API declaration can be found in ``pjsip/include/pjsua2`` while the source codes are located in ``pjsip/src/pjsua2``. It will be automatically built when you compile PJSIP.
@@ -124 +124 @@
   sudo make install
 
-Building Python and Java SWIG Modules
-======================================
-The SWIG modules for Python and Java are built by invoking ``make`` and ``make install`` manually from ``pjsip-apps/src/swig`` directory. The ``make install`` will install the Python SWIG module to user's ``site-packages`` directory.
+Building Java, Python, and C# SWIG Modules
+===========================================
+The SWIG modules for Java, Python, and C# are built by invoking ``make`` and ``make install`` manually from ``pjsip-apps/src/swig`` directory. The ``make install`` will install the Python SWIG module to user's ``site-packages`` directory.
 
 Requirements
@@ -135 +135 @@
 #. ``Python``, version 3 or above (or at least 2.7 if you use Python2) is recommended (our Python sample app ``pygui`` requires version 2.7 or above, however the ``pjsua2`` Python binding should be able to run on older versions).
    For **Linux/UNIX**, you will also need ``Python development package`` (called ``python3-devel`` (or ``python-devel`` for Python2) (e.g. on Fedora) or ``python3-dev`` (or ``python2.7-dev`` for Python2) (e.g. on Ubuntu)). For **Windows**, you will need MinGW and ``Python SDK`` such as `ActivePython-2.7.5`_ from `ActiveState`_.
+#. ``swig-csharp`` component.
 
 .. _`ActivePython-2.7.5`: http://www.activestate.com/activepython/downloads
@@ -327 +328 @@
     }
   }
+
+Using in C# Application
+=========================
+The equivalence of the C++ sample code above in C# is as follows:
+
+.. code-block:: csharp
+
+  using System;
+  using pjsua2xamarin.pjsua2;
+
+  // Subclass to extend the Account and get notifications etc.
+  public class MyAccount : Account {
+    override public void onRegState(OnRegStateParam prm) {
+        Console.WriteLine("*** On registration state: " + prm.code + prm.reason);
+    }
+  }
+
+  public class test {
+    public void main() {
+        try {
+            // Create endpoint
+            Endpoint ep = new Endpoint();
+            ep.libCreate();
+            // Initialize endpoint
+            EpConfig epConfig = new EpConfig();
+            ep.libInit( epConfig );
+            // Create SIP transport. Error handling sample is shown
+            TransportConfig sipTpConfig = new TransportConfig();
+            sipTpConfig.port = 5060;
+            ep.transportCreate(pjsip_transport_type_e.PJSIP_TRANSPORT_UDP, sipTpConfig);
+            // Start the library
+            ep.libStart();
+
+            AccountConfig acfg = new AccountConfig();
+            acfg.idUri = "sip:test@pjsip.org";
+            acfg.regConfig.registrarUri = "sip:pjsip.org";
+            AuthCredInfo cred = new AuthCredInfo("digest", "*", "test", 0, "secret");
+            acfg.sipConfig.authCreds.Add( cred );
+            // Create the account
+            MyAccount acc = new MyAccount();
+            acc.create(acfg);
+
+            // Here we don't have anything else to do..
+
+            /* Explicitly delete the account.
+             * This is to avoid GC to delete the endpoint first before deleting
+             * the account.
+             */
+            acc.Dispose();
+            
+            // Explicitly destroy and delete endpoint
+            ep.libDestroy();
+            ep.Dispose();
+            
+        } catch (Exception e) {
+            Console.WriteLine("Exception: " + e.Message);
+            return;
+        }
+    }
+  }
 }}}