November 2006 - Sofaswitch-svn - FreeSWITCH Mailing Lists

[commit] r207 - in sofaswitch/trunk/callflow/docs: . current
by SofaSWITCH SVN 19 Nov '06

19 Nov '06

Author: derek Date: Sun Nov 19 17:01:03 2006 New Revision: 207 Added: sofaswitch/trunk/callflow/docs/exloadnewgraph.png (contents, props changed) Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Add documentation on icons on the screen, and an explanatory graph. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Sun Nov 19 17:01:03 2006 @@ -8,13 +8,15 @@ The control structures described in this page are \li \ref subsecConditional +\li \ref subsecDeath \li \ref subsecEndCall \li \ref subsecEndFor -\li \ref subsecEndEverything \li \ref subsecEndProcessing \li \ref subsecEventer \li \ref subsecJoinObjects +\li \ref subsecLoadNewGraph \li \ref subsecMakeCall +\li \ref subsecPython \li \ref subsecReadFromFile \li \ref subsecRequestNode \li \ref subsecStartFlow @@ -61,11 +63,77 @@ +\subsection subsecConditional Conditional execution +The toolbar icon and a rendering of a drawing area shape for the "Conditional" +item is shown below. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html ControlsIf.png +</TD><TD> +           +</TD><TD> +\image html conditional.png +</TD></TR> +</TABLE></CENTER> +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. The condition, which is evaluated is a Python +expression. Should this expression not be valid, a message will be printed to +the display when the compiled code is executed. + +On evaluation of the compiled code, execution switches to the bottom (True +result) or right output (False result). +\subsection subsecDeath Death - terminate processing of this graph +The toolbar icon and a rendering of a drawing area shape for the "Death" +item is shown below. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html bitmaps/death.png +</TD><TD> +           +</TD><TD> +\image html current/Death.png +</TD></TR> +</TABLE></CENTER> + + + + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +On evaluation of the compiled code, execution of all elements in this graph +is terminated. All current or pending events are ignored. All outstanding +timers are ignored. + +If a worker node was created as part of procesing this graph, the node will +not be terminated by this item. + +There are some weird anomalies with this icon that illustrate the actual +processing of the graph. +Consider the three item graph in the figure +\image html deathexample.png + +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. The third item causes the id assigned to this +graph to be deleted. Of interest is that the request for a new node (from the +second item) is never sent to the SofaSwitch application. This happens because +the Twisted framework (that is used to process this graph) is waiting for +execution to fall into a \ref subsecEndProcessing item before sending messages +and handling timer/network events. Since execution fell into this "Death" +icon, which terminated the connection to the server for this graph, there is +no way messages can be sent. + + + + + + + + \subsection subsecEndCall End a call End a call to some external entity is indicated by the toolbar icon and drawing area image of @@ -121,22 +189,7 @@ -\subsection subsecEndEverything End Everything -The toolbar icon and a rendering of a drawing area shape for the "End Everything" -item is shown below. -<CENTER><TABLE frame=void border=0><TR><TD> -\image html bitmaps/death.png -</TD><TD> -           -</TD><TD> -\image html current/Death.png -</TD></TR> -</TABLE></CENTER> -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. @@ -144,25 +197,15 @@ - - - - - - - - - - \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. <CENTER><TABLE frame=void border=0><TR><TD> -\image html bitmaps/ControlsEndHere.png +\image html ControlsEndHere.png </TD><TD>            </TD><TD> -\image html current/endflow.png +\image html endflow.png </TD></TR> </TABLE></CENTER> @@ -289,13 +332,60 @@ +\subsection subsecLoadNewGraph Load new graph +The toolbar icon and a rendering of a drawing area shape for the "Load New +Graph" item is shown below. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html newgraph.png +</TD><TD> +           +</TD><TD> +\image html loadnewgraph.png +</TD></TR> +</TABLE></CENTER> +This item provides the means to extend one graph so that it can launch child +processes. It is similar to the C command "system", except that control +returns immediately to the parent process and does not wait for execution to +finish in the child process. +It is not similar to threads in C, as the child process does not have access +to the memory of the parent process. Nor is it similar to "fork()" in C, as +there is no duplication of the parent process. +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. We suggest that the tool tip is changed to contain +a short description of the child process that is to be launched. The second +box describes the name of the graph file which is to be executed in the child +process. The third box describes the Python variable which is to be passed to +the child process. +As a convenience, the child process always has a Python variable, +"self.parentId" defined, which contains the id of the child process. The child +may send a message (via the server) to the parent Id indicating status. +The graph in the figure +\image html exloadnewgraph.png +illustrates the operation of this item. There are two event handlers setup, +and on detection of the specified event, a new graph is loaded and +processed. Thus, one can handle different incoming calls with different +graphs. On the third kind of event, the \ref subsecDeath item is handled. +In a child graph, the terminate processing item will only end that child +graph, and that child graph Id. In the parent graph, the terminate processing +item will do one of two things +\li if the parent graph was directly created by running Python from the + command line, the parent and all child graphs are destroyed dead. +\li if the parent graph is itself a child graph, only the processing of the + parent graph is terminated. + + + + + + + \subsection subsecMakeCall Make a call Make a call to some external entity is indicated by the toolbar icon and drawing area image of @@ -329,7 +419,28 @@ +\subsection subsecPython Python command +Execution of an arbitrary Python command is indicated by the toolbar icon and drawing area +image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html Python.png +</TD><TD> +           +</TD><TD> +\image html python.png +</TD></TR> +</TABLE></CENTER> +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. It is suggested that you change the tool tip to +describe in a couple of words the purpose of the Python code. + +The arbitrary Python code which is to be executed is entered in the lower box +of the displayed window. You have access to all the internal variables used +in the execution of this graph. It is possible to simply put a print statement +in there as a debugging technique. It is encouraged that you put short, +quickly executed statements here, as all other actions are suspended while +processing this item. Added: sofaswitch/trunk/callflow/docs/exloadnewgraph.png ============================================================================== Binary file. No diff available.

1 0

[commit] r206 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 16 Nov '06

16 Nov '06

Author: derek Date: Wed Nov 15 23:24:37 2006 New Revision: 206 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Fix an incorrect statement. The correct statement is that the command hangup, or "End Call" in callflow terminology, causes a worker node to die. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Wed Nov 15 23:24:37 2006 @@ -87,10 +87,8 @@ endeavour to end a call not yet in existance, no damage will result. The remote worker node will ignore this command. -This command will not cause the remote worker node to die. Thus, one could -hangup the call, and then make a new call on the same worker node. - - +This command causes the remote worker node to die. Thus, one could +hangup the call, and then create a new worker node to make a new call. \subsection subsecEndFor End For Loop

1 0

[commit] r205 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 16 Nov '06

16 Nov '06

Author: derek Date: Wed Nov 15 23:20:36 2006 New Revision: 205 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Add description for more icons in the tool bar. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Wed Nov 15 23:20:36 2006 @@ -9,6 +9,7 @@ The control structures described in this page are \li \ref subsecConditional \li \ref subsecEndCall +\li \ref subsecEndFor \li \ref subsecEndEverything \li \ref subsecEndProcessing \li \ref subsecEventer @@ -17,6 +18,7 @@ \li \ref subsecReadFromFile \li \ref subsecRequestNode \li \ref subsecStartFlow +\li \ref subsecStartFor \li \ref subsecTimer \li \ref subsecTransferMedia \li \ref subsecWriteToFile @@ -91,6 +93,36 @@ +\subsection subsecEndFor End For Loop + +The end for loop item is indicated by the toolbar icon and drawing area +image of + +<CENTER><TABLE frame=void border=0><TR><TD> +\image html Controlsend_for.png +</TD><TD> +           +</TD><TD> +\image html endfor.png +</TD></TR> +</TABLE></CENTER> + + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. There are no other options relevant to this +icon. All initialisation and loop increments are handled in the \ref +subsecStartFor item. + +Remember that if you set up a busy wait loop where execution cannot move into +an \ref subsecEndProcessing item, there will be no sending of messages, and no +event handling. + + + + + + + \subsection subsecEndEverything End Everything The toolbar icon and a rendering of a drawing area shape for the "End Everything" item is shown below. @@ -435,6 +467,52 @@ +\subsection subsecStartFor Start For Loop + +The start for loop item is indicated by the toolbar icon and drawing area +image of + +<CENTER><TABLE frame=void border=0><TR><TD> +\image html Controlsfor.png +</TD><TD> +           +</TD><TD> +\image html startfor.png +</TD></TR> +</TABLE></CENTER> + + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The second box describes the initialisation code. Note that all elements of +this graph will have access to the variable used here. The termination test +and increment are in the second and third boxes. + +The flow of execution is identical to that in the for loop of C. The +initialisation is done, and then the test is carried out. If the test returns +True, execution moves to the item directly below the start for loop. If +the test returns False, execution moves to the connected \ref subsecEndFor and +down. + +At the end of the loop, execution moves back from the connected \ref +subsecEndFor, the increment is carried out, and then the test is +performed. Execution moves to the next item as before. + +It is entirely legal to set up a for loop where there is no initialisation +statement, the test returns True, and no increment statement. In this case, +you have a loop that will run for ever. The graph should include some path +that will take the execution away from this loop. + +Remember that if you set up a busy wait loop where execution cannot move into +an \ref subsecEndProcessing item, there will be no sending of messages, and no +event handling. + + + + + + \subsection subsecTimer Timer A timer is indicated by the toolbar icon and drawing area image of <CENTER><TABLE frame=void border=0><TR><TD> @@ -530,6 +608,11 @@ controller is managing an incoming voip call. The voip call can be connected to an answering machine, then to a conference room, then to second voip call etc. In this way, one can get the controller to replicate an IVR system. + + + + + \subsection subsecWriteToFile Write to file Write to file is an answering machine specific function, and is indicated by

1 0

[commit] r204 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 15 Nov '06

15 Nov '06

Author: derek Date: Wed Nov 15 16:02:54 2006 New Revision: 204 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Add docs on the transfer media command. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Wed Nov 15 16:02:54 2006 @@ -18,6 +18,7 @@ \li \ref subsecRequestNode \li \ref subsecStartFlow \li \ref subsecTimer +\li \ref subsecTransferMedia \li \ref subsecWriteToFile All of the control structures in this application have optional parameters. @@ -484,6 +485,52 @@ +\subsection subsecTransferMedia Transfer Media +Transfer media is relevant to all worker nodes in a running SofaSwitch +installation, and is indicated by +the toolbar icon and drawing area image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html transfermedia.png +</TD><TD> +           +</TD><TD> +\image html TransferMedia.png +</TD></TR> +</TABLE></CENTER> + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The second and third boxes of the window describe the two sofa switch worker +nodes which need to send audio between them. + +To illustrate, suppose we wish to record an incoming voip call. In this case, +we will request&create a voip and an answering machine node. Then, issue this +command to one of the two created nodes. It is not our responsibility to worry +abount media format, or ports/addresses. It is our responsibility to issue the +connect command. + +Alternatively, suppose we wish to connect one TDM (standard phone line) call +to another TDM call. In this case, both TDM worker nodes happen to be on the +same machine, via the same phone card. On reception of the Transfer Media +command, the nodes will do a direct bridging of the audio between them. + +From the \ref subsecRequestNode subsection, we noted that a worker node will +exist for two seconds, and if not used in that time is silently deleted. One +way of preventing that death is to do a Transfer Media command to that node +just created. + +Transfer Media has some peculiar aspects. It is quite acceptable to create a +voip node, and transfer media back to the same voip node. In this case, the +remote h.323 endpoint will hear their audio echoed back to them. It is also +acceptable to specify an incorrect id of the second node. Thus, create a voip +node,and then issue the transfer media command to a non existantant id. + +It is acceptable to issue multiple Transfer Media commands. Thus, suppose the +controller is managing an incoming voip call. The voip call can be connected +to an answering machine, then to a conference room, then to second voip call +etc. In this way, one can get the controller to replicate an IVR system. + \subsection subsecWriteToFile Write to file Write to file is an answering machine specific function, and is indicated by the toolbar icon and drawing area image of @@ -511,7 +558,7 @@ Should you specify an invalid file to write to, no audio will be written. -You may specify the file in which to write audio to at any time after the creation of the -answering machine worker node. +You may specify the file in which to write audio to at any time after the +creation of the answering machine worker node. */ \ No newline at end of file

1 0

[commit] r203 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 15 Nov '06

15 Nov '06

Author: derek Date: Wed Nov 15 14:48:40 2006 New Revision: 203 Added: sofaswitch/trunk/callflow/docs/current/TransferMedia.png (contents, props changed) Removed: sofaswitch/trunk/callflow/docs/current/transfermedia.png Log: Rename file. Added: sofaswitch/trunk/callflow/docs/current/TransferMedia.png ============================================================================== Binary file. No diff available.

1 0

[commit] r202 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 15 Nov '06

15 Nov '06

Author: derek Date: Tue Nov 14 19:25:36 2006 New Revision: 202 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Update to describe more of the items on the screen, and in alphabetical order. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Tue Nov 14 19:25:36 2006 @@ -17,6 +17,7 @@ \li \ref subsecReadFromFile \li \ref subsecRequestNode \li \ref subsecStartFlow +\li \ref subsecTimer \li \ref subsecWriteToFile All of the control structures in this application have optional parameters. @@ -28,67 +29,40 @@ can specify a string, which is indicated by placing double quotes at either end. Which makes (for example) "voip" a valid string Python code. -\subsection subsecStartFlow Initiate graph processing -Start of graph processing is indicated by the toolbar icon and drawing area -image of + + + +\subsection subsecConditional Conditional execution +The toolbar icon and a rendering of a drawing area shape for the "Conditional" +item is shown below. <CENTER><TABLE frame=void border=0><TR><TD> -\image html Controlsstart.png +\image html ControlsIf.png </TD><TD>            </TD><TD> -\image html startflow.png +\image html conditional.png </TD></TR> </TABLE></CENTER> +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. The condition, which is evaluated is a Python +expression. Should this expression not be valid, a message will be printed to +the display when the compiled code is executed. + +On evaluation of the compiled code, execution switches to the bottom (True +result) or right output (False result). -When this graph is processed, this item indicates that a new identity on the -server will be created, for each item on this graph to communicate with. Thus, -on instantiation, this graph will be identified as identity \c c290 (say). Any -messages sent via the server will be labelled as being sent by \c c290. -It is mandatory that there is only one of these items on each graph. Placing -more than Start of graph processing item on the drawing area is ambiguous - -where would call processing start ? -\subsection subsecJoinObjects Join items on the drawing area -The toolbar icon and a possible rendering of a drawing area shape is shown below. -<CENTER><TABLE frame=void border=0><TR><TD> -\image html JoinObjects.png -</TD><TD> -           -</TD><TD> -\image html joinlines.png -</TD></TR> -</TABLE></CENTER> -Items on the drawing screen may be joined directly - one to another, or joined -with this structure, which is multiline segment object. -Select the toolbar icon, move to the drawing area, and left click to mark the -points on the shape and complete with the right mouse button. -Once completed, you may move the shape by selecting it with the left button -or shift left to select multiple objects. -When there is a valid connection at both ends of this object, a filled black -circle is drawn at each end. -It is entirely valid to have the output of several items connected to one -item. Thus, of the the following two shapes, the left is valid, -<CENTER><TABLE frame=void border=0><TR><TD> -\image html validjoinexample.png -</TD><TD> -           -</TD><TD> -\image html faultyjoinexample.png -</TD></TR> -</TABLE></CENTER> -and the right shape is wrong. The key problem with the right shape is that it -is ambiguous, since it is not clear where the flow of execution -should go. In this example, it would "work", in that there is no -difference if either path is followed. + + \subsection subsecEndCall End a call End a call to some external entity is indicated by the toolbar icon and drawing area image of @@ -114,41 +88,89 @@ hangup the call, and then make a new call on the same worker node. -\subsection subsecRequestNode Request Node -The toolbar icon and a rendering of a drawing area shape for the "Request Node" + +\subsection subsecEndEverything End Everything +The toolbar icon and a rendering of a drawing area shape for the "End Everything" item is shown below. <CENTER><TABLE frame=void border=0><TR><TD> -\image html RequestNode.png +\image html bitmaps/death.png </TD><TD>            </TD><TD> -\image html requestnode.png +\image html current/Death.png </TD></TR> </TABLE></CENTER> -Request Node is a key component of the SofaSwitch suite of applications. With -this item, the controller asks the designated application to supply one worker -node for use by this call graph. Alternatively, this is the mechanism by which -this call graph gets remote entities who can handle media data. +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. -Once created, the requested worker has a lifetime of 2 seconds. This lifetime is -set by the designated application. If the requested worker is not acknowledged -after 2 seconds, it is destroyed by the designated application. -On receiving advise the node has been created, and its identity, this call -graph can advise the node to "transfer media to itself". Once this command is -made, the requested node is safe from death by timeout. -The Right Mouse Button on this request node shape brings up a menu box. You -may adjust the Tool Tip accordingly - I prefer to change this to indicate -who/what I am requesting a node from. The timer period here is a float, which -indicates how many seconds we will wait for a reply. The timer which runs is -labelled by the above string, which is used in the comparison of an eventer -box \ref subsecEventer. The additional information field is used to provide -details that some SofaSwitch applications want. For example, the conference -utility needs information on which room the node should be in. + + + + + + + + + + + + + +\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. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html bitmaps/ControlsEndHere.png +</TD><TD> +           +</TD><TD> +\image html current/endflow.png +</TD></TR> +</TABLE></CENTER> + +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, external +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 the "End Graph Processing" +item. + +When execution is in the "End Graph Processing" item, waiting for an event to +happen, there is no CPU penalty. + +Consider the following graph. +\image html faultyendprocessing.png "Permanent stuckly in End Graph Processing" + +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 sit idle, until it is terminated by user +intervention. + + + + + + + + + + + + + + + + + \subsection subsecEventer Event Collection The toolbar icon and a rendering of a drawing area shape for the "Event Collection" item is shown below. @@ -186,76 +208,63 @@ button. To illustrate, after a DTMF event, the Python variable will hold the particular DTMF value that was detected. -\subsection subsecEndEverything End Everything -The toolbar icon and a rendering of a drawing area shape for the "End Everything" -item is shown below. + + + + + + + + +\subsection subsecJoinObjects Join items +The toolbar icon and a possible rendering of a drawing area shape is shown below. <CENTER><TABLE frame=void border=0><TR><TD> -\image html bitmaps/death.png +\image html JoinObjects.png </TD><TD>            </TD><TD> -\image html current/Death.png +\image html joinlines.png </TD></TR> </TABLE></CENTER> -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. +Items on the drawing screen may be joined directly - one to another, or joined +with this structure, which is multiline segment object. +Select the toolbar icon, move to the drawing area, and left click to mark the +points on the shape and complete with the right mouse button. +Once completed, you may move the shape by selecting it with the left button +or shift left to select multiple objects. -\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. +When there is a valid connection at both ends of this object, a filled black +circle is drawn at each end. + +It is entirely valid to have the output of several items connected to one +item. Thus, of the the following two shapes, the left is valid, + <CENTER><TABLE frame=void border=0><TR><TD> -\image html bitmaps/ControlsEndHere.png +\image html validjoinexample.png </TD><TD>            </TD><TD> -\image html current/endflow.png +\image html faultyjoinexample.png </TD></TR> </TABLE></CENTER> -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, external -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 the "End Graph Processing" -item. +and the right shape is wrong. The key problem with the right shape is that it +is ambiguous, since it is not clear where the flow of execution +should go. In this example, it would "work", in that there is no +difference if either path is followed. -When execution is in the "End Graph Processing" item, waiting for an event to -happen, there is no CPU penalty. -Consider the following graph. -\image html faultyendprocessing.png "Permanent stuckly in End Graph Processing" -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 sit idle, until it is terminated by user -intervention. -\subsection subsecConditional Conditional execution -The toolbar icon and a rendering of a drawing area shape for the "Conditional" -item is shown below. -<CENTER><TABLE frame=void border=0><TR><TD> -\image html ControlsIf.png -</TD><TD> -           -</TD><TD> -\image html conditional.png -</TD></TR> -</TABLE></CENTER> -On clicking the right mouse button on this shape, a window comes up. The tool -tip is as described before. The condition, which is evaluated is a Python -expression. Should this expression not be valid, a message will be printed to -the display when the compiled code is executed. - -On evaluation of the compiled code, execution switches to the bottom (True -result) or right output (False result). + + + + + \subsection subsecMakeCall Make a call Make a call to some external entity is indicated by the toolbar icon and drawing area image of @@ -284,6 +293,18 @@ getting the voip node to make a call to "h323:127.0.0.1". + + + + + + + + + + + + \subsection subsecReadFromFile Read from file Read from file is an answering machine specific function, and is indicated by the toolbar icon and drawing area image of @@ -316,6 +337,103 @@ answering machine worker node. + + + + + + + + + + + + + + + + + + + +\subsection subsecRequestNode Request Node + +The toolbar icon and a rendering of a drawing area shape for the "Request Node" +item is shown below. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html RequestNode.png +</TD><TD> +           +</TD><TD> +\image html requestnode.png +</TD></TR> +</TABLE></CENTER> + +Request Node is a key component of the SofaSwitch suite of applications. With +this item, the controller asks the designated application to supply one worker +node for use by this call graph. Alternatively, this is the mechanism by which +this call graph gets remote entities who can handle media data. + +Once created, the requested worker has a lifetime of 2 seconds. This lifetime is +set by the designated application. If the requested worker is not acknowledged +after 2 seconds, it is destroyed by the designated application. + +On receiving advise the node has been created, and its identity, this call +graph can advise the node to "transfer media to itself". Once this command is +made, the requested node is safe from death by timeout. + +The Right Mouse Button on this request node shape brings up a menu box. You +may adjust the Tool Tip accordingly - I prefer to change this to indicate +who/what I am requesting a node from. The timer period here is a float, which +indicates how many seconds we will wait for a reply. The timer which runs is +labelled by the above string, which is used in the comparison of an eventer +box \ref subsecEventer. The additional information field is used to provide +details that some SofaSwitch applications want. For example, the conference +utility needs information on which room the node should be in. + + + + + + + + + + + + + + + + + + + +\subsection subsecStartFlow Initiate graph processing +Start of graph processing is indicated by the toolbar icon and drawing area +image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html Controlsstart.png +</TD><TD> +           +</TD><TD> +\image html startflow.png +</TD></TR> +</TABLE></CENTER> + + +When this graph is processed, this item indicates that a new identity on the +server will be created, for each item on this graph to communicate with. Thus, +on instantiation, this graph will be identified as identity \c c290 (say). Any +messages sent via the server will be labelled as being sent by \c c290. + +It is mandatory that there is only one of these items on each graph. Placing +more than Start of graph processing item on the drawing area is ambiguous - +where would call processing start ? + + + + \subsection subsecTimer Timer A timer is indicated by the toolbar icon and drawing area image of <CENTER><TABLE frame=void border=0><TR><TD> @@ -327,6 +445,7 @@ </TD></TR> </TABLE></CENTER> + On clicking the right mouse button on this shape, a window comes up. The tool tip is as described before. @@ -334,7 +453,35 @@ number here with an exponent, or a python variable. Thus, one would specify a delay of 1200 milliseconds as 1.2. -The label one applies to the timer is specified on the +The label one applies to the timer is specified in the last field of the +displayed window. This label is applied to timers generated by this particular +graph, and should only be unique to this graph. Timer events which are +generated when processing a different graph are never passed to this graph. + +We have supplied an example timerlabel of self.myId + "thistimer". The Python +variable self.myId is the string id the server applied to this particular +graph. The text "thistimer" is a string we generated to differentiate two +timers on the same graph. + + + + + + + + + + + + + + + + + + + + \subsection subsecWriteToFile Write to file

1 0

[commit] r201 - in sofaswitch/trunk/callflow: docs/current src tests
by SofaSWITCH SVN 15 Nov '06

15 Nov '06

Author: derek Date: Tue Nov 14 19:05:53 2006 New Revision: 201 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy sofaswitch/trunk/callflow/src/eventer.cpp sofaswitch/trunk/callflow/src/python.cpp sofaswitch/trunk/callflow/src/shapelist.cpp sofaswitch/trunk/callflow/src/timer.cpp sofaswitch/trunk/callflow/tests/timetest.src Log: Adjust timer to work on python code. Make the reading of the graph file more robust. Make the timer more robust to cope with incorrect user input. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Tue Nov 14 19:05:53 2006 @@ -8,6 +8,7 @@ The control structures described in this page are \li \ref subsecConditional +\li \ref subsecEndCall \li \ref subsecEndEverything \li \ref subsecEndProcessing \li \ref subsecEventer @@ -88,8 +89,31 @@ should go. In this example, it would "work", in that there is no difference if either path is followed. +\subsection subsecEndCall End a call +End a call to some external entity is indicated by the toolbar icon and drawing area +image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html endcall.png +</TD><TD> +           +</TD><TD> +\image html EndCall.png +</TD></TR> +</TABLE></CENTER> +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. +The worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation, and is currently in a call +to some external entity. Note that while it is incorrect operation to +endeavour to end a call not yet in existance, no damage will result. The +remote worker node will ignore this command. + +This command will not cause the remote worker node to die. Thus, one could +hangup the call, and then make a new call on the same worker node. + + \subsection subsecRequestNode Request Node The toolbar icon and a rendering of a drawing area shape for the "Request Node" @@ -290,6 +314,27 @@ You may specify the file to read from at any time after the creation of the answering machine worker node. + + +\subsection subsecTimer Timer +A timer is indicated by the toolbar icon and drawing area image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html miniclock.png +</TD><TD> +           +</TD><TD> +\image html starttimer.png +</TD></TR> +</TABLE></CENTER> + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The time period is specified in units of seconds. You may use a floating point +number here with an exponent, or a python variable. Thus, one would specify a +delay of 1200 milliseconds as 1.2. + +The label one applies to the timer is specified on the \subsection subsecWriteToFile Write to file Modified: sofaswitch/trunk/callflow/src/eventer.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/eventer.cpp (original) +++ sofaswitch/trunk/callflow/src/eventer.cpp Tue Nov 14 19:05:53 2006 @@ -163,7 +163,8 @@ file.AddLine(wxString::Format(" %s, ", outputLabel2.c_str())); file.AddLine(wxString::Format(" \"Event Python\" : ")); - file.AddLine(wxString::Format(" \"%s\", ", displayData[1].data.c_str())); + wxString dest = ProtectString(displayData[1].data); + file.AddLine(wxString::Format(" \"%s\", ", dest.c_str())); file.AddLine(wxString::Format(" \"Event RegExp\" : ")); file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str())); @@ -178,6 +179,6 @@ bool DndShapeEventer::CheckOutputPointsLinked() { - return outputPoints.PointLinked(0); + return outputPoints.PointLinked(0) && outputPoints.PointLinked(1); } Modified: sofaswitch/trunk/callflow/src/python.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/python.cpp (original) +++ sofaswitch/trunk/callflow/src/python.cpp Tue Nov 14 19:05:53 2006 @@ -20,11 +20,11 @@ DndShapePython::DndShapePython() : DndShape(Python) { - wxSize newSize(50, 50); + wxSize newSize(32, 60); SetSize(newSize); - relInputPoints.Add(25, 0); - relOutputPoints.Add(25, 50); + relInputPoints.Add(16, 0); + relOutputPoints.Add(16, 50); displayData[displayData.size()] = InformationSection(wxT("Python Code"), wxT("self.i = 0")); @@ -39,17 +39,17 @@ dc.SetPen(*wxBLACK_PEN); wxPoint p1(m_rect.GetPosition()); - wxPoint pA(p1.x + 25, p1.y + 9); - wxPoint pB(p1.x + 25, p1.y + 0); - wxPoint pC(p1.x + 25, p1.y + 50); - wxPoint pD(p1.x + 25, p1.y + 41); + wxPoint pA(p1.x + 16, p1.y + 14); + wxPoint pB(p1.x + 16, p1.y + 0); + wxPoint pC(p1.x + 16, p1.y + 60); + wxPoint pD(p1.x + 16, p1.y + 46); DrawArrow(dc, pA, ArrowDown, InputPointConnected(0) ? Connected : Loose); DrawArrow(dc, pC, ArrowDown, OutputPointConnected(0) ? Connected : Loose); dc.DrawLine(pA, pB); dc.DrawLine(pD, pC); - dc.DrawBitmap(Python_xpm, p1.x + 9, p1.y + 9, true); + dc.DrawBitmap(Python_xpm, p1.x, p1.y + 14, true); DndShape::Draw(dc); } Modified: sofaswitch/trunk/callflow/src/shapelist.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/shapelist.cpp (original) +++ sofaswitch/trunk/callflow/src/shapelist.cpp Tue Nov 14 19:05:53 2006 @@ -330,7 +330,11 @@ file.AddLine(" \"\"\" "); file.AddLine(" self.gd=open(graphFile, \"r\"); "); file.AddLine(" self.gdc=self.gd.read() "); - file.AddLine(" self.data = eval(self.gdc) "); + file.AddLine(" try: "); + file.AddLine(" self.data = eval(self.gdc) "); + file.AddLine(" except: "); + file.AddLine(" print \"Failed to evaluate (as Python) the supplied graph file of \", graphFile"); + file.AddLine(" return "); file.AddLine(" self.gd.close() "); file.AddLine(" "); file.AddLine(" self.firstNode = None "); Modified: sofaswitch/trunk/callflow/src/timer.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/timer.cpp (original) +++ sofaswitch/trunk/callflow/src/timer.cpp Tue Nov 14 19:05:53 2006 @@ -38,10 +38,10 @@ relOutputPoints.Add(25, 50); displayData[displayData.size()] = - InformationSection(wxT("Timer period (seconds)"), wxT("2")); + InformationSection(wxT("Timer period (seconds, Python code)"), wxT("2")); displayData[displayData.size()] = - InformationSection(wxT("Timer label (string literal)"), wxT("thistimer")); + InformationSection(wxT("Timer label (Python code)"), wxT("self.myId + \"thistimer\"")); AdjustIoPoints(); } @@ -59,6 +59,7 @@ { dc.SetPen(*wxBLACK_PEN); DrawCompileError(dc); + dc.SetPen(*wxBLACK_PEN); wxPoint p1(m_rect.GetPosition()); wxPoint pA(p1.x + 25, p1.y + 0); @@ -88,12 +89,22 @@ bool DndShapeTimer::WriteSystemCode(wxTextFile & file) { - file.AddLine(" def Timer(self, sTuple): "); - file.AddLine(" a,b,c = sTuple"); - file.AddLine(" eName = self.data[a][\"Timer label\"] "); - file.AddLine(" self.pendingEvents[eName] = a "); - file.AddLine(" reactor.callLater(self.data[a][\"Timer period\"], self.timerObjectExpired, eName)"); - file.AddLine(" return self.data[a][\"Output\"]"); + file.AddLine(" def Timer(self, sTuple): "); + file.AddLine(" a,b,c = sTuple "); + file.AddLine(" try: "); + file.AddLine(" eName = eval(self.data[a][\"Timer label\"]) "); + file.AddLine(" except: "); + file.AddLine(" print \"The timer label of \", self.data[a][\"Timer label\"], \" was unintelligible Python\" "); + file.AddLine(" return self.data[a][\"Output\"] "); + file.AddLine(" self.pendingEvents[eName] = a "); + file.AddLine(" try: "); + file.AddLine(" self.period = eval (self.data[a][\"Timer period\"]) "); + file.AddLine(" except: "); + file.AddLine(" print \"The timer period of \", self.data[a][\"Timer period\"], \" was unintelligible\" "); + file.AddLine(" return self.data[a][\"Output\"] "); + file.AddLine(" "); + file.AddLine(" reactor.callLater(self.period, self.timerObjectExpired, eName) "); + file.AddLine(" return self.data[a][\"Output\"] "); file.AddLine(""); return true; @@ -114,10 +125,12 @@ file.AddLine(wxString::Format(" %s, ", outputLabel.c_str())); file.AddLine(wxString::Format(" \"Timer period\" : ")); - file.AddLine(wxString::Format(" %s, ", displayData[1].data.c_str())); + wxString dest = ProtectString(displayData[1].data); + file.AddLine(wxString::Format(" \"%s\", ", dest.c_str())); file.AddLine(wxString::Format(" \"Timer label\" : ")); - file.AddLine(wxString::Format(" \"%s\", ", displayData[2].data.c_str())); + dest = ProtectString(displayData[2].data); + file.AddLine(wxString::Format(" \"%s\", ", dest.c_str())); file.AddLine(wxString::Format(" },")); Modified: sofaswitch/trunk/callflow/tests/timetest.src ============================================================================== --- sofaswitch/trunk/callflow/tests/timetest.src (original) +++ sofaswitch/trunk/callflow/tests/timetest.src Tue Nov 14 19:05:53 2006 @@ -1 +1 @@ -12<B>335<B>275<B> extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>10<ms><special>Timer label (string literal)<ms>t10<ms><special> <B><Shape>10<B>334<B>370<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t10 ", time.asctime(), " data is ", self.timer3<ms><special> <B><Shape>2<B>204<B>419<B> extra <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>10<B>126<B>221<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t1 ", time.asctime(), " data is ", self.timer1Data<ms><special> <B><Shape>9<B>231<B>351<B>232,351,231,422<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>12<B>207<B>202<B> extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>2<ms><special>Timer label<ms>timer2<ms><special> <B><Shape>14<B>139<B>179<B> extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>timer1<ms><special>Python variable to hold event data<ms>self.timer1Data<ms><special> <B><Shape>9<B>188<B>201<B>188,201,231,202<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>20<B>346<B>417<B> extra <special>Tool Tip<ms>Death<ms><special> <B><Shape>12<B>127<B>125<B> extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>timer1<ms><special> <B><Shape>10<B>207<B>305<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t2 ", time.asctime(), " data is ", self.timer2<ms><special> <B><Shape>10<B>123<B>74<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "Start ", time.asctime()<ms><special> <B><Shape>1<B>123<B>26<B> extra <special>Tool Tip<ms>Start Processing<ms><special> <B><Shape>9<B>150<B>271<B>150,271,152,406,223,407,229,423<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>14<B>347<B>327<B> extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>10<ms><special>Python variable to hold event data<ms>self.timer3<ms><special> <B><Shape>9<B>270<B>278<B>270,280,359,278<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>14<B>220<B>256<B> extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>timer2<ms><special>Python variable to hold event data<ms>self.timer2<ms><special> <B><Shape> +10<B>36<B>110<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "Start ", time.asctime()<ms><special> <B><Shape>9<B>150<B>271<B>150,271,152,406,223,407,229,423<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>9<B>188<B>201<B>188,201,231,202<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>2<B>394<B>380<B> extra <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>12<B>333<B>273<B> extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds, Python code)<ms>self.gap<ms><special>Timer label (Python code)<ms>self.myId + "thistimer"<ms><special> <B><Shape>10<B>214<B>303<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t2 ", time.asctime(), " data is ", self.timer2<ms><special> <B><Shape>14<B>139<B>179<B> extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>timer1<ms><special>Python variable to hold event data<ms>self.timer1Data<ms><special> <B><Shape>14<B>347<B>327<B> extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms>self.myId + "thistimer"<ms><special>Event sought (Regular Exp)<ms><ms><special>Python variable to hold event data<ms>self.timer3<ms><special> <B><Shape>20<B>346<B>417<B> extra <special>Tool Tip<ms>Death<ms><special> <B><Shape>10<B>36<B>158<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>self.gap=10<ms><special> <B><Shape>10<B>133<B>218<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t1 ", time.asctime(), " data is ", self.timer1Data<ms><special> <B><Shape>14<B>220<B>256<B> extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>timer2<ms><special>Python variable to hold event data<ms>self.timer2<ms><special> <B><Shape>9<B>231<B>351<B>232,351,231,422<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>9<B>271<B>275<B>271,277,360,275<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>10<B>342<B>368<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t10 ", time.asctime(), " data is ", self.timer3<ms><special> <B><Shape>2<B>204<B>419<B> extra <special>Tool Tip<ms>End Processing<ms><special> <B><Shape>12<B>29<B>207<B> extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds, Python code)<ms>1.95<ms><special>Timer label (Python code)<ms>"timer1"<ms><special> <B><Shape>9<B>399<B>349<B>399,349,420,352,418,379<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>9<B>54<B>157<B>153,177,156,157,105,167,73,282,57,279,54,254<special>Tool Tip<ms>Join blocks shape<ms><special> <B><Shape>1<B>28<B>63<B> extra <special>Tool Tip<ms>Start Processing<ms><special> <B><Shape>12<B>209<B>203<B> extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds, Python code)<ms>2<ms><special>Timer label (Python code)<ms>"timer2"<ms><special> <B><Shape>

1 0

[commit] r200 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 14 Nov '06

14 Nov '06

Author: derek Date: Tue Nov 14 17:20:10 2006 New Revision: 200 Added: sofaswitch/trunk/callflow/docs/current/EndCall.png (contents, props changed) Removed: sofaswitch/trunk/callflow/docs/current/endcall.png sofaswitch/trunk/callflow/docs/current/makecall.png Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Rename a file, to remove name clash with bitmaps/endcall.png Added: sofaswitch/trunk/callflow/docs/current/EndCall.png ============================================================================== Binary file. No diff available. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Tue Nov 14 17:20:10 2006 @@ -6,6 +6,27 @@ area. We describe each of them in this page of the manual. Also described is how one would use each structure within a call flow diagram. +The control structures described in this page are +\li \ref subsecConditional +\li \ref subsecEndEverything +\li \ref subsecEndProcessing +\li \ref subsecEventer +\li \ref subsecJoinObjects +\li \ref subsecMakeCall +\li \ref subsecReadFromFile +\li \ref subsecRequestNode +\li \ref subsecStartFlow +\li \ref subsecWriteToFile + +All of the control structures in this application have optional parameters. +Usually, these are string, with no quotes required, and this is the case for +parameters such as tool tips. +Sometimes, the parameters are labelled as being python code. In this case, you +can specifiy a python variable, so a possible value could be self.amNode +(where self.amNode has been previously set to some value). Alternatively, you +can specify a string, which is indicated by placing double quotes at either +end. Which makes (for example) "voip" a valid string Python code. + \subsection subsecStartFlow Initiate graph processing Start of graph processing is indicated by the toolbar icon and drawing area image of @@ -202,6 +223,103 @@ </TD></TR> </TABLE></CENTER> +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. The condition, which is evaluated is a Python +expression. Should this expression not be valid, a message will be printed to +the display when the compiled code is executed. + +On evaluation of the compiled code, execution switches to the bottom (True +result) or right output (False result). + +\subsection subsecMakeCall Make a call +Make a call to some external entity is indicated by the toolbar icon and drawing area +image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html makecall.png +</TD><TD> +           +</TD><TD> +\image html MakeCall.png +</TD></TR> +</TABLE></CENTER> + + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation. + +The call destination is somewhere capable of receiving a call. For a voip +call, one possible destination is the H323 test site set up by Craig +Southeren, which is given as "h323:h323.voxgratia.org" + +One possible call destination that was used during testing is the voip node +itself. I setup multiple concurrent incoming and outgoing calls, simply by +getting the voip node to make a call to "h323:127.0.0.1". + + +\subsection subsecReadFromFile Read from file +Read from file is an answering machine specific function, and is indicated by +the toolbar icon and drawing area image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html readfromfile.png +</TD><TD> +           +</TD><TD> +\image html playfromfile.png +</TD></TR> +</TABLE></CENTER> + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation. + +This control structure causes the designated answering machine node to read +audio from the wave file (format S16_LE). The answering machine node will send +this audio to worker connected to it. + +You may switch an answering machine node to read from a different file at any time. +Multiple answering machine node may read from the same file at the same time. + +Should you specify an invalid file to read from no audio will be sent by this +worker node. + +You may specify the file to read from at any time after the creation of the +answering machine worker node. + + +\subsection subsecWriteToFile Write to file +Write to file is an answering machine specific function, and is indicated by +the toolbar icon and drawing area image of +<CENTER><TABLE frame=void border=0><TR><TD> +\image html writetofile.png +</TD><TD> +           +</TD><TD> +\image html playfromfile.png +</TD></TR> +</TABLE></CENTER> + +On clicking the right mouse button on this shape, a window comes up. The tool +tip is as described before. + +The worker node is a preexisting node on some external application that was +created in response to a "Request Node" operation. + +This control structure causes the designated answering machine node to write +audio to the wave file (format S16_LE). + +You may switch an answering machine node to write to a different file at any +time. On switching files, the answering machine node will close the current +file and attempt to use the new file. + +Should you specify an invalid file to write to, no audio will be written. + +You may specify the file in which to write audio to at any time after the creation of the +answering machine worker node. */ \ No newline at end of file

1 0

[commit] r199 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 14 Nov '06

14 Nov '06

Author: derek Date: Tue Nov 14 16:44:04 2006 New Revision: 199 Added: sofaswitch/trunk/callflow/docs/current/MakeCall.png (contents, props changed) Log: Rename this file from makecall.png Added: sofaswitch/trunk/callflow/docs/current/MakeCall.png ============================================================================== Binary file. No diff available.

1 0

[commit] r198 - sofaswitch/trunk/callflow/docs/current
by SofaSWITCH SVN 14 Nov '06

14 Nov '06

Author: derek Date: Mon Nov 13 23:22:53 2006 New Revision: 198 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Add Conditional to it. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Mon Nov 13 23:22:53 2006 @@ -190,6 +190,18 @@ item. Consequently, this graph will sit idle, until it is terminated by user intervention. +\subsection subsecConditional Conditional execution +The toolbar icon and a rendering of a drawing area shape for the "Conditional" +item is shown below. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html ControlsIf.png +</TD><TD> +           +</TD><TD> +\image html conditional.png +</TD></TR> +</TABLE></CENTER> + */ \ No newline at end of file

1 0