Changes between Version 5 and Version 6 of pjsip-doc/endpoint

Timestamp:

Feb 6, 2014 9:36:33 AM (10 years ago)

Author:

bennylp

Comment:

--

pjsip-doc/endpoint

@@ -4 +4 @@
 Endpoint
 ************
-The ​Endpoint class is a singleton class, and application MUST create one and at most one of this class instance before it can do anything else. This class is the core class of PJSUA2, and it provides the following functions:
+The ​Endpoint class is a singleton class, and application MUST create one and at most one of this class instance before it can do anything else, and similarly, once this class is destroyed, application must NOT call any library API. This class is the core class of PJSUA2, and it provides the following functions:
 
 - Starting up and shutting down
@@ -26 +26 @@
 Creating the Library
 ----------------------
-Create the library by calling its libCreate() method::
+Create the library by calling its libCreate() method:
+
+.. code-block:: c++
 
     try {
@@ -42 +44 @@
 
 - UAConfig, to specify core SIP user agent settings.
-- MediaConfig, to specify various media settings, including ICE and TURN.
+- MediaConfig, to specify various media *global* settings
 - LogConfig, to customize logging settings.
 
-To customize the settings, create instance of EpConfig class and specify them during the endpoint initialization (will be explained more later), for example::
+Note that some settings can be further specified on per account basis, in the AccountConfig.
+
+To customize the settings, create instance of EpConfig class and specify them during the endpoint initialization (will be explained more later), for example:
+
+.. code-block:: c++
 
     EpConfig ep_cfg;
@@ -52 +58 @@
     ep_cfg.mediaConfig.sndClockRate = 16000;
 
-Next, you can initialize the library by calling libInit()::
+Next, you can initialize the library by calling libInit():
+
+.. code-block:: c++
 
     try {
@@ -66 +74 @@
 Creating One or More Transports
 --------------------------------------------------
-Application needs to create one or more ​transports before it can send or receive SIP messages::
+Application needs to create one or more ​transports before it can send or receive SIP messages:
+
+.. code-block:: c++
 
     try {
@@ -82 +92 @@
 Starting the Library
 --------------------
-Now we're ready to start the library. We need to start the library to finalize the initialization phase, e.g. to complete the initial STUN address resolution, initialize/start the sound device, etc. To start the library, call ​libStart() method::
+Now we're ready to start the library. We need to start the library to finalize the initialization phase, e.g. to complete the initial STUN address resolution, initialize/start the sound device, etc. To start the library, call ​libStart() method:
+
+.. code-block:: c++
 
     try {
@@ -92 +104 @@
 Shutting Down the Library
 --------------------------------------
-Once the application exits, the library needs to be shutdown so that resources can be released back to the operating system. This is done by deleting the Endpoint instance, which will internally call ​libDestroy()::
+Once the application exits, the library needs to be shutdown so that resources can be released back to the operating system. Although this can be done by deleting the Endpoint instance, which will internally call ​libDestroy(), it is better to call it manually because on Java or Python there are problems with garbage collection as explained earlier:
 
-    // This will implicitly call libDestroy()
+.. code-block:: c++
+
+    ep->libDestroy();
     delete ep;