- Sofaswitch-svn - FreeSWITCH Mailing Lists

[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 @@ -12335275 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>10<ms><special>Timer label (string literal)<ms>t10<ms><special> <Shape>10334370 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t10 ", time.asctime(), " data is ", self.timer3<ms><special> <Shape>2204419 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>10126221 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t1 ", time.asctime(), " data is ", self.timer1Data<ms><special> <Shape>9231351232,351,231,422<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>12207202 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>2<ms><special>Timer label<ms>timer2<ms><special> <Shape>14139179 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> <Shape>9188201188,201,231,202<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>20346417 extra <special>Tool Tip<ms>Death<ms><special> <Shape>12127125 extra <special>Tool Tip<ms>Timer<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>timer1<ms><special> <Shape>10207305 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t2 ", time.asctime(), " data is ", self.timer2<ms><special> <Shape>1012374 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "Start ", time.asctime()<ms><special> <Shape>112326 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>9150271150,271,152,406,223,407,229,423<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14347327 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> <Shape>9270278270,280,359,278<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14220256 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> <Shape> +1036110 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "Start ", time.asctime()<ms><special> <Shape>9150271150,271,152,406,223,407,229,423<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9188201188,201,231,202<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>2394380 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>12333273 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> <Shape>10214303 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t2 ", time.asctime(), " data is ", self.timer2<ms><special> <Shape>14139179 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> <Shape>14347327 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> <Shape>20346417 extra <special>Tool Tip<ms>Death<ms><special> <Shape>1036158 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>self.gap=10<ms><special> <Shape>10133218 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t1 ", time.asctime(), " data is ", self.timer1Data<ms><special> <Shape>14220256 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> <Shape>9231351232,351,231,422<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9271275271,277,360,275<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>10342368 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "t10 ", time.asctime(), " data is ", self.timer3<ms><special> <Shape>2204419 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>1229207 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> <Shape>9399349399,349,420,352,418,379<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>954157153,177,156,157,105,167,73,282,57,279,54,254<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>12863 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>12209203 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> <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

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

14 Nov '06

Author: derek Date: Mon Nov 13 23:18:02 2006 New Revision: 197 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Improve wording slightly. 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:18:02 2006 @@ -174,16 +174,20 @@ 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 this item. +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 +registers for some event, and then moves to the "End Graph Processing" item. Since there is no means of generating events which can be sent to this -call graph, execution will never move to the Event Collection -item. Consequently, this graph will run until it is terminated by user +call graph, execution will never move to the "Event Collection" +item. Consequently, this graph will sit idle, until it is terminated by user intervention.

1 0

[commit] r196 - in sofaswitch/trunk/callflow: docs/current tests
by SofaSWITCH SVN 14 Nov '06

14 Nov '06

Author: derek Date: Mon Nov 13 23:13:47 2006 New Revision: 196 Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy sofaswitch/trunk/callflow/tests/amplaywavfile.src Log: Work on documenting. Tidy up play wave file graph, because the death icon may not get called. Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/current/eachicon.dxy (original) +++ sofaswitch/trunk/callflow/docs/current/eachicon.dxy Mon Nov 13 23:13:47 2006 @@ -141,7 +141,23 @@ 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. +<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. + \subsection subsecEndProcessing End Graph Processing The toolbar icon and a rendering of a drawing area shape for the "End Graph Processing" item is shown below. @@ -157,5 +173,19 @@ This icon is provided as a means for temporarily holding up graph processing, while we wait for external events. If processing does fall into here, 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 this item. + +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 run until it is terminated by user +intervention. + + */ \ No newline at end of file Modified: sofaswitch/trunk/callflow/tests/amplaywavfile.src ============================================================================== --- sofaswitch/trunk/callflow/tests/amplaywavfile.src (original) +++ sofaswitch/trunk/callflow/tests/amplaywavfile.src Mon Nov 13 23:13:47 2006 @@ -1,3 +1,3 @@ -12990549 extra <special>Tool Tip<ms>Initiate a timer, which causes this to -end.<ms><special>Timer period (seconds)<ms>0.1<ms><special>Timer label (string literal)<ms>hanguptime<ms><special> <Shape>14251461 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>DTMF<ms><special>Python variable to hold event data<ms>self.dtmfData<ms><special> <Shape>16505364 extra <special>Tool Tip<ms>Play Rogers voice<ms><special>Filename to read audio from (Python code)<ms>"../prompts/sample_message.wav"<ms><special>answering machine node<ms>self.amNode<ms><special> <Shape>16516561 extra <special>Tool Tip<ms>initial wav file<ms><special>Filename to read audio from (Python code)<ms>"../prompts/instructions.wav"<ms><special>answering machine node<ms>self.amNode<ms><special> <Shape>2769426 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>9559339559,339,604,342<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>1119167 extra <special>Tool Tip<ms>Request Node from AM module<ms><special>Request node from (Python code)<ms>"am"<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>requestam<ms><special>Additional information (Python code)<ms><ms><special> <Shape>5660332 extra <special>Tool Tip<ms>play entering sound<ms><special>Test (Python code)<ms>self.dtmfData=="2"<ms><special> <Shape>5241359 extra <special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<ms>(self.amNode != None) and (self.soundNode != None)<ms><special> <Shape>10507259 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "dtmf received of ", self.dtmfData<ms><special> <Shape>20529662 extra <special>Tool Tip<ms>Death<ms><special> <Shape>13190210 extra <special>Tool Tip<ms>Stop Timer<ms><special>Timer to stop<ms>request voip<ms><special> <Shape>7989497 extra <special>Tool Tip<ms>End Call<ms><special>Worker node to activate (python code)<ms>self.amNode<ms><special> <Shape>910393861039,386,1082,387<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>5507312 extra <special>Tool Tip<ms>Test Roger voice<ms><special>Test (Python code)<ms>self.dtmfData=="1"<ms><special> <Shape>9266329308,329,266,359<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>13284231 extra <special>Tool Tip<ms>Stop Timer<ms><special>Timer to stop<ms>request sound<ms><special> <Shape>9712318712,358,755,361,750,320,793,318,798,333<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9291382291,386,334,382,332,395<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>5581341 extra <special>Tool Tip<ms>Repeat instructions<ms><special>Test (Python code)<ms>self.dtmfData=="4"<ms><special> <Shape>10990405 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "hangup, as dtmf 9 has been received"<ms><special> <Shape>9632318632,366,638,319,685,318,685,330<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14202162 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>amREQ<ms><special>Python variable to hold event data<ms>self.amNode<ms><special> <Shape>9214304214,304,262,356<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>15240412 extra <special>Tool Tip<ms>Transfer Media<ms><special>First SofaSwitch worker (python)<ms>self.amNode<ms><special>Second SofaSwitch worker (python)<ms>self.soundNode<ms><special> <Shape>2659427 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>15989451 extra <special>Tool Tip<ms>Transfer Media<ms><special>First SofaSwitch worker (python)<ms>"sound"<ms><special>Second SofaSwitch worker (python)<ms>"sound"<ms><special> <Shape>14295185 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>soundREQU<ms><special>Python variable to hold event data<ms>self.soundNode<ms><special> <Shape>9302485302,485,544,492,542,506<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9821356821,357,977,357,1018,356<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>5770331 extra <special>Tool Tip<ms>play leaving sound<ms><special>Test (Python code)<ms>self.dtmfData=="3"<ms><special> <Shape>14529614 extra <special>Tool Tip<ms>Catch the timer which, when fired, -indicates the end of this call<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>hanguptime<ms><special>Python variable to hold event data<ms>self.hanguptime<ms><special> <Shape>9248182248,183,308,182<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>17516509 extra <special>Tool Tip<ms>Write To File<ms><special>Filename to contain new audio (Python code)<ms>"recorded_audio.wav"<ms><special>answering machine node<ms>self.amNode<ms><special> <Shape>16659379 extra <special>Tool Tip<ms>play entering sound<ms><special>Filename to read audio from (Python code)<ms>"../prompts/entering.wav"<ms><special>answering machine node (Python code)<ms>self.amNode<ms><special> <Shape>5991358 extra <special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<ms>self.dtmfData=="9"<ms><special> <Shape>10190254 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "Have a new am node on ", self.amNode<ms><special> <Shape>9544394606,394,602,560,544,561<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>2505398 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>21058385 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>10282279 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print " have a sound node of ", self.soundNode<ms><special> <Shape>2307394 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>16770378 extra <special>Tool Tip<ms>play leaving sound<ms><special>Filename to read audio from (Python code)<ms>"../prompts/leaving.wav"<ms><special>answering machine node (Python code)<ms>self.amNode<ms><special> <Shape>2991588 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>9264199264,513,264,635,426,639,428,199,532,202,532,262<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>119019 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>11191109 extra <special>Tool Tip<ms>Request Node from sound module<ms><special>Request node from (Python code)<ms>"sound"<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>requestsound<ms><special>Additional information (Python code)<ms><ms><special> <Shape> +5770331 extra <special>Tool Tip<ms>play leaving sound<ms><special>Test (Python code)<ms>self.dtmfData=="3"<ms><special> <Shape>16516561 extra <special>Tool Tip<ms>initial wav file<ms><special>Filename to read audio from (Python code)<ms>"../prompts/instructions.wav"<ms><special>answering machine node<ms>self.amNode<ms><special> <Shape>2659427 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>1119167 extra <special>Tool Tip<ms>Request Node from AM module<ms><special>Request node from (Python code)<ms>"am"<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>requestam<ms><special>Additional information (Python code)<ms><ms><special> <Shape>5507312 extra <special>Tool Tip<ms>Test Roger voice<ms><special>Test (Python code)<ms>self.dtmfData=="1"<ms><special> <Shape>7989497 extra <special>Tool Tip<ms>End Call<ms><special>Worker node to activate (python code)<ms>self.amNode<ms><special> <Shape>10990405 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "hangup, as dtmf 9 has been received"<ms><special> <Shape>10282279 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print " have a sound node of ", self.soundNode<ms><special> <Shape>14251461 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>DTMF<ms><special>Python variable to hold event data<ms>self.dtmfData<ms><special> <Shape>9264199264,513,264,635,426,639,428,199,532,202,532,262<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14202162 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>amREQ<ms><special>Python variable to hold event data<ms>self.amNode<ms><special> <Shape>5581341 extra <special>Tool Tip<ms>Repeat instructions<ms><special>Test (Python code)<ms>self.dtmfData=="4"<ms><special> <Shape>11191109 extra <special>Tool Tip<ms>Request Node from sound module<ms><special>Request node from (Python code)<ms>"sound"<ms><special>Timer period (seconds)<ms>1<ms><special>Timer label<ms>requestsound<ms><special>Additional information (Python code)<ms><ms><special> <Shape>9821356821,357,977,357,1018,356<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>2991588 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>9544394606,394,602,560,544,561<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9248182248,183,308,182<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>13284231 extra <special>Tool Tip<ms>Stop Timer<ms><special>Timer to stop<ms>request sound<ms><special> <Shape>910393861039,386,1082,387<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9712318712,358,755,361,750,320,793,318,798,333<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9266329308,329,266,359<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9559339559,339,604,342<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9302485302,485,544,492,542,506<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9214304214,304,262,356<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>9291382291,386,334,382,332,395<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>14334209 extra <special>Tool Tip<ms>Catch the timer which, when fired, +indicates the end of this call<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>hanguptime<ms><special>Python variable to hold event data<ms>self.hanguptime<ms><special> <Shape>16770378 extra <special>Tool Tip<ms>play leaving sound<ms><special>Filename to read audio from (Python code)<ms>"../prompts/leaving.wav"<ms><special>answering machine node (Python code)<ms>self.amNode<ms><special> <Shape>2769426 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>15989451 extra <special>Tool Tip<ms>Transfer Media<ms><special>First SofaSwitch worker (python)<ms>"sound"<ms><special>Second SofaSwitch worker (python)<ms>"sound"<ms><special> <Shape>119019 extra <special>Tool Tip<ms>Start Processing<ms><special> <Shape>13190210 extra <special>Tool Tip<ms>Stop Timer<ms><special>Timer to stop<ms>request voip<ms><special> <Shape>15240412 extra <special>Tool Tip<ms>Transfer Media<ms><special>First SofaSwitch worker (python)<ms>self.amNode<ms><special>Second SofaSwitch worker (python)<ms>self.soundNode<ms><special> <Shape>2307394 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>21058385 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>12990549 extra <special>Tool Tip<ms>Initiate a timer, which causes this to +play wave file process to end.<ms><special>Timer period (seconds)<ms>0.1<ms><special>Timer label (string literal)<ms>hanguptime<ms><special> <Shape>5660332 extra <special>Tool Tip<ms>play entering sound<ms><special>Test (Python code)<ms>self.dtmfData=="2"<ms><special> <Shape>10190254 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "Have a new am node on ", self.amNode<ms><special> <Shape>14295185 extra <special>Tool Tip<ms>Eventer<ms><special>Event sought (Python code)<ms><ms><special>Event sought (Regular Exp)<ms>soundREQU<ms><special>Python variable to hold event data<ms>self.soundNode<ms><special> <Shape>16505364 extra <special>Tool Tip<ms>Play Rogers voice<ms><special>Filename to read audio from (Python code)<ms>"../prompts/sample_message.wav"<ms><special>answering machine node<ms>self.amNode<ms><special> <Shape>10507259 extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "dtmf received of ", self.dtmfData<ms><special> <Shape>5991358 extra <special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<ms>self.dtmfData=="9"<ms><special> <Shape>2505398 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>17516509 extra <special>Tool Tip<ms>Write To File<ms><special>Filename to contain new audio (Python code)<ms>"recorded_audio.wav"<ms><special>answering machine node<ms>self.amNode<ms><special> <Shape>16659379 extra <special>Tool Tip<ms>play entering sound<ms><special>Filename to read audio from (Python code)<ms>"../prompts/entering.wav"<ms><special>answering machine node (Python code)<ms>self.amNode<ms><special> <Shape>20335252 extra <special>Tool Tip<ms>Death<ms><special> <Shape>9632318632,366,638,319,685,318,685,330<special>Tool Tip<ms>Join blocks shape<ms><special> <Shape>2517600 extra <special>Tool Tip<ms>End Processing<ms><special> <Shape>5241359 extra <special>Tool Tip<ms>Conditional<ms><special>Test (Python code)<ms>(self.amNode != None) and (self.soundNode != None)<ms><special> <Shape>

1 0

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

14 Nov '06

Author: derek Date: Mon Nov 13 22:49:43 2006 New Revision: 195 Added: sofaswitch/trunk/callflow/docs/current/Death.png (contents, props changed) Removed: sofaswitch/trunk/callflow/docs/current/death.png Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Rename a file to avoid conflicts with bitmaps/death.png Added: sofaswitch/trunk/callflow/docs/current/Death.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 Mon Nov 13 22:49:43 2006 @@ -108,11 +108,11 @@ The toolbar icon and a rendering of a drawing area shape for the "Event Collection" item is shown below. <CENTER><TABLE frame=void border=0><TR><TD> -\image html bitmaps/eventer.png +\image html eventer.png </TD><TD>            </TD><TD> -\image html current/eventer.png +\image html Eventer.png </TD></TR> </TABLE></CENTER>

1 0

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

14 Nov '06

Author: derek Date: Mon Nov 13 22:44:02 2006 New Revision: 194 Added: sofaswitch/trunk/callflow/docs/faultyendprocessing.png (contents, props changed) Log: Add graph describing wrong use of the end procsssing item. Added: sofaswitch/trunk/callflow/docs/faultyendprocessing.png ============================================================================== Binary file. No diff available.

1 0

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

14 Nov '06

Author: derek Date: Mon Nov 13 22:17:24 2006 New Revision: 193 Added: sofaswitch/trunk/callflow/docs/current/Eventer.png (contents, props changed) Removed: sofaswitch/trunk/callflow/docs/current/eventer.png Modified: sofaswitch/trunk/callflow/docs/current/eachicon.dxy Log: Rename eventer to Eventer, which removes confusion with the one of the name eventer.png in the bitmaps directory. Added: sofaswitch/trunk/callflow/docs/current/Eventer.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 Mon Nov 13 22:17:24 2006 @@ -7,21 +7,41 @@ how one would use each structure within a call flow diagram. \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> -The toolbar icon \image html Controlsstart.png -is used to indicate that the user wishes to place the "Initiate graph -processing" item on the screen, which looks like: -\image html startflow.png "Initiate graph processing" +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 1 item is ambiguous - where would call processing start ? +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> -\subsection subsecJoinObjects Join objects on the drawing area - -The toolbar icon, \image html JoinObjects.png -indicates a user drawn multiline segment object that connects objects. +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 @@ -31,22 +51,111 @@ circle is drawn at each end. It is entirely valid to have the output of several items connected to one -item. Thus, the following shape is valid, +item. Thus, of the the following two shapes, the left is valid, -\image html validjoinexample.png "Valid use of the join objects structure" +<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 this shape is invalid. -\image html faultyjoinexample.png "Incorrect use - the graph is ambiguous" - -The invalid shape is ambiguous - it is not clear where the flow of execution -should go. In this example, I suppose, it would "work", in that there is no +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 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 subsecEventer Event Collection +The toolbar icon and a rendering of a drawing area shape for the "Event Collection" +item is shown below. +<CENTER><TABLE frame=void border=0><TR><TD> +\image html bitmaps/eventer.png +</TD><TD> +           +</TD><TD> +\image html current/eventer.png +</TD></TR> +</TABLE></CENTER> + +Event Collection is the central to the processing of each graph. With this +item, we have made it possible for the system to respond to network and timer +events. Alternatively, the primary purpose of this structure is to provide a +general means of registering to receive an event. + +In our implementation, events are collected in the background, and then +processed after execution has fallen into a "End Processing" box, which is +described in \ref subsecEndProcessing. + +The Event collection item has two outputs. + \li On the right, which is where execution goes after registering for an + event. + \li On the bottom, which is where execution returns to after detecting the + event. + +Clicking the right mouse button brings up an edit box, where you control what +events are sought for. The Tool Tip is as before. The particular event you are +seeking to match on is specified with Python code, or as a Python regular +expression. It is an error to specify both methods. + +A Python variable is initialised to None when this item is entered from the +top. This variable is specified in the edit box, generated by the right mouse +button. To illustrate, after a DTMF event, the Python variable will hold the +particular DTMF value that was detected. + + +\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. */ \ No newline at end of file

1 0