- Sofaswitch-svn - FreeSWITCH Mailing Lists

[commit] r323 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 18:54:11 2007 New Revision: 323 Modified: sofaswitch/trunk/callflow/docs/chap2.sgml sofaswitch/trunk/callflow/docs/chap3.sgml Log: Keep tidying the docs and add more links. Modified: sofaswitch/trunk/callflow/docs/chap2.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap2.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap2.sgml Wed Jun 13 18:54:11 2007 @@ -57,6 +57,15 @@ </para> <para> +When Python code generated from the graph in figure +<xref xrefstyle="select: labelnumber" linkend="helloworldexample"/> is run, several messages to and +from the server. First, there is a message to the server saying that a new +entity has been created, but without a specific &sofaswitch; identity. The +server supplies a specific &sofaswitch; identity. Then, the identity disappears +as the generated Python code completes. +</para> + +<para> The output connection of a control element should be connected to the input connection of one other control element. Joining the output connector of a control element to two other places is ambiguous, and is an error. Thus, the @@ -100,14 +109,7 @@ </figure> </para> -<para> -When Python code generated from the graph in figure -<xref xrefstyle="select: labelnumber" linkend="helloworldexample"/> is run, several messages to and -from the server. First, there is a message to the server saying that a new -entity has been created, but without a specific &sofaswitch; identity. The -server supplies a specific &sofaswitch; identity. Then, the identity disappears -as the generated Python code completes. -</para> + </sect1> <sect1> @@ -134,9 +136,9 @@ </para> <para> While processing each of the nodes in the supplied graph, it is -ignoring all timer events. Execution continues until it falls of the end of -the graph, or passes through an Eventer type structure and goes nowhere. Once -execution has gone nowhere, the system will process pending events. +ignoring all timer events. Execution continues until it is suspended +(section <xref endterm="SuspendProcessing" linkend="SuspendProcessingSec"/>). +Once execution has been suspended, the system will process pending events. </para> Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Wed Jun 13 18:54:11 2007 @@ -659,7 +659,7 @@ describing the identity of this graph (so noone else can communicate with this graph). Further, this graph has not requested any node, so there will be no incoming messages about created &sofaswitch; entities. This graph has not -registered with any &sofaswitch; entity as the master node (section (xref +registered with any &sofaswitch; entity as the master node (section <xref endterm="MasterNode" linkend="MasterNodeSec"/>) so another source of events to this graph is blocked. Thus, this graph will sit forever in the suspend processing control item and do nothing. @@ -1821,7 +1821,8 @@ <sect1> -<title>Suspend graph processing</title> +<title id="SuspendProcessingSec">Suspend graph processing</title> +<titleabbrev id="SuspendProcessing">Suspend processing</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="suspendprocessingicon"/> which shows the icon and graph representation of the control structure used to suspend the

1 0

[commit] r322 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 18:22:05 2007 New Revision: 322 Removed: sofaswitch/trunk/callflow/docs/current/startflow.png Log: Remove this graph.

1 0

[commit] r321 - in sofaswitch/trunk/callflow/docs: . diagrams
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 18:18:42 2007 New Revision: 321 Added: sofaswitch/trunk/callflow/docs/diagrams/amtest.png - copied unchanged from r269, /sofaswitch/trunk/callflow/docs/amtest.png sofaswitch/trunk/callflow/docs/diagrams/simpleevent.png - copied unchanged from r252, /sofaswitch/trunk/callflow/docs/simpleevent.png Removed: sofaswitch/trunk/callflow/docs/amtest.png sofaswitch/trunk/callflow/docs/simpleevent.png Modified: sofaswitch/trunk/callflow/docs/chap2.sgml Log: Move more png files into the diagrams directory. Modified: sofaswitch/trunk/callflow/docs/chap2.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap2.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap2.sgml Wed Jun 13 18:18:42 2007 @@ -153,7 +153,7 @@ <title>Example of event handling</title> <mediaobject> <imageobject> -<imagedata fileref="simpleevent.png" align="center" format="PNG"></imagedata> +<imagedata fileref="diagrams/simpleevent.png" align="center" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> @@ -271,7 +271,7 @@ and timers.</title> <mediaobject> <imageobject> -<imagedata fileref="amtest.png" align="center" format="PNG"></imagedata> +<imagedata fileref="diagrams/amtest.png" align="center" format="PNG"></imagedata> </imageobject> </mediaobject> </figure>

1 0

[commit] r320 - in sofaswitch/trunk/callflow/docs: . diagrams
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 18:16:52 2007 New Revision: 320 Added: sofaswitch/trunk/callflow/docs/diagrams/forloop.png - copied unchanged from r252, /sofaswitch/trunk/callflow/docs/forloop.png sofaswitch/trunk/callflow/docs/diagrams/helloworld.png - copied unchanged from r252, /sofaswitch/trunk/callflow/docs/helloworld.png Removed: sofaswitch/trunk/callflow/docs/faultyendprocessing.png sofaswitch/trunk/callflow/docs/forloop.png sofaswitch/trunk/callflow/docs/helloworld.png sofaswitch/trunk/callflow/docs/trivialtransfer.png Modified: sofaswitch/trunk/callflow/docs/callflow.xml sofaswitch/trunk/callflow/docs/chap2.sgml sofaswitch/trunk/callflow/docs/chap3.sgml Log: Tidy up docs. Move diagrams into subdirectory. Modified: sofaswitch/trunk/callflow/docs/callflow.xml ============================================================================== --- sofaswitch/trunk/callflow/docs/callflow.xml (original) +++ sofaswitch/trunk/callflow/docs/callflow.xml Wed Jun 13 18:16:52 2007 @@ -55,7 +55,3 @@ &app1; </book> - - \ No newline at end of file Modified: sofaswitch/trunk/callflow/docs/chap2.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap2.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap2.sgml Wed Jun 13 18:16:52 2007 @@ -25,7 +25,7 @@ <figure id="helloworldexample"> <title>The standard "Hello World" example</title> <mediaobject><imageobject> -<imagedata fileref="helloworld.png" align="center" format="PNG"></imagedata> +<imagedata fileref="diagrams/helloworld.png" align="center" format="PNG"></imagedata> </imageobject></mediaobject> </figure> The properties of the Python object in the middle have been adjusted to contain @@ -128,7 +128,7 @@ <title>Example of a for loop</title> <mediaobject> <imageobject> -<imagedata fileref="forloop.png" align="center" format="PNG"></imagedata> +<imagedata fileref="diagrams/forloop.png" align="center" format="PNG"></imagedata> </imageobject></mediaobject> </figure> </para> @@ -237,7 +237,7 @@ <title>Trivial example of the transfer of audio</title> <mediaobject> <imageobject> -<imagedata fileref="trivialtransfer.png" align="center" format="PNG"></imagedata> +<imagedata fileref="diagrams/trivialtransfer.png" align="center" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Wed Jun 13 18:16:52 2007 @@ -638,6 +638,32 @@ the Python variables listed in the above table are initialised to <literal>None</literal>. </para> + +<para> +The event control structure can be the cause of some unfortunate call control +situations. Consider the graph shown in figure +<xref xrefstyle="select: labelnumber" linkend="faultyevents"/> +<figure id="faultyevents"> +<title>Incorrect event registration</title> +<mediaobject> +<imageobject> +<imagedata fileref="diagrams/FaultyEvents.png" align="center" format="PNG"></imagedata> +</imageobject> +</mediaobject> +</figure> +This graph is created (which means a new &sofaswitch; id is assigned to this +graph) and the eventer control structure is used to register for some +event. Execution of this graph is then suspended, as we wait for an incoming +event. However, no event will ever be detected by this graph. There is no +mechanism for this graph to send messages to other &sofaswitch; components +describing the identity of this graph (so noone else can communicate with this +graph). Further, this graph has not requested any node, so there will be no +incoming messages about created &sofaswitch; entities. This graph has not +registered with any &sofaswitch; entity as the master node (section (xref +endterm="MasterNode" linkend="MasterNodeSec"/>) so another source of events to +this graph is blocked. Thus, this graph will sit forever in the suspend +processing control item and do nothing. +</para> </sect1> @@ -1239,8 +1265,8 @@ <sect1> -<title>Master node -</title> +<title id="MasterNodeSec">Master node</title> +<titleabbrev id="MasterNode">Master node</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="masternodeicon"/> which shows the icon and graph representation of the

1 0

[commit] r319 - sofaswitch/trunk/callflow/docs/diagrams
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 17:58:27 2007 New Revision: 319 Added: sofaswitch/trunk/callflow/docs/diagrams/trivialtransfer.png - copied unchanged from r266, /sofaswitch/trunk/callflow/docs/trivialtransfer.png Log: Move image to here, for tidyness.

1 0

[commit] r318 - sofaswitch/trunk/callflow/docs/diagrams
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 17:55:24 2007 New Revision: 318 Added: sofaswitch/trunk/callflow/docs/diagrams/FaultyEvents.png - copied unchanged from r252, /sofaswitch/trunk/callflow/docs/faultyendprocessing.png Log: Move image to here

1 0

[commit] r317 - in sofaswitch/trunk/callflow: docs tests
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Wed Jun 13 00:35:08 2007 New Revision: 317 Removed: sofaswitch/trunk/callflow/docs/exchildgraph.png sofaswitch/trunk/callflow/docs/exloadnewgraph.png Modified: sofaswitch/trunk/callflow/docs/app1.sgml sofaswitch/trunk/callflow/docs/callflow.xml sofaswitch/trunk/callflow/docs/chap3.sgml sofaswitch/trunk/callflow/tests/child.src sofaswitch/trunk/callflow/tests/loadgraph.src Log: Doc tidyups. Get images looking right. Improve text reporting in the generated graphs. Modified: sofaswitch/trunk/callflow/docs/app1.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/app1.sgml (original) +++ sofaswitch/trunk/callflow/docs/app1.sgml Wed Jun 13 00:35:08 2007 @@ -56,11 +56,14 @@ Writing callflow.hhc </screen> Once the actual html is generated, the zip file must be created. This zip file -contains the files generated by the <literal>xsltproc</literal> command. On +contains the files generated by the <literal>xsltproc</literal> command and the +image files referenced by the .sgml files. On Unix, the command is <screen> -zip doc.zip *.html *.hh* + find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip doc.zip </screen> +The generated <literal>doc.zip</literal> file must be in the same directory as +where the &callflow; executable is run from. </para> </appendix> Modified: sofaswitch/trunk/callflow/docs/callflow.xml ============================================================================== --- sofaswitch/trunk/callflow/docs/callflow.xml (original) +++ sofaswitch/trunk/callflow/docs/callflow.xml Wed Jun 13 00:35:08 2007 @@ -56,7 +56,6 @@ </book> - \ No newline at end of file Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Wed Jun 13 00:35:08 2007 @@ -824,16 +824,90 @@ <row> <entry><literal>Python variable to pass to the child</literal></entry> <entry><para> -One Python variable (which may be a list) is past to the child graph. This -(typically) would contain the id of &sofaswitch; worker -nodes that are in existance which are available to do any desired task. +One Python variable (which may be a list or tuple) is past to the child +graph. This (typically) would contain the id of &sofaswitch; worker nodes that +are in existance which are available to do any desired task. The child graph +can access this data in the Python variable <literal>self.userData</literal>. </para></entry></row> +</tbody> +</tgroup> +</informaltable> +</para> +<para> +The load new graph control object is crucial to the deployment of large scale +systems, where multiple calls are handled simultaneously. Since one graph is +not sufficient (on its own) to handle the myriad of calls in the one of many +different styles, the user of such large systems needs to have a good +understanding of how this control object works. An additional figure +<xref xrefstyle="select: labelnumber" linkend="loadnewgraphexample"/> is +provided to illustrate the operation. +<figure id="loadnewgraphexample"> +<title>Example of load new graph</title> +<informaltable frame="all"> +<tgroup cols="2"> +<tbody> +<row><entry><para> +<mediaobject><imageobject> + <imagedata fileref="diagrams/exChildGraph.png" align="center" format="PNG"></imagedata> +</imageobject></mediaobject> +</para></entry> +<entry><para> +<mediaobject><imageobject> +<imagedata fileref="diagrams/exLoadNewGraph.png" align="center" format="PNG"></imagedata> +</imageobject></mediaobject> +</para></entry></row> +<row><entry><para>child graph </para></entry> + <entry><para>parent (creator) graph</para></entry></row> </tbody> </tgroup> </informaltable> +</figure> +The left image in figure <xref xrefstyle="select: labelnumber" +linkend="loadnewgraphexample"/> shows the child graph. Multiple copies of this +will be created. The key operation of the child graph is to execute a Python +statement. In this case, the output of the Python statement is to print the +<itemizedlist> + <listitem><para> + <literal>self.myId</literal> (&sofaswitch; ID) of the parent graph. + </para></listitem> + <listitem><para> + <literal>self.myId</literal> (&sofaswitch; ID) of the child graph. + </para></listitem> + <listitem><para> + The for loop variable, which is passed from the parent graph to the child +graph. The child graph receives variables from the parent in the Python +variable <literal>self.userData</literal> + </para></listitem> +</itemizedlist> +</para> +<para> +The parent graph (right image, figure <xref xrefstyle="select: labelnumber" +linkend="loadnewgraphexample"/> shows the parent graph. This graph consists of +a for loop which is designed to create multiple child graphs. On creation of a +child graph, a Python statement is executed, which prints a message about the +for loop variable. After all of the child graphs have been created, a timer is +started and execution is suspended. During the suspended time interval, the +child graphs all run. The eventer control structure captures the event of timer +termination, and the graph is terminated. +</para> +<para> +Output to the console from the parent running is +<programlisting> +have generated the new graph on loop counter 0 +have generated the new graph on loop counter 1 +have generated the new graph on loop counter 2 +CHILD says::: parent id is c69 child id is c71 data from parent is 0 +CHILD says::: parent id is c69 child id is c72 data from parent is 2 +CHILD says::: parent id is c69 child id is c70 data from parent is 1 +end the master now +</programlisting> +Here, the issue of processing order is apparent. You see that the child +processes do not start until the parent has suspended. Further, the order of +the child processes running is not as one would expect. It is based on +decisions about which event is first by the Twisted Python module. </para> </sect1> Modified: sofaswitch/trunk/callflow/tests/child.src ============================================================================== --- sofaswitch/trunk/callflow/tests/child.src (original) +++ sofaswitch/trunk/callflow/tests/child.src Wed Jun 13 00:35:08 2007 @@ -1 +1 @@ -151850 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>1052893 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "CHILD says::: parent id is ", self.parentId, " user data is ", self.userData<ms><special> <Shape>20531142 extra <special>Tool Tip<ms>Death<ms><special> <Shape> +20531142 extra <special>Tool Tip<ms>Death<ms><special> <Shape>1052893 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "CHILD says::: parent id is ", self.parentId, " child id is ", self.myId, "data from parent is ", self.userData<ms><special> <Shape>151850 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape> Modified: sofaswitch/trunk/callflow/tests/loadgraph.src ============================================================================== --- sofaswitch/trunk/callflow/tests/loadgraph.src (original) +++ sofaswitch/trunk/callflow/tests/loadgraph.src Wed Jun 13 00:35:08 2007 @@ -1 +1 @@ -14393334 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>thistimer<ms><special>Python variable: source of the event<ms>self.eventSource<ms><special>Python variable: name of the event<ms>self.eventName<ms><special>Python variable: generated data<ms>self.eventData<ms><special> <Shape>9322107374,107,322,107,322,260,372,263<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>2510356 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>4372238 extra <special>Tool Tip<ms>End For Loop<ms><special> <Shape>12381280 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds, Python code)<ms>2<ms><special>Timer label (Python code)<ms>"thistimer"<ms><special> <Shape>18381127 extra <special>Tool Tip<ms>Load New Graph<ms><special>new graph file (Python code)<ms>"child.graph"<ms><special>Python variable to pass to child<ms>self.data[a]<ms><special> <Shape>10390181 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "have generated the new graph"<ms><special> <Shape>10389373 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "end the master now"<ms><special> <Shape>337482 extra <special>Tool Tip<ms>Start For - to make lots of graphs<ms><special>Initialise (Python code)<ms>self.i = 0<ms><special>Test for Termination (Python code)<ms>self.i < 10<ms><special>Increment (Python code)<ms>self.i+=1<ms><special> <Shape>20392420 extra <special>Tool Tip<ms>Death<ms><special> <Shape>137935 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>9443356443,356,500,356,538,356<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape> +10390181 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "have generated the new graph on loop counter", self.i<ms><special> <Shape>18381127 extra <special>Tool Tip<ms>Load New Graph<ms><special>new graph file (Python code)<ms>"child.graph"<ms><special>Python variable to pass to child<ms>self.i<ms><special> <Shape>4372238 extra <special>Tool Tip<ms>End For Loop<ms><special> <Shape>9322107374,107,322,107,322,260,372,263<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>20392420 extra <special>Tool Tip<ms>Death<ms><special> <Shape>337482 extra <special>Tool Tip<ms>Start For - to make lots of graphs<ms><special>Initialise (Python code)<ms>self.i = 0<ms><special>Test for Termination (Python code)<ms>self.i < 3<ms><special>Increment (Python code)<ms>self.i+=1<ms><special> <Shape>137935 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>9443356443,356,500,356,538,356<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>2510356 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>14393334 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>thistimer<ms><special>Python variable: source of the event<ms>self.eventSource<ms><special>Python variable: name of the event<ms>self.eventName<ms><special>Python variable: generated data<ms>self.eventData<ms><special> <Shape>12381280 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds, Python code)<ms>1<ms><special>Timer label (Python code)<ms>"thistimer"<ms><special> <Shape>10389373 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "end the master now"<ms><special> <Shape>

1 0

[commit] r316 - sofaswitch/trunk/callflow/docs/diagrams
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Tue Jun 12 23:46:58 2007 New Revision: 316 Added: sofaswitch/trunk/callflow/docs/diagrams/exChildGraph.png - copied unchanged from r267, /sofaswitch/trunk/callflow/docs/exchildgraph.png sofaswitch/trunk/callflow/docs/diagrams/exLoadNewGraph.png - copied unchanged from r267, /sofaswitch/trunk/callflow/docs/exloadnewgraph.png Log: Move graphs to here - the diagrams directory is ideal for pictures.

1 0

[commit] r315 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Tue Jun 12 22:00:51 2007 New Revision: 315 Modified: sofaswitch/trunk/callflow/docs/callflow.xml sofaswitch/trunk/callflow/docs/chap2.sgml sofaswitch/trunk/callflow/docs/chap3.sgml Log: Text tidyups - get the links to work. Modified: sofaswitch/trunk/callflow/docs/callflow.xml ============================================================================== --- sofaswitch/trunk/callflow/docs/callflow.xml (original) +++ sofaswitch/trunk/callflow/docs/callflow.xml Tue Jun 12 22:00:51 2007 @@ -46,6 +46,7 @@ &chap1; + &chap2; &chap3; @@ -55,12 +56,7 @@ </book> - - > current/faultyjoinexample.png - > current/MakeCall.png - > current/startflow.png - > current/validjoinexample.png - > deathexample.png - > exchildgraph.png + \ No newline at end of file Modified: sofaswitch/trunk/callflow/docs/chap2.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap2.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap2.sgml Tue Jun 12 22:00:51 2007 @@ -98,17 +98,16 @@ </tgroup> </informaltable> </figure> - +</para> <para> When Python code generated from the graph in figure -<xref xrefstyle="select: labelnumber"linkend="helloworldexample"/> is run, several messages to and +<xref xrefstyle="select: labelnumber" linkend="helloworldexample"/> is run, several messages to and from the server. First, there is a message to the server saying that a new entity has been created, but without a specific &sofaswitch; identity. The server supplies a specific &sofaswitch; identity. Then, the identity disappears as the generated Python code completes. </para> - </sect1> <sect1> @@ -299,20 +298,24 @@ <para> We have described how &callflow; uses the twisted module (<ulink URL="http://twistedmatrix.com/trac"></ulink>) in Python to handle events. Further, the outcome of this has been stated as -<quote> +</para> +<blockquote><para> processing of events (timers, network packets etc) happens when execution has moved into a "suspend graph processing" control icon. -</quote> +</para></blockquote> +<para> However, this sentence should be extended to note that -<quote> +</para> +<blockquote><para> all control messages which are sent to remote &sofaswitch; entities are sent when execution has moved into a "suspend graph processing" control icon. -</quote> +</para></blockquote> +<para> The following figure <xref xrefstyle="select: labelnumber" linkend="deathexample"/> gives a clear illustration of the order of processing in &callflow; <figure id="deathexample"> -<title>The standard "Hello World" example</title> +<title>An illustration of processing issues</title> <mediaobject><imageobject> <imagedata fileref="diagrams/DeathExample.png" align="center" format="PNG"></imagedata> </imageobject></mediaobject> @@ -323,11 +326,13 @@ message is only sent when execution of control items on this graph is suspended. The third item on this graph causes the id assigned to this graph to be deleted. Thus, on processing the terminate processing control item -(section <xref xrefstyle="select: labelnumber" linkend="TerminateProcessing">), +(section <xref endterm="TermProc" linkend="TerminateProcessing"/>), the message that was queued for sending is never sent. Perusal of the message log on the server will show the creation of a new node (this graph) and the destruction of this node. </para> +</sect1> + </chapter> Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Tue Jun 12 22:00:51 2007 @@ -184,6 +184,7 @@ <sect1 id="TerminateProcessing"> <title>Death - terminate processing of this graph</title> +<titleabbrev id="TermProc">Terminate Processing</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="deathicon"/> which shows the icon and graph representation of the control structure used to immediately terminate @@ -703,8 +704,8 @@ go. However, connecting the output of one control item to multiple other control items is incorrect, as the correct direction for execution is not determinable. Thus, the left image in figure -<xref xrefstyle="select: labelnumber" linkend="ambiguousconection"/> is -invalid, but the right image is correct. +<xref xrefstyle="select: labelnumber" linkend="ambiguousconnection"/> is +invalid, but the middle and right images are correct. </para>

1 0

[commit] r314 - in sofaswitch/trunk/callflow: docs docs/current src
by SofaSWITCH SVN 13 Jun '07

13 Jun '07

Author: derek Date: Tue Jun 12 21:24:17 2007 New Revision: 314 Removed: sofaswitch/trunk/callflow/docs/current/validjoinexample.png sofaswitch/trunk/callflow/docs/deathexample.png Modified: sofaswitch/trunk/callflow/docs/chap2.sgml sofaswitch/trunk/callflow/docs/chap3.sgml sofaswitch/trunk/callflow/src/shapelist.cpp sofaswitch/trunk/callflow/src/shapelist.h Log: Tidy up docs to describe death processing, and joining. Add tests to code to check for valid joining & starting of graphs. Modified: sofaswitch/trunk/callflow/docs/chap2.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap2.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap2.sgml Tue Jun 12 21:24:17 2007 @@ -62,7 +62,8 @@ control element to two other places is ambiguous, and is an error. Thus, the left graph depicted in figure <xref xrefstyle="select: labelnumber" linkend="ambiguousconnection"/> is wrong. Further, you will note that the filled circles -indicating a join are drawn +indicating a join are drawn to both control elements. At compile time, the +faulty connection will be detected and reported. <figure id="ambiguousconnection"> <title>Joining of control elements</title> <informaltable frame="all"> @@ -77,13 +78,22 @@ <imagedata fileref="diagrams/GoodJoin.png" align="center" format="PNG"></imagedata> </imageobject></mediaobject> </entry> +<entry> +<mediaobject><imageobject> +<imagedata fileref="diagrams/ValidJoinExample.png" align="center" format="PNG"></imagedata> +</imageobject></mediaobject> +</entry> </row> <row><entry><para> Faulty graph </para></entry> <entry><para> Correct graph -</para></entry></row> +</para></entry> +<entry><para> +Correct graph +</para></entry> +</row> </tbody> </tgroup> </informaltable> @@ -91,7 +101,8 @@ <para> -When Python code generated from the above graph is run, several messages to and +When Python code generated from the graph in figure +<xref xrefstyle="select: labelnumber"linkend="helloworldexample"/> is run, several messages to and from the server. First, there is a message to the server saying that a new entity has been created, but without a specific &sofaswitch; identity. The server supplies a specific &sofaswitch; identity. Then, the identity disappears @@ -282,4 +293,42 @@ happens and this graph is closed down. </para> </sect1> + +<sect1> +<title>Processing issues</title> +<para> We have described how &callflow; uses the twisted module +(<ulink URL="http://twistedmatrix.com/trac"></ulink>) in Python to handle +events. Further, the outcome of this has been stated as +<quote> +processing of events (timers, network packets etc) happens when execution has +moved into a "suspend graph processing" control icon. +</quote> +However, this sentence should be extended to note that +<quote> +all control messages which are sent to remote &sofaswitch; entities are sent +when execution has moved into a "suspend graph processing" control icon. +</quote> +The following figure <xref xrefstyle="select: labelnumber" +linkend="deathexample"/> gives a clear illustration of the order of processing +in &callflow; +<figure id="deathexample"> +<title>The standard "Hello World" example</title> +<mediaobject><imageobject> +<imagedata fileref="diagrams/DeathExample.png" align="center" format="PNG"></imagedata> +</imageobject></mediaobject> +</figure> +In the first item, a link with the server is created, and an id is assigned to +this graph. The second item causes a message to be sent to some SofaSwitch +application to request a node. In fact, the message is queued for sending. The +message is only sent when execution of control items on this graph is +suspended. The third item on this graph causes the id assigned to this +graph to be deleted. Thus, on processing the terminate processing control item +(section <xref xrefstyle="select: labelnumber" linkend="TerminateProcessing">), +the message that was queued for sending is never sent. Perusal of the message +log on the server will show the creation of a new node (this graph) and the +destruction of this node. +</para> </chapter> + + + Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Tue Jun 12 21:24:17 2007 @@ -182,7 +182,7 @@ -<sect1> +<sect1 id="TerminateProcessing"> <title>Death - terminate processing of this graph</title> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="deathicon"/> which shows the icon Modified: sofaswitch/trunk/callflow/src/shapelist.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/shapelist.cpp (original) +++ sofaswitch/trunk/callflow/src/shapelist.cpp Tue Jun 12 21:24:17 2007 @@ -228,6 +228,38 @@ return true; } +bool MyListShapesExtended::OneStartProcessing() +{ + int countStarts = 0; + MyListShapes::iterator it = begin(); + while (it != end()) { + DndShape *thisShape = it->second; + if (thisShape->GetKind() == DndShape::StartHere) + countStarts++; + it++; + } + + if (countStarts == 1) + return true; + + if (countStarts == 0) { + it = begin(); + while (it != end()) { + DndShape *thisShape = it->second; + thisShape->SetCompileError("No Start Processing control element"); + it++; + } + return false; + } + + it = begin(); + while (it != end()) { + DndShape *thisShape = it->second; + if (thisShape->GetKind() == DndShape::StartHere) + thisShape->SetCompileError("Duplicate Start Processing control element"); + it++; + } +} bool MyListShapesExtended::Compile(wxTextFile & file) { @@ -246,6 +278,8 @@ it++; } + OneStartProcessing(); + /**Second, go through and check all output points link to something. */ bool pointsLinked = true; it = begin(); Modified: sofaswitch/trunk/callflow/src/shapelist.h ============================================================================== --- sofaswitch/trunk/callflow/src/shapelist.h (original) +++ sofaswitch/trunk/callflow/src/shapelist.h Tue Jun 12 21:24:17 2007 @@ -62,6 +62,12 @@ Returns true on success, false on failure.*/ bool Compile(wxTextFile & file); + /**Test for two start processing control items on this graph. If found, mark + both as compile errors, and return false. return false if none are + found. return true if one is found. If None are found, mark all shapes as + in error, as there is no source object for them. */ + bool OneStartProcessing(); + /**Print this shape info to the launching console, for debug purposes */ void PrintContents();

1 0