Changeset 4762 for pjproject/trunk/doc/pjsip-book/endpoint.rst

Timestamp:

Feb 24, 2014 11:00:15 AM (10 years ago)

Author:

bennylp

Message:

More re #1715: doxygen integration into the book

Location:

pjproject/trunk/doc/pjsip-book

Files:

• . (modified) (1 prop)
• endpoint.rst (modified) (7 diffs)

pjproject/trunk/doc/pjsip-book/endpoint.rst

@@ -1 @@
-
 
 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
 - Customization of configurations, such as core UA (User Agent) SIP configuration, media configuration, and logging configuration
 
-This section will describe the functions above.
+This chapter will describe the functions above.
 
 To use the Endpoint class, normally application does not need to subclass it unless:
 
-- application wants to implement/override Endpoint’s callback methods to get the events such as transport state change or NAT detection completion, or
+- application wants to implement/override Endpoints callback methods to get the events such as transport state change or NAT detection completion, or
 - application schedules a timer using Endpoint.utilTimerSchedule() API. In this case, application needs to implement the onTimer() callback to get the notification when the timer expires.
 
@@ -25 +24 @@
 Creating the Library
 ----------------------
-Create the library by calling its libCreate() method::
+Create the library by calling its libCreate() method:
+
+.. code-block:: c++
 
     try {
         ep->libCreate();
     } catch(Error& err) {
-        cout << "Startup error: " << err.reason << endl;
+        cout << "Startup error: " << err.info() << endl;
     }
 
@@ -41 +42 @@
 
 - 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;
@@ -51 +56 @@
     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 {
@@ -58 +65 @@
         ep->libInit(ep_cfg);
     } catch(Error& err) {
-        cout << "Initialization error: " << err.reason << endl;
+        cout << "Initialization error: " << err.info() << endl;
     }
 
@@ -65 +72 @@
 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 {
@@ -72 +81 @@
         TransportId tid = ep->transportCreate(PJSIP_TRANSPORT_UDP, tcfg);
     } catch(Error& err) {
-        cout << "Transport creation error: " << err.reason << endl;
+        cout << "Transport creation error: " << err.info() << endl;
     }
 
-The transportCreate() method returns the newly created ​Transport ID and it takes the transport type and ​TransportConfig object to customize the transport settings like bound address and listening port number. Without this, by default the transport will be bound to INADDR_ANY and any available port.
+The transportCreate() method returns the newly created Transport ID and it takes the transport type and TransportConfig object to customize the transport settings like bound address and listening port number. Without this, by default the transport will be bound to INADDR_ANY and any available port.
 
-There is no real use of the ​Transport ID, except to create userless account (with ​Account.create(), as will be explained later), and perhaps to display the list of transports to user if the application wants it.
+There is no real use of the Transport ID, except to create userless account (with Account.create(), as will be explained later), and perhaps to display the list of transports to user if the application wants it.
 
 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 {
         ep->libStart();
     } catch(Error& err) {
-        cout << "Startup error: " << err.reason << endl;
+        cout << "Startup error: " << err.info() << endl;
     }
 
 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:
 
+.. code-block:: c++
+
+    ep->libDestroy();
     delete ep;
 
+
+Class Reference
+---------------
+The Endpoint
+++++++++++++
+.. doxygenclass:: pj::Endpoint
+        :path: xml
+        :members:
+
+Endpoint Configurations
++++++++++++++++++++++++
+Endpoint
+~~~~~~~~
+.. doxygenstruct:: pj::EpConfig
+        :path: xml
+
+Media
+~~~~~
+.. doxygenstruct:: pj::MediaConfig
+        :path: xml
+
+Logging
+~~~~~~~
+.. doxygenstruct:: pj::LogConfig
+        :path: xml
+
+.. doxygenclass:: pj::LogWriter
+        :path: xml
+        :members:
+
+.. doxygenstruct:: pj::LogEntry
+        :path: xml
+
+User Agent
+~~~~~~~~~~
+.. doxygenstruct:: pj::UaConfig
+        :path: xml
+
+
+Callback Parameters
++++++++++++++++++++
+.. doxygenstruct:: pj::OnNatDetectionCompleteParam
+        :path: xml
+
+.. doxygenstruct:: pj::OnNatCheckStunServersCompleteParam
+        :path: xml
+
+.. doxygenstruct:: pj::OnTimerParam
+        :path: xml
+
+.. doxygenstruct:: pj::OnTransportStateParam
+        :path: xml
+
+.. doxygenstruct:: pj::OnSelectAccountParam
+        :path: xml
+
+
+Other
++++++
+.. doxygenstruct:: pj::PendingJob
+        :path: xml
+