Update to new Local channel documentation.
authorLeif Madsen <leif@leifmadsen.com>
Thu, 18 Mar 2010 15:46:52 +0000 (15:46 +0000)
committerLeif Madsen <leif@leifmadsen.com>
Thu, 18 Mar 2010 15:46:52 +0000 (15:46 +0000)
Add same changes as commit to 1.4, but convert to TeX.

(issue #16963)
Reported by: kobaz
Patches:
      localchannel-2.txt uploaded by kobaz (license 834)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@253256 65c4cc65-6c06-0410-ace0-fbb531ad65f3

doc/tex/localchannel.tex

index c48f6d6..0e9f537 100644 (file)
@@ -373,6 +373,22 @@ and then a NOTICE stating the call was completed.
 
 \subsection{Understanding When To Use /n}
 
+Lets take a look at an example that demonstrates when the use of the /n
+directive is necessary. If we spawn a Local channel which does a Dial()
+to a SIP channel, but we use the L() option (which is used to limit the
+amount of time a call can be active, along with warning tones when the
+time is nearly up), it will be associated with the Local channel,
+which is then optimized out of the call path, and thus won't perform
+as expected.
+
+This following dialplan will not perform as expected.
+
+[services]
+exten => 2,1,Dial(SIP/PHONE_B,,L(60000:45000:15000))
+
+[internal]
+exten => 4,1,Dial(Local/2@services);
+
 By default, the Local channel will try to optimize itself out of the call path.
 This means that once the Local channel has established the call between the
 destination and Asterisk, the Local channel will get out of the way and let
@@ -390,44 +406,40 @@ directive. By adding /n to the end of the channel definition, we can keep the
 Local channel in the call path, along with any channel variables, or other
 channel specific information.
 
-For example, if we were calling a Local channel from the Dial() application, we
-could change:
+In order to make this behave as we expect (limiting the call), we would change:
 
 \begin{verbatim}
-Dial(Local/201@devices)
+[internal]
+exten => 4,1,Dial(Local/2@services)
 \end{verbatim}
 
-...into the following line:
+...into the following:
 
 \begin{verbatim}
-Dial(Local/201@devices/n)
+[internal]
+exten => 4,1,Dial(Local/2@services/n)
 \end{verbatim}
 
 By adding /n to the end, our Local channel will now stay in the call path and
 not go away.
 
-Lets take a look at an example that demonstrates when the use of the /n 
-directive is necessary. If we spawn a Local channel which then performs another
-Dial() to a SIP channel, but we use the L() option (which is used to limit the
-amount of time a call can be active, along with warning tones when the time is
-nearly up), it will be associated with the Local channel, which is then
-optimized out of the call path, and thus won't perform as expected.
-
-Here is an overview of our call flow, and the information associated with the
-channels:
+Why does adding the /n option all of a suddon make the 'L' option work? First
+we need to show an overview of the call flow that doesn't work properly, and
+discuss the information associated with the channels:
 
 \begin{enumerate}
   \item SIP device PHONE\_A calls Asterisk via a SIP INVITE
-  \item Asterisk accepts the INVITE and then starts processing dialplan logic
+  \item Asterisk accepts the INVITE and then starts processing dialplan logic in the [internal] context
   \item Our dialplan calls Dial(Local/2@services) -- notice no /n
-  \item The Local channel then executes dialplan at extension 2 within the services context
-  \item Extension 2 within [services] then performs another Dial() to a SIP channel with the line:  Dial(SIP/PHONE\_B,,L(60000:450000:15000))
-  \item The call is then placed to SIP/PHONE\_B which then answers the call.
-  \item The Local channel containing the information for tracking the time allowance of the call is then optimized out of the call path, losing all information about when to terminate the call.
-  \item SIP/PHONE\_A and SIP/PHONE\_B then continue talking indefinitely.  
+  \item The Local channel then executes dialplan at extension 2 within the [services] context
+  \item Extension 2 within [services] then performs Dial() to PHONE_B with the line:  Dial(SIP/PHONE\_B,,L(60000:45000:15000))
+  \item SIP/PHONE\_B then answers the call
+  \item Even though the L option was given when dialing the SIP device, the L information is stored in the channel that is doing the Dial() which is the Local channel, and not the endpoint SIP channel.
+  \item The Local channel in the middle, containing the information for tracking the time allowance of the call, is then optimized out of the call path, losing all information about when to terminate the call.
+  \item SIP/PHONE\_A and SIP/PHONE\_B then continue talking indefinitely.
 \end{enumerate}
 
-Now, if we were to modify our dialplan at step three (3) then we would force the
+Now, if we were to add /n to our dialplan at step three (3) then we would force the
 Local channel to stay in the call path, and the L() option associated with the
 Dial() from the Local channel would remain, and our warning sounds and timing
 would work as expected.
@@ -435,14 +447,20 @@ would work as expected.
 There are two workarounds for the above described scenario:
 
 \begin{enumerate}
-\item Use Dial(Local/2@services/n) to cause the Local channel to remain in the call
-path so that the L() option used inside the Local channel is not discarded
-when optimization is performed.
-\item Place the L() option outside of the Local channel so that when it is
-optimized out of the call path, the information required to make L() work is
-associated with the outside channel. For example: 
+\item Use what we just described, Dial(Local/2@services/n) to cause the Local
+channel to remain in the call path so that the L() option used inside the
+Local channel is not discarded when optimization is performed.
+\item Place the L() option at the outermost part of the path so that when the middle
+is optimized out of the call path, the information required to make L() work
+is associated with the outside channel. The L information will then be stored
+on the calling channel, which is PHONE\_A. For example:
+
 \begin{verbatim}
-   Dial(Local/2@services,,L(60000:45000:15000))
+[services]
+exten => 2,1,Dial(SIP/PHONE_B)
+
+[internal]
+exten => 4,1,Dial(Local/2@services,,L(60000:45000:15000));
 \end{verbatim}
 \end{enumerate}