From derek@sofaswitch.org Mon Nov 13 23:13:47 2006
From: SofaSWITCH SVN <derek@sofaswitch.org>
To: sofaswitch-svn@lists.freeswitch.org
Subject: [Sofaswitch-svn] [commit] r196 - in sofaswitch/trunk/callflow:
	docs/current tests
Date: Mon, 13 Nov 2006 23:13:47 -0500
Message-ID: <E1GjpgB-0000qF-NB@chaos.freeswitch.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="===============3954757162617823848=="

--===============3954757162617823848==
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

Author: derek
Date: Mon Nov 13 23:13:47 2006
New Revision: 196

Modified:
   sofaswitch/trunk/callflow/docs/current/eachicon.dxy
   sofaswitch/trunk/callflow/tests/amplaywavfile.src

Log:
Work on documenting. Tidy up play wave file graph, because the death
icon may not get called.


Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- sofaswitch/trunk/callflow/docs/current/eachicon.dxy	(original)
+++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy	Mon Nov 13 23:13:47 2=
006
@@ -141,7 +141,23 @@
 button. To illustrate, after a DTMF event, the Python variable will hold the
 particular DTMF value that was detected.
=20
+\subsection subsecEndEverything End Everything
+The toolbar icon and a rendering of a drawing area shape for the "End Everyt=
hing"
+item is shown below.
+<CENTER><TABLE frame=3Dvoid border=3D0><TR><TD>
+\image html bitmaps/death.png
+</TD><TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+</TD><TD>
+\image html current/Death.png
+</TD></TR>
+</TABLE></CENTER>
=20
+This icon initiates immediate closure of this Python instance. The connection
+to the remote server is severed immediately. All pending TCP messages that we
+were to have sent out are dropped. All pending timer events are
+ignored. Further, processing will not ever return to any part of this graph.
+
 \subsection subsecEndProcessing End Graph Processing
 The toolbar icon and a rendering of a drawing area shape for the "End Graph =
Processing"
 item is shown below.
@@ -157,5 +173,19 @@
 This icon is provided as a means for temporarily holding up graph processing,
 while we wait for external events. If processing does fall into here, extern=
al
 events will move graph processing to an Event Collection item as required.
+Note that if graph processing was such that some events were never registered
+for, then execution will be permanently stuck in this item.
+
+Consider the following graph.
+\image html faultyendprocessing.png "Permanent stuckly in End Graph Processi=
ng"
+
+Execution starts at the top, moves to the Event Collection item where it
+registers for some event, and then moves to the End Graph Processing
+item. Since there is no means of generating events which can be sent to this
+call graph, execution will never move to the  Event Collection
+item. Consequently, this graph will run until it is terminated by user
+intervention.
+
+
=20
 */
\ No newline at end of file

Modified: sofaswitch/trunk/callflow/tests/amplaywavfile.src
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- sofaswitch/trunk/callflow/tests/amplaywavfile.src	(original)
+++ sofaswitch/trunk/callflow/tests/amplaywavfile.src	Mon Nov 13 23:13:47 2006
@@ -1,3 +1,3 @@
-12<B>990<B>549<B> extra  <special>Tool Tip<ms>Initiate a timer, which causes=
 this to
-end.<ms><special>Timer period (seconds)<ms>0.1<ms><special>Timer label (stri=
ng literal)<ms>hanguptime<ms><special> <B><Shape>14<B>251<B>461<B> extra  <sp=
ecial>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><spec=
ial>Event sought (Regular Exp)<ms>DTMF<ms><special>Python variable to hold ev=
ent data<ms>self.dtmfData<ms><special> <B><Shape>16<B>505<B>364<B> extra  <sp=
ecial>Tool Tip<ms>Play Rogers voice<ms><special>Filename to read audio from (=
Python code)<ms>"../prompts/sample_message.wav"<ms><special>answering machine=
 node<ms>self.amNode<ms><special> <B><Shape>16<B>516<B>561<B> extra  <special=
>Tool Tip<ms>initial wav file<ms><special>Filename to read audio from (Python=
 code)<ms>"../prompts/instructions.wav"<ms><special>answering machine node<ms=
>self.amNode<ms><special> <B><Shape>2<B>769<B>426<B> extra  <special>Tool Tip=
<ms>End Processing<ms><special> <B><Shape>9<B>559<B>339<B>559,339,604,342<spe=
cial>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>11<B>191<B>67<B> ex=
tra  <special>Tool Tip<ms>Request Node from AM module<ms><special>Request nod=
e from (Python code)<ms>"am"<ms><special>Timer period (seconds)<ms>1<ms><spec=
ial>Timer label<ms>requestam<ms><special>Additional information (Python code)=
<ms><ms><special> <B><Shape>5<B>660<B>332<B> extra  <special>Tool Tip<ms>play=
 entering sound<ms><special>Test (Python code)<ms>self.dtmfData=3D=3D"2"<ms><=
special> <B><Shape>5<B>241<B>359<B> extra  <special>Tool Tip<ms>Conditional<m=
s><special>Test (Python code)<ms>(self.amNode !=3D None) and (self.soundNode =
!=3D None)<ms><special> <B><Shape>10<B>507<B>259<B> extra  <special>Tool Tip<=
ms>Python<ms><special>Python Code<ms>print  "dtmf received of  ", self.dtmfDa=
ta<ms><special> <B><Shape>20<B>529<B>662<B> extra  <special>Tool Tip<ms>Death=
<ms><special> <B><Shape>13<B>190<B>210<B> extra  <special>Tool Tip<ms>Stop Ti=
mer<ms><special>Timer to stop<ms>request voip<ms><special> <B><Shape>7<B>989<=
B>497<B> extra  <special>Tool Tip<ms>End Call<ms><special>Worker node to acti=
vate (python code)<ms>self.amNode<ms><special> <B><Shape>9<B>1039<B>386<B>103=
9,386,1082,387<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>5=
<B>507<B>312<B> extra  <special>Tool Tip<ms>Test Roger voice<ms><special>Test=
 (Python code)<ms>self.dtmfData=3D=3D"1"<ms><special> <B><Shape>9<B>266<B>329=
<B>308,329,266,359<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Sha=
pe>13<B>284<B>231<B> extra  <special>Tool Tip<ms>Stop Timer<ms><special>Timer=
 to stop<ms>request sound<ms><special> <B><Shape>9<B>712<B>318<B>712,358,755,=
361,750,320,793,318,798,333<special>Tool Tip<ms>Join blocks shape<ms><special=
> <B><Shape>9<B>291<B>382<B>291,386,334,382,332,395<special>Tool Tip<ms>Join =
blocks shape<ms><special> <B><Shape>5<B>581<B>341<B> extra  <special>Tool Tip=
<ms>Repeat instructions<ms><special>Test (Python code)<ms>self.dtmfData=3D=3D=
"4"<ms><special> <B><Shape>10<B>990<B>405<B> extra  <special>Tool Tip<ms>Pyth=
on<ms><special>Python Code<ms>print "hangup, as dtmf 9 has been received"<ms>=
<special> <B><Shape>9<B>632<B>318<B>632,366,638,319,685,318,685,330<special>T=
ool Tip<ms>Join blocks shape<ms><special> <B><Shape>14<B>202<B>162<B> extra  =
<special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><s=
pecial>Event sought (Regular Exp)<ms>amREQ<ms><special>Python variable to hol=
d event data<ms>self.amNode<ms><special> <B><Shape>9<B>214<B>304<B>214,304,26=
2,356<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>15<B>240<B=
>412<B> extra  <special>Tool Tip<ms>Transfer Media<ms><special>First SofaSwit=
ch worker (python)<ms>self.amNode<ms><special>Second SofaSwitch worker (pytho=
n)<ms>self.soundNode<ms><special> <B><Shape>2<B>659<B>427<B> extra  <special>=
Tool Tip<ms>End Processing<ms><special> <B><Shape>15<B>989<B>451<B> extra  <s=
pecial>Tool Tip<ms>Transfer Media<ms><special>First SofaSwitch worker (python=
)<ms>"sound"<ms><special>Second SofaSwitch worker (python)<ms>"sound"<ms><spe=
cial> <B><Shape>14<B>295<B>185<B> extra  <special>Tool Tip<ms>Eventer<ms><spe=
cial>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms=
>soundREQU<ms><special>Python variable to hold event data<ms>self.soundNode<m=
s><special> <B><Shape>9<B>302<B>485<B>302,485,544,492,542,506<special>Tool Ti=
p<ms>Join blocks shape<ms><special> <B><Shape>9<B>821<B>356<B>821,357,977,357=
,1018,356<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>5<B>77=
0<B>331<B> extra  <special>Tool Tip<ms>play leaving sound<ms><special>Test (P=
ython code)<ms>self.dtmfData=3D=3D"3"<ms><special> <B><Shape>14<B>529<B>614<B=
> extra  <special>Tool Tip<ms>Catch the timer which, when fired,
-indicates the end of this call<ms><special>Event sought (Python code)<ms><ms=
><special>Event sought (Regular Exp)<ms>hanguptime<ms><special>Python variabl=
e to hold event data<ms>self.hanguptime<ms><special> <B><Shape>9<B>248<B>182<=
B>248,183,308,182<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shap=
e>17<B>516<B>509<B> extra  <special>Tool Tip<ms>Write To File<ms><special>Fil=
ename to contain new audio (Python code)<ms>"recorded_audio.wav"<ms><special>=
answering machine node<ms>self.amNode<ms><special> <B><Shape>16<B>659<B>379<B=
> extra  <special>Tool Tip<ms>play entering sound<ms><special>Filename to rea=
d audio from (Python code)<ms>"../prompts/entering.wav"<ms><special>answering=
 machine node (Python code)<ms>self.amNode<ms><special> <B><Shape>5<B>991<B>3=
58<B> extra  <special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<=
ms>self.dtmfData=3D=3D"9"<ms><special> <B><Shape>10<B>190<B>254<B> extra  <sp=
ecial>Tool Tip<ms>Python<ms><special>Python Code<ms>print  "Have a new am nod=
e on ", self.amNode<ms><special> <B><Shape>9<B>544<B>394<B>606,394,602,560,54=
4,561<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>2<B>505<B>=
398<B> extra  <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>2<B>=
1058<B>385<B> extra  <special>Tool Tip<ms>End Processing<ms><special> <B><Sha=
pe>10<B>282<B>279<B> extra  <special>Tool Tip<ms>Python<ms><special>Python Co=
de<ms>print  " have a sound node of  ", self.soundNode<ms><special> <B><Shape=
>2<B>307<B>394<B> extra  <special>Tool Tip<ms>End Processing<ms><special> <B>=
<Shape>16<B>770<B>378<B> extra  <special>Tool Tip<ms>play leaving sound<ms><s=
pecial>Filename to read audio from (Python code)<ms>"../prompts/leaving.wav"<=
ms><special>answering machine node (Python code)<ms>self.amNode<ms><special> =
<B><Shape>2<B>991<B>588<B> extra  <special>Tool Tip<ms>End Processing<ms><spe=
cial> <B><Shape>9<B>264<B>199<B>264,513,264,635,426,639,428,199,532,202,532,2=
62<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>1<B>190<B>19<=
B> extra  <special>Tool Tip<ms>Start Processing<ms><special> <B><Shape>11<B>1=
91<B>109<B> extra  <special>Tool Tip<ms>Request Node from sound module<ms><sp=
ecial>Request node from (Python code)<ms>"sound"<ms><special>Timer period (se=
conds)<ms>1<ms><special>Timer label<ms>requestsound<ms><special>Additional in=
formation (Python code)<ms><ms><special> <B><Shape>
+5<B>770<B>331<B> extra  <special>Tool Tip<ms>play leaving sound<ms><special>=
Test (Python code)<ms>self.dtmfData=3D=3D"3"<ms><special> <B><Shape>16<B>516<=
B>561<B> extra  <special>Tool Tip<ms>initial wav file<ms><special>Filename to=
 read audio from (Python code)<ms>"../prompts/instructions.wav"<ms><special>a=
nswering machine node<ms>self.amNode<ms><special> <B><Shape>2<B>659<B>427<B> =
extra  <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>11<B>191<B>=
67<B> extra  <special>Tool Tip<ms>Request Node from AM module<ms><special>Req=
uest node from (Python code)<ms>"am"<ms><special>Timer period (seconds)<ms>1<=
ms><special>Timer label<ms>requestam<ms><special>Additional information (Pyth=
on code)<ms><ms><special> <B><Shape>5<B>507<B>312<B> extra  <special>Tool Tip=
<ms>Test Roger voice<ms><special>Test (Python code)<ms>self.dtmfData=3D=3D"1"=
<ms><special> <B><Shape>7<B>989<B>497<B> extra  <special>Tool Tip<ms>End Call=
<ms><special>Worker node to activate (python code)<ms>self.amNode<ms><special=
> <B><Shape>10<B>990<B>405<B> extra  <special>Tool Tip<ms>Python<ms><special>=
Python Code<ms>print "hangup, as dtmf 9 has been received"<ms><special> <B><S=
hape>10<B>282<B>279<B> extra  <special>Tool Tip<ms>Python<ms><special>Python =
Code<ms>print  " have a sound node of  ", self.soundNode<ms><special> <B><Sha=
pe>14<B>251<B>461<B> extra  <special>Tool Tip<ms>Eventer<ms><special>Event so=
ught (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>DTMF<ms><spe=
cial>Python variable to hold event data<ms>self.dtmfData<ms><special> <B><Sha=
pe>9<B>264<B>199<B>264,513,264,635,426,639,428,199,532,202,532,262<special>To=
ol Tip<ms>Join blocks shape<ms><special> <B><Shape>14<B>202<B>162<B> extra  <=
special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><sp=
ecial>Event sought (Regular Exp)<ms>amREQ<ms><special>Python variable to hold=
 event data<ms>self.amNode<ms><special> <B><Shape>5<B>581<B>341<B> extra  <sp=
ecial>Tool Tip<ms>Repeat instructions<ms><special>Test (Python code)<ms>self.=
dtmfData=3D=3D"4"<ms><special> <B><Shape>11<B>191<B>109<B> extra  <special>To=
ol Tip<ms>Request Node from sound module<ms><special>Request node from (Pytho=
n code)<ms>"sound"<ms><special>Timer period (seconds)<ms>1<ms><special>Timer =
label<ms>requestsound<ms><special>Additional information (Python code)<ms><ms=
><special> <B><Shape>9<B>821<B>356<B>821,357,977,357,1018,356<special>Tool Ti=
p<ms>Join blocks shape<ms><special> <B><Shape>2<B>991<B>588<B> extra  <specia=
l>Tool Tip<ms>End Processing<ms><special> <B><Shape>9<B>544<B>394<B>606,394,6=
02,560,544,561<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>9=
<B>248<B>182<B>248,183,308,182<special>Tool Tip<ms>Join blocks shape<ms><spec=
ial> <B><Shape>13<B>284<B>231<B> extra  <special>Tool Tip<ms>Stop Timer<ms><s=
pecial>Timer to stop<ms>request sound<ms><special> <B><Shape>9<B>1039<B>386<B=
>1039,386,1082,387<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Sha=
pe>9<B>712<B>318<B>712,358,755,361,750,320,793,318,798,333<special>Tool Tip<m=
s>Join blocks shape<ms><special> <B><Shape>9<B>266<B>329<B>308,329,266,359<sp=
ecial>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>9<B>559<B>339<B>55=
9,339,604,342<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>9<=
B>302<B>485<B>302,485,544,492,542,506<special>Tool Tip<ms>Join blocks shape<m=
s><special> <B><Shape>9<B>214<B>304<B>214,304,262,356<special>Tool Tip<ms>Joi=
n blocks shape<ms><special> <B><Shape>9<B>291<B>382<B>291,386,334,382,332,395=
<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>14<B>334<B>209<=
B> extra  <special>Tool Tip<ms>Catch the timer which, when fired,
+indicates the end of this call<ms><special>Event sought (Python code)<ms><ms=
><special>Event sought (Regular Exp)<ms>hanguptime<ms><special>Python variabl=
e to hold event data<ms>self.hanguptime<ms><special> <B><Shape>16<B>770<B>378=
<B> extra  <special>Tool Tip<ms>play leaving sound<ms><special>Filename to re=
ad audio from (Python code)<ms>"../prompts/leaving.wav"<ms><special>answering=
 machine node (Python code)<ms>self.amNode<ms><special> <B><Shape>2<B>769<B>4=
26<B> extra  <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>15<B>=
989<B>451<B> extra  <special>Tool Tip<ms>Transfer Media<ms><special>First Sof=
aSwitch worker (python)<ms>"sound"<ms><special>Second SofaSwitch worker (pyth=
on)<ms>"sound"<ms><special> <B><Shape>1<B>190<B>19<B> extra  <special>Tool Ti=
p<ms>Start Processing<ms><special> <B><Shape>13<B>190<B>210<B> extra  <specia=
l>Tool Tip<ms>Stop Timer<ms><special>Timer to stop<ms>request voip<ms><specia=
l> <B><Shape>15<B>240<B>412<B> extra  <special>Tool Tip<ms>Transfer Media<ms>=
<special>First SofaSwitch worker (python)<ms>self.amNode<ms><special>Second S=
ofaSwitch worker (python)<ms>self.soundNode<ms><special> <B><Shape>2<B>307<B>=
394<B> extra  <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>2<B>=
1058<B>385<B> extra  <special>Tool Tip<ms>End Processing<ms><special> <B><Sha=
pe>12<B>990<B>549<B> extra  <special>Tool Tip<ms>Initiate a timer, which caus=
es this to
+play wave file process to end.<ms><special>Timer period (seconds)<ms>0.1<ms>=
<special>Timer label (string literal)<ms>hanguptime<ms><special> <B><Shape>5<=
B>660<B>332<B> extra  <special>Tool Tip<ms>play entering sound<ms><special>Te=
st (Python code)<ms>self.dtmfData=3D=3D"2"<ms><special> <B><Shape>10<B>190<B>=
254<B> extra  <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print  "=
Have a new am node on ", self.amNode<ms><special> <B><Shape>14<B>295<B>185<B>=
 extra  <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<m=
s><ms><special>Event sought (Regular Exp)<ms>soundREQU<ms><special>Python var=
iable to hold event data<ms>self.soundNode<ms><special> <B><Shape>16<B>505<B>=
364<B> extra  <special>Tool Tip<ms>Play Rogers voice<ms><special>Filename to =
read audio from (Python code)<ms>"../prompts/sample_message.wav"<ms><special>=
answering machine node<ms>self.amNode<ms><special> <B><Shape>10<B>507<B>259<B=
> extra  <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print  "dtmf =
received of  ", self.dtmfData<ms><special> <B><Shape>5<B>991<B>358<B> extra  =
<special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<ms>self.dtmfD=
ata=3D=3D"9"<ms><special> <B><Shape>2<B>505<B>398<B> extra  <special>Tool Tip=
<ms>End Processing<ms><special> <B><Shape>17<B>516<B>509<B> extra  <special>T=
ool Tip<ms>Write To File<ms><special>Filename to contain new audio (Python co=
de)<ms>"recorded_audio.wav"<ms><special>answering machine node<ms>self.amNode=
<ms><special> <B><Shape>16<B>659<B>379<B> extra  <special>Tool Tip<ms>play en=
tering sound<ms><special>Filename to read audio from (Python code)<ms>"../pro=
mpts/entering.wav"<ms><special>answering machine node (Python code)<ms>self.a=
mNode<ms><special> <B><Shape>20<B>335<B>252<B> extra  <special>Tool Tip<ms>De=
ath<ms><special> <B><Shape>9<B>632<B>318<B>632,366,638,319,685,318,685,330<sp=
ecial>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>2<B>517<B>600<B> e=
xtra  <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>5<B>241<B>35=
9<B> extra  <special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<m=
s>(self.amNode !=3D None) and (self.soundNode !=3D None)<ms><special> <B><Sha=
pe>


--===============3954757162617823848==--