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> - -<!-- - > faultyendprocessing.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 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