res_pjsip: Update endpoint transport option documentation.
authorRichard Mudgett <rmudgett@digium.com>
Thu, 19 Jul 2018 21:17:50 +0000 (16:17 -0500)
committerRichard Mudgett <rmudgett@digium.com>
Thu, 19 Jul 2018 21:40:24 +0000 (16:40 -0500)
Change-Id: I5394fdff6a296efc8e1695a156e616acd932ae52

configs/samples/pjsip.conf.sample
res/res_pjsip.c

index c2e2918..6969aa0 100644 (file)
 ; a transport that you'll need to uncomment from the previous examples.
 ;
 ; Uncomment one of the transport lines to choose which transport you want. If
-; not specified then the default transport chosen is the first defined transport
-; in the configuration file.
+; not specified then the default transport chosen is the first compatible transport
+; in the configuration file for the contact URL.
 ;
 ; Modify the "max_contacts=" line to change how many unique registrations to allow.
 ;
 ;timers=yes     ; Session timers for SIP packets (default: "yes")
 ;timers_sess_expires=1800       ; Maximum session timer expiration period
                                 ; (default: "1800")
-;transport=     ; Desired transport configuration (default: "")
+;transport=     ; Explicit transport configuration to use (default: "")
+                ; This will force the endpoint to use the specified transport
+                ; configuration to send SIP messages.  You need to already know
+                ; what kind of transport (UDP/TCP/IPv4/etc) the endpoint device
+                ; will use.
+
 ;trust_id_inbound=no    ; Accept identification information received from this
                         ; endpoint (default: "no")
 ;trust_id_outbound=no   ; Send private identification details to the endpoint
index 81386c7..1b41ca9 100644 (file)
                                        </para></description>
                                </configOption>
                                <configOption name="transport">
-                                       <synopsis>Desired transport configuration</synopsis>
-                                       <description><para>
-                                               This will set the desired transport configuration to send SIP data through.
+                                       <synopsis>Explicit transport configuration to use</synopsis>
+                                       <description>
+                                               <para>This will <emphasis>force</emphasis> the endpoint to use the
+                                               specified transport configuration to send SIP messages.  You need
+                                               to already know what kind of transport (UDP/TCP/IPv4/etc) the
+                                               endpoint device will use.
                                                </para>
-                                               <warning><para>Not specifying a transport will <emphasis>DEFAULT</emphasis>
-                                               to the first configured transport in <filename>pjsip.conf</filename> which is
-                                               valid for the URI we are trying to contact.
-                                               </para></warning>
+                                               <note><para>Not specifying a transport will select the first
+                                               configured transport in <filename>pjsip.conf</filename> which is
+                                               compatible with the URI we are trying to contact.
+                                               </para></note>
                                                <warning><para>Transport configuration is not affected by reloads. In order to
                                                change transports, a full Asterisk restart is required</para></warning>
                                        </description>