- Sofaswitch-svn - FreeSWITCH Mailing Lists

[commit] r172 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 12 Nov '06

12 Nov '06

Author: derek Date: Sun Nov 12 16:20:20 2006 New Revision: 172 Added: sofaswitch/trunk/callflow/docs/description.dxy Removed: sofaswitch/trunk/callflow/docs/executionflow.dxy Log: Rename file and title and page description etc. Added: sofaswitch/trunk/callflow/docs/description.dxy ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/docs/description.dxy Sun Nov 12 16:20:20 2006 @@ -0,0 +1,98 @@ +/*! \page pageCallFlow Detailed description of CallFlow + +\section secIntro Introduction + +We describe the operation of this utilitiy with a series of examples and +associated description. The first part of this document describes the +generation of the graph with the gui, and the second part describes the +running of the graph. + +\section secHelloWorld Hello World example +Perhaps the simplest example of a graph you can create is the standard "Hello +World" example, shown here. + +\image html helloworld.png + +Python will start executing at the very top box, process the code in the +middle, and then terminate at the bottom. Program flow is invariably top to +bottom. Arrows are drawn on the output and input of each box to indicate where +the flow is going. You will notice four black circles, filled, on this +graph. They indicate a connection between the different entitiy. The skull and +crossbones symbol indicates end this graph now. + +\section secForLoop For Loops + +The flow of execution is to follow the graph on the screen. Thus, when +given a graph like + +\image html forloop.png + +it will enter the for loop, and go around and around until the termination +condition is met. The for loop consists of the three boxes in the middle of +this image. On each iteration, a Python command is executed, which is defined +in the Python box in the very middle. You could, of course, put something +different in the middle of the for loop. + +The loop variable, initialisation and termination condition are set at the +start of the for loop. To change these, right click on the for loop box and +adjust accordingly. It will generate an exception if you fail to provide an +entry to the Initialise, Test or Increment fields. If this Python code is +incorrect, it will except also. Notice too that the variables all have the +word "self." as the first half. This ensures that variables in one graph will +not interfere with those of another graph. If you wrote a nested for loop, +they should use different variables. + +While processing each of the nodes in the supplied graph, it is ignoring +all timer events. Execution continues until it falls of the end of the graph, +or passes through an Eventer type structure and goes nowhere. + + +\section secEvent Event handling +We describe the handling of events in this section, with a simple example. +Consider the following graph + +\image html simpleevent.png + +Execution starts at the top, moves to the next node which sends off a request +to obtain a new worker node. Then, the eventer box is entered, where we +register to receive any event that contains the word "NEW" (we are searching +for all events advising of a new node). At which point, execution continues to +the right, and goes into the lower "execute python code" box, which prints a +message. Finally, execution moves into the bottom most box, and stops. + +At this point, we rely upon the twisted module in python to call methods +indicating that things have happened (e.g. a timer, data received from network +etc). On receipt of a message about a new node, the box on the star output of +the eventer is processed. In this case, python code is executed which reports +the id of the voip node created. Execution then moves to the end, and stops. + +Should there be a new event (which we have previously registered for with an +Eventer box) execution will return there. Consequently, in the above example, +every time a new node is created, execution will always move back to the left +most execute python box. + +Note that network events, timer events, other events, are only processed when +execution has stopped. + +\section secUsage Usage - selection cutting pasting etc + +You are going to create a new graph, or edit an existing graph. This is done +by selecting New from the menu, or loading an existing file. + +Individual items in the graph can be moved by left down on the item and +dragging to the desired position. To select and move multiple items, hold the +shift key down and select the desired items, and then drag. Alternatively, +select a region on the screen (left down, move to the opposite corner, left +up), shift button down, and drag. + + + + + + + + + + + +*/ \ No newline at end of file

1 0

[commit] r171 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 12 Nov '06

12 Nov '06

Author: derek Date: Sun Nov 12 16:19:35 2006 New Revision: 171 Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy Log: updates Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/executionflow.dxy (original) +++ sofaswitch/trunk/callflow/docs/executionflow.dxy Sun Nov 12 16:19:35 2006 @@ -1,4 +1,4 @@ -/*! \page pageExecutionFlow Flow of execution through python code +/*! \page pageCallFlow Detailed description of CallFlow \section secIntro Introduction

1 0

[commit] r170 - sofaswitch/trunk/sound
by SofaSWITCH SVN 12 Nov '06

12 Nov '06

Author: derek Date: Sun Nov 12 15:56:43 2006 New Revision: 170 Modified: sofaswitch/trunk/sound/audio.cxx sofaswitch/trunk/sound/audio.h Log: Give up on PQueueChannel, and go for a simple simple mutex protected buffer. Modified: sofaswitch/trunk/sound/audio.cxx ============================================================================== --- sofaswitch/trunk/sound/audio.cxx (original) +++ sofaswitch/trunk/sound/audio.cxx Sun Nov 12 15:56:43 2006 @@ -70,11 +70,10 @@ TestAudioWrite::TestAudioWrite(PUDPSocket &_socket, PSoundChannel &_sound) : TestAudio(_socket, _sound) { - - audioQueue = new PQueueChannel(); - audioQueue->Open(1000); - audioQueue->SetReadTimeout(40); - audioQueue->SetWriteTimeout(40); + memset(silenceBuffer, 0, oneChunk); + memset(buffer, 0, buildSize); + readIndex = 0; + writeIndex = 0; PTRACE(3, "Writer\tInitiate thread for writing " ); Resume(); @@ -82,8 +81,6 @@ TestAudioWrite::~TestAudioWrite() { - audioQueue->Close(); - delete(audioQueue); } void TestAudioWrite::Main() @@ -114,8 +111,17 @@ continue; } PINDEX readSize = socket.GetLastReadCount(); - data.SetSize(readSize); - audioQueue->Write(data.GetPointer(), data.GetSize()); + PWaitAndSignal m(accessMutex); + if ((writeIndex + readSize) < buildSize) { + memcpy (buffer + writeIndex, data.GetPointer(), readSize); + writeIndex += readSize; + } else { + PINDEX firstHalf = buildSize - writeIndex; + PINDEX secondHalf = readSize - firstHalf; + memcpy (buffer + writeIndex, data.GetPointer(), firstHalf); + memcpy(buffer, data.GetPointer() + firstHalf, secondHalf); + writeIndex = secondHalf; + } PTRACE(6, "postWRITE of " << data.GetSize() << " bytes to sound device"); countPackets++; } @@ -133,28 +139,30 @@ void TestAudioWrite::QueueToSpeakerMain(PThread &, INT) { -#define BUFFER_SIZE 1000 - silenceData.SetSize(480); - memset(silenceData.GetPointer(), 0, 480); - incomingData.SetSize(BUFFER_SIZE); - memset(incomingData.GetPointer(), 0, BUFFER_SIZE); - - PINDEX storedCount = 0; while(keepGoing) { - if (audioQueue->Read(incomingData.GetPointer() + storedCount, 240)) { - PINDEX count = audioQueue->GetLastReadCount(); - PTRACE(6, "Read " << count << "bytes from PQueueChannel. to have a total of " << (storedCount + count)); - if ((storedCount + count) > 480) { - sound.Write(incomingData.GetPointer(), 480); - PTRACE(6, "Play 480 bytes to the speaker "); - memcpy(incomingData.GetPointer(), incomingData.GetPointer() + 480, (storedCount + count) - 480); - storedCount = (storedCount + count) - 480; + { + PWaitAndSignal m(accessMutex); + PINDEX available; + if (writeIndex < readIndex) + available = (writeIndex + buildSize) - readIndex; + else + available = writeIndex - readIndex; + if (available > (oneChunk + (oneChunk >> 1))) { + if ((readIndex + oneChunk) < buildSize) { + memcpy (soundBuffer, buffer + readIndex, oneChunk); + readIndex += oneChunk; + } else { + PINDEX firstHalf = buildSize - readIndex; + PINDEX secondHalf = oneChunk - firstHalf; + memcpy(soundBuffer, buffer + readIndex, firstHalf); + memcpy(soundBuffer + firstHalf, buffer, secondHalf); + readIndex = secondHalf; + } } else - storedCount += count; - PTRACE(6, "Have " << storedCount << " byte waiting to be played"); - } else { - sound.Write(silenceData.GetPointer(), 480); + memcpy(soundBuffer, silenceBuffer, oneChunk); } + sound.Write(soundBuffer, oneChunk); + PTRACE(6, "Play " << oneChunk << " bytes to the speaker "); } PTRACE(4, "End of queue to speaker main thread "); Modified: sofaswitch/trunk/sound/audio.h ============================================================================== --- sofaswitch/trunk/sound/audio.h (original) +++ sofaswitch/trunk/sound/audio.h Sun Nov 12 15:56:43 2006 @@ -1,17 +1,10 @@ /* * audio.h * - * PWLib application header file for sound card + jabber + * PWLib application header file for sound card in a SofaSwitch environment. * * * - * - * - * - * - * - * - * */ #ifndef _AUDIO_H @@ -115,17 +108,35 @@ PDECLARE_NOTIFIER(PThread, TestAudioWrite, QueueToSpeakerMain); #endif + /**The number of bytes in the buffer we use for building sound into + sections of the right size */ + enum { + /** 5000 is 0.3125 of a second of audio data, which is heaps. Such a + large number saves us from wrapping round the end too often.*/ + buildSize= 5000, + /**30 ms of audio */ + oneChunk = 480 + }; + + /**The mutex which protects access to the buffer and buffer variables */ + PMutex accessMutex; - /**The pwlib structure which takes the input sound samples (which may come - in blocks of 160, 240, 320, 480, or other bytes) and glues them - together to give one nice stream of 480 byte blocks. */ - PQueueChannel *audioQueue; + /**The current read index, which goes 0 .. (buildSize -1) */ + PINDEX readIndex; - /**The buffer of data we use to collect incoming data into */ - PBYTEArray incomingData; + /**The current write index, which goes 0 .. (buildSize -1) */ + PINDEX writeIndex; - /**The data we send to the speaker when it is silence time */ - PBYTEArray silenceData; + /**The region of memor for accumulating incoming and outgoing data */ + char buffer[buildSize]; + + /**The buffer used to play silence from if there is not enough audio. This + is not mutex protected. */ + char silenceBuffer[oneChunk]; + + /**The buffer used to contain audio which is given to the speaker. This is + not mutex protected. */ + char soundBuffer[oneChunk]; };

1 0

[commit] r169 - sofaswitch/trunk/sound
by SofaSWITCH SVN 10 Nov '06

10 Nov '06

Author: derek Date: Thu Nov 9 23:17:11 2006 New Revision: 169 Modified: sofaswitch/trunk/sound/audio.cxx sofaswitch/trunk/sound/audio.h Log: Adjust so that if the queue does not supply the requried number of bytes, we make it up prior to writing to the speaker. Modified: sofaswitch/trunk/sound/audio.cxx ============================================================================== --- sofaswitch/trunk/sound/audio.cxx (original) +++ sofaswitch/trunk/sound/audio.cxx Thu Nov 9 23:17:11 2006 @@ -133,17 +133,31 @@ void TestAudioWrite::QueueToSpeakerMain(PThread &, INT) { - char silenceBuffer[480]; - char audioBuffer[480]; - memset(silenceBuffer, 0, 480); +#define BUFFER_SIZE 1000 + silenceData.SetSize(480); + memset(silenceData.GetPointer(), 0, 480); + incomingData.SetSize(BUFFER_SIZE); + memset(incomingData.GetPointer(), 0, BUFFER_SIZE); + + PINDEX storedCount = 0; while(keepGoing) { - if (audioQueue->Read(audioBuffer, 480)) { + if (audioQueue->Read(incomingData.GetPointer() + storedCount, 240)) { PINDEX count = audioQueue->GetLastReadCount(); - sound.Write(audioBuffer, count); + PTRACE(6, "Read " << count << "bytes from PQueueChannel. to have a total of " << (storedCount + count)); + if ((storedCount + count) > 480) { + sound.Write(incomingData.GetPointer(), 480); + PTRACE(6, "Play 480 bytes to the speaker "); + memcpy(incomingData.GetPointer(), incomingData.GetPointer() + 480, (storedCount + count) - 480); + storedCount = (storedCount + count) - 480; + } else + storedCount += count; + PTRACE(6, "Have " << storedCount << " byte waiting to be played"); } else { - sound.Write(silenceBuffer, 480); + sound.Write(silenceData.GetPointer(), 480); } } + + PTRACE(4, "End of queue to speaker main thread "); } Modified: sofaswitch/trunk/sound/audio.h ============================================================================== --- sofaswitch/trunk/sound/audio.h (original) +++ sofaswitch/trunk/sound/audio.h Thu Nov 9 23:17:11 2006 @@ -120,6 +120,12 @@ in blocks of 160, 240, 320, 480, or other bytes) and glues them together to give one nice stream of 480 byte blocks. */ PQueueChannel *audioQueue; + + /**The buffer of data we use to collect incoming data into */ + PBYTEArray incomingData; + + /**The data we send to the speaker when it is silence time */ + PBYTEArray silenceData; };

1 0

[commit] r168 - sofaswitch/trunk/sound
by SofaSWITCH SVN 10 Nov '06

10 Nov '06

Author: derek Date: Thu Nov 9 22:20:34 2006 New Revision: 168 Modified: sofaswitch/trunk/sound/audio.cxx sofaswitch/trunk/sound/audio.h Log: Add PQueueChannel to sound, so we cope with receiving smaller packets from the source. Modified: sofaswitch/trunk/sound/audio.cxx ============================================================================== --- sofaswitch/trunk/sound/audio.cxx (original) +++ sofaswitch/trunk/sound/audio.cxx Thu Nov 9 22:20:34 2006 @@ -12,6 +12,8 @@ */ #include <ptlib.h> +#include <ptclib/qchannel.h> + #include "version.h" #include "audio.h" #include "main.h" @@ -68,10 +70,22 @@ TestAudioWrite::TestAudioWrite(PUDPSocket &_socket, PSoundChannel &_sound) : TestAudio(_socket, _sound) { - PTRACE(3, "Writer\tInitiate thread for writing " ); - Resume(); + + audioQueue = new PQueueChannel(); + audioQueue->Open(1000); + audioQueue->SetReadTimeout(40); + audioQueue->SetWriteTimeout(40); + + PTRACE(3, "Writer\tInitiate thread for writing " ); + Resume(); } +TestAudioWrite::~TestAudioWrite() +{ + audioQueue->Close(); + delete(audioQueue); +} + void TestAudioWrite::Main() { if (!OpenAudio(PSoundChannel::Player)) { @@ -79,7 +93,14 @@ return; } PTRACE(3, "TestAudioWrite\tSound device is now open, start running"); - + + PString threadName = PString("QueueToSpeaker"); + PThread *q2s = PThread::Create(PCREATE_NOTIFIER(QueueToSpeakerMain), 30000, + PThread::NoAutoDeleteThread, + PThread::NormalPriority, + threadName); + + PBYTEArray data; data.SetSize(480); @@ -94,8 +115,7 @@ } PINDEX readSize = socket.GetLastReadCount(); data.SetSize(readSize); - sound.SetBuffers(readSize, 2); - sound.Write(data.GetPointer(), data.GetSize()); + audioQueue->Write(data.GetPointer(), data.GetSize()); PTRACE(6, "postWRITE of " << data.GetSize() << " bytes to sound device"); countPackets++; } @@ -105,7 +125,27 @@ if (!keepGoing) { PTRACE(3, "keepgoing is false"); } + + q2s->WaitForTermination(); + delete q2s; } + + +void TestAudioWrite::QueueToSpeakerMain(PThread &, INT) +{ + char silenceBuffer[480]; + char audioBuffer[480]; + memset(silenceBuffer, 0, 480); + while(keepGoing) { + if (audioQueue->Read(audioBuffer, 480)) { + PINDEX count = audioQueue->GetLastReadCount(); + sound.Write(audioBuffer, count); + } else { + sound.Write(silenceBuffer, 480); + } + } +} + ////////////////////////////////////////////////////////////// Modified: sofaswitch/trunk/sound/audio.h ============================================================================== --- sofaswitch/trunk/sound/audio.h (original) +++ sofaswitch/trunk/sound/audio.h Thu Nov 9 22:20:34 2006 @@ -24,6 +24,8 @@ /**The base class for reading and writing audio from/to the sound device. This class will take audio to/from the PUDPSocket, and transfer it to/from the sound device */ +class PQueueChannel; + class TestAudio : public PThread { PCLASSINFO(TestAudio, PThread); @@ -72,6 +74,8 @@ PINDEX countPackets; }; +///////////////////////////////////////////////////////////////////////////// + /**Override of TestAudio, directed towards Reading from the sound card */ class TestAudioRead : public TestAudio { @@ -84,6 +88,7 @@ void Main(); }; +///////////////////////////////////////////////////////////////////////////// /**Override of TestAudio, directed towards writing to the sound card */ class TestAudioWrite : public TestAudio { @@ -92,8 +97,29 @@ /**Constructor */ TestAudioWrite(PUDPSocket &_socket, PSoundChannel &_sound); + /**Destructor. This deletes the PQueueChannel we allocated in the + constructor */ + ~TestAudioWrite(); + /**the main entry point, where this thread starts */ void Main(); + + protected: + + +#ifdef DOC_PLUS_PLUS + /**This thread runs to transfer data from the audio queue to the speaker + of the sound channel. */ + virtual void QueueToSpeakerMain(PThread &, INT); +#else + PDECLARE_NOTIFIER(PThread, TestAudioWrite, QueueToSpeakerMain); +#endif + + + /**The pwlib structure which takes the input sound samples (which may come + in blocks of 160, 240, 320, 480, or other bytes) and glues them + together to give one nice stream of 480 byte blocks. */ + PQueueChannel *audioQueue; };

1 0

[commit] r167 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 10 Nov '06

10 Nov '06

Author: derek Date: Thu Nov 9 21:43:13 2006 New Revision: 167 Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy Log: Add description on using the CallFlow utility. Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/executionflow.dxy (original) +++ sofaswitch/trunk/callflow/docs/executionflow.dxy Thu Nov 9 21:43:13 2006 @@ -74,7 +74,16 @@ Note that network events, timer events, other events, are only processed when execution has stopped. +\section secUsage Usage - selection cutting pasting etc +You are going to create a new graph, or edit an existing graph. This is done +by selecting New from the menu, or loading an existing file. + +Individual items in the graph can be moved by left down on the item and +dragging to the desired position. To select and move multiple items, hold the +shift key down and select the desired items, and then drag. Alternatively, +select a region on the screen (left down, move to the opposite corner, left +up), shift button down, and drag.

1 0

[commit] r166 - sofaswitch/trunk/callflow/bitmaps
by SofaSWITCH SVN 10 Nov '06

10 Nov '06

Author: derek Date: Thu Nov 9 20:08:37 2006 New Revision: 166 Modified: sofaswitch/trunk/callflow/bitmaps/Python.xpm Log: Fix python logo to be standard. Modified: sofaswitch/trunk/callflow/bitmaps/Python.xpm ============================================================================== --- sofaswitch/trunk/callflow/bitmaps/Python.xpm (original) +++ sofaswitch/trunk/callflow/bitmaps/Python.xpm Thu Nov 9 20:08:37 2006 @@ -1,21 +1,393 @@ /* XPM */ static char *Python_xpm[]={ -"16 15 3 1", -". c None", -"# c #ff00ff", -"a c #ffff00", -"................", -".....#aa........", -".....#a####aa...", -".....##a...#aa..", -".....#a.....#a..", -"....##a.....#a..", -"....##a.....#a..", -"....#a#a...#aa..", -"....#a.####aa...", -"...#aa..........", -"...#a...........", -"...#a...........", -"...#a...........", -"..#a............", -"................"}; +"32 32 358 2", +"Qt c None", +"cG c #facc6e", +".H c #7d9fbb", +".i c #d9e0e5", +"#K c #f9d867", +"cm c #6f99ba", +"cf c #96b3cc", +"dJ c #f1e6c7", +"ds c #f6e0a5", +"#L c #a0bcd2", +"ad c #f1e5c6", +"dC c #f5e8c8", +"b4 c #6191b8", +"dI c #f5d794", +"dD c #f7d37d", +"dH c #fac148", +"dE c #fac248", +"dF c #fcc038", +"dG c #ffbe31", +"#r c #81a9cb", +".# c #c3d1de", +"cQ c #fbc03a", +"#h c #3b80ba", +"#2 c #7ca9cc", +"di c #f7ce75", +"#b c #376e9c", +"#q c #386c96", +".3 c #39709c", +"#n c #3976ab", +"#m c #3978ad", +"#l c #3979af", +"#k c #397bb1", +"#j c #3a7cb5", +"#i c #3a7db6", +".e c #457fb2", +".d c #4580b3", +".c c #4884b6", +".f c #5185b1", +".T c #5e89ac", +".b c #6394bd", +".g c #6e97b9", +".a c #97b5cf", +".h c #b6c8d6", +"da c #fbbf34", +"cX c #fbc038", +"c4 c #febc2b", +"dB c #f7d48c", +"dr c #f8c762", +"cF c #f7c866", +"cl c #f7d17f", +"dt c #f7d980", +".j c #93b4ce", +"cP c #fdc235", +"cO c #ffc532", +"cN c #ffcb3b", +"cM c #ffcc3b", +".G c #4576a6", +".t c #6992b5", +"#1 c #f6d979", +"b3 c #f2e5c5", +"db c #f7dc84", +"#J c #f9dd63", +"#c c #387fba", +".4 c #3881bd", +".U c #3c83bd", +".I c #4787bb", +"as c #f2e0af", +"aE c #f6d16a", +"bN c #f7c85e", +"bB c #fac03a", +"aR c #fac841", +"c5 c #fcd74d", +"b. c #fdc536", +"bn c #ffc532", +"cY c #ffde50", +"cR c #ffe354", +"cH c #ffe457", +"cn c #92b0c9", +"dj c #f9d55c", +"cr c #feea67", +"cg c #6b97bb", +"dA c #f9c766", +"cq c #497da9", +".k c #5d96c3", +"#M c #7aa7cb", +"#s c #98b8d3", +"bO c #a8c0d5", +"du c #f8da86", +"aS c #3880bb", +"aF c #4183bb", +"cp c #4278a6", +"bo c #4786b8", +"co c #4d81ae", +"at c #5992c0", +"bC c #6998c0", +"ae c #8eb2cf", +"ce c #f8c559", +"cE c #f9c349", +"cD c #fbbf35", +"cC c #fbbf36", +"cB c #fbc238", +"cA c #fbc73e", +"cz c #fbc73f", +"cy c #fbc83f", +"cx c #fbc840", +"cw c #fbcd46", +"cv c #fbce47", +"ac c #fad153", +"cL c #fbd152", +"dq c #fbc04b", +"cu c #fcd34a", +"dh c #fac048", +".F c #3e77a6", +".u c #5491c2", +"b2 c #fcc345", +"dc c #fcd651", +"aH c #366b96", +"#p c #366c99", +"#C c #366c9a", +"aj c #366d9b", +"#a c #366d9c", +"#B c #366e9d", +"av c #366e9e", +".1 c #366f9f", +"#U c #3670a0", +"#D c #376a94", +"#V c #376b97", +".2 c #376f9d", +"#9 c #3771a2", +"#A c #3772a3", +"## c #3772a4", +"#g c #3773a4", +".R c #3773a5", +".E c #3773a6", +".0 c #3774a7", +".D c #3774a8", +"#8 c #3774a9", +"#. c #3775a8", +"aG c #3775a9", +"bQ c #3775aa", +"#f c #3776aa", +".C c #3776ab", +".Q c #3777ac", +".9 c #3777ad", +".B c #3778ad", +".P c #3778ae", +"ai c #3779ae", +".O c #3779af", +"b# c #3779b0", +"ah c #377ab0", +"#T c #377ab1", +".Z c #377ab2", +"#e c #377ab3", +"aT c #377bb3", +"#z c #387ab1", +".A c #387ab2", +"#7 c #387bb2", +".N c #387bb3", +".z c #387bb4", +"#6 c #387bb5", +"#y c #387cb4", +".y c #387cb5", +"#S c #387cb6", +"ag c #387db6", +"#d c #387db7", +"#x c #387eb7", +"au c #387eb8", +"#5 c #387eb9", +"#R c #387fba", +"#Q c #3880bb", +"#P c #3881bc", +"#w c #3881bd", +"#v c #3882be", +"#O c #3883bf", +"af c #3884c1", +"#4 c #3884c2", +"aI c #396c95", +"bP c #397bb4", +".5 c #3981bd", +"aU c #3a78ab", +"ak c #3b6d96", +"ba c #3c79ab", +".p c #3c7bb0", +"bp c #3c7cb0", +"#u c #3c83bc", +".o c #3d7db3", +".n c #3f7fb5", +".x c #3f82bb", +".v c #3f85bd", +".J c #3f85be", +".V c #4086c0", +"ch c #417dae", +".q c #427dad", +"#N c #4489c2", +".w c #4789c0", +".S c #487da8", +"#3 c #498cc2", +".m c #4b89bc", +"#o c #4f83ae", +".r c #4f84b0", +".8 c #4f8ab9", +"b5 c #5087b4", +"#t c #558fbf", +".6 c #5693c4", +"bD c #588cb7", +"aJ c #5982a4", +"aw c #638aab", +"aV c #6391b6", +".l c #6399c5", +"bR c #6996bd", +"b6 c #6a95ba", +".s c #709bbe", +"aW c #83a6c3", +"a0 c #8aa6bd", +"aZ c #8aa7c0", +"aY c #8aa8c1", +"aX c #8aaac5", +".7 c #8bb2d3", +".K c #90b8d9", +"a1 c #95aab5", +"bq c #9db7c5", +"bb c #9eb6c8", +".M c #9ebed9", +".W c #b5cfe5", +"aK c #b9c3bd", +"#E c #bccad6", +"al c #c0cacc", +".Y c #c0d5e6", +"bE c #d7d4a7", +"a2 c #d9d1a6", +"ax c #dccf9a", +"bc c #ddd597", +".L c #eff3fb", +"bd c #f4e786", +"br c #f5e47c", +"bS c #f6e99e", +"dz c #f7c968", +"dv c #f9cd5f", +"a3 c #f9dc75", +"aL c #f9dd6d", +"b7 c #f9efa2", +"bh c #fae67e", +"bg c #fae781", +"bf c #faea84", +"be c #faed87", +"dy c #fbbb36", +"dw c #fbc13b", +"dk c #fbd156", +"bi c #fbe073", +"ck c #fcba32", +"dx c #fcc031", +"ar c #fcd556", +"#I c #fce35d", +"d# c #fdb929", +"bM c #fdbe33", +"cW c #fdbf30", +"aD c #fdd048", +"bj c #fdd954", +"#0 c #fdda51", +"bF c #fdeb66", +"c3 c #febb28", +"dg c #febf42", +"bA c #fec231", +"a9 c #fec737", +"aQ c #fecb3c", +"dl c #fecc3c", +"a4 c #fed84a", +"bT c #feeb5f", +"do c #ffb521", +"dp c #ffb525", +"dn c #ffb926", +"cd c #ffba27", +"cc c #ffbc29", +"b1 c #ffbc2a", +"cb c #ffbd2a", +"cV c #ffbe2c", +"dd c #ffc033", +"bL c #ffc12f", +"ca c #ffc230", +"cj c #ffc330", +"c2 c #ffc343", +"b0 c #ffc431", +"bm c #ffc532", +"bl c #ffc533", +"c# c #ffc634", +"cU c #ffc735", +"cZ c #ffc73a", +"bK c #ffc836", +"dm c #ffc837", +"a8 c #ffc938", +"c8 c #ffc943", +"bk c #ffca38", +"c. c #ffca3a", +"bZ c #ffcb3a", +"bJ c #ffcb3b", +"a7 c #ffcc3b", +"bY c #ffcc3c", +"aP c #ffcd3c", +"a6 c #ffce3e", +"bz c #ffcf3f", +"bX c #ffcf40", +"aO c #ffd141", +"c7 c #ffd142", +"aC c #ffd242", +"d. c #ffd278", +"a5 c #ffd343", +"aN c #ffd443", +"bW c #ffd444", +"aB c #ffd544", +"cK c #ffd545", +"aq c #ffd646", +"aM c #ffd647", +"aA c #ffd747", +"c6 c #ffd748", +"ap c #ffd849", +"ci c #ffd94a", +"ab c #ffda4b", +"ao c #ffda4c", +"aa c #ffdb4c", +"az c #ffdb4d", +"by c #ffdc4d", +"ay c #ffdc4e", +"de c #ffdc95", +"cT c #ffdd4e", +"an c #ffdd4f", +"bI c #ffdd50", +"c0 c #ffdd90", +"b9 c #ffde4f", +"bV c #ffde50", +"bx c #ffdf51", +"cJ c #ffe051", +"b8 c #ffe052", +"bw c #ffe053", +"#Z c #ffe152", +"am c #ffe153", +"cS c #ffe253", +"a# c #ffe254", +"ct c #ffe255", +"#Y c #ffe354", +"a. c #ffe355", +"bU c #ffe356", +"cI c #ffe357", +"c1 c #ffe3a6", +"bH c #ffe456", +"bv c #ffe458", +"#H c #ffe557", +"#X c #ffe558", +"bu c #ffe659", +"bG c #ffe65a", +"df c #ffe6b5", +"#W c #ffe85b", +"#G c #ffe85c", +"cs c #ffe95c", +"bt c #ffeb5e", +"#F c #ffec5f", +"bs c #ffed60", +"c9 c #fffbf2", +".X c #ffffff", +"QtQtQtQtQtQtQtQtQtQtQt.#.a.b.c.d.e.e.f.g.h.iQtQtQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtQt.j.k.l.m.n.o.p.p.q.r.s.tQtQtQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQt.j.u.v.w.x.y.z.A.B.C.D.E.F.G.HQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQt.I.J.K.L.M.N.O.P.B.Q.R.R.R.S.TQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQt.U.V.W.X.Y.Z.O.C.C.0.R.R.1.2.3QtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQt.4.5.6.7.8.O.O.9#..R##.1#a#a#bQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQt#c#d.y#e.O.P.9#f.R#g.1#a#a#a#bQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQt#h#i#j#k#l#m#n#o.R###a#a#a#p#qQtQtQtQtQtQtQtQt", +"QtQtQt#r#s#t#u#v#w#x#y#z.O.O.B.0.R#A#B#a#C#D#D#E#F#G#H#I#J#KQtQt", +"QtQt#L#M#N#O#P#Q#R#S#T.O.9.Q#..R.R#U#a#a#V#D#D#E#W#X#Y#Z#0#1QtQt", +"QtQt#2#3#4#v#R#5#S#6#7.P.C#8.R.R#9#a#a#p#D#D#D#Ea.a##ZaaabacadQt", +"QtQtaeaf#v#v#Pag.zahai.B.B.R.R#9#a#aaj#D#D#DakalamanaoapaqarasQt", +"QtQtat#O#P#Qau.y.zah.Q.C.D.R.Rav#a#a#V#D#D#DawaxayazaAaBaCaDaEQt", +"QtQtaF#w#w#R.y.z.O.O.PaG.R#g#U#aajaH#D#DaIaJaKaLabaMaNaOaPaQaRQt", +"QtQtaS#Qau.yaT.O.O.OaUaVaWaXaYaYaZa0a0a0a1a2a3a4aAa5a6a7a8a9b.Qt", +"QtQtaS#Q#d.y.zb#.Obabbbcbdbebebebebfbgbhbibjabaqa5a6a7bkblbmbnQt", +"QtQtbo#d.y.A.O.ObpbqbrbsbsbsbsbtbubvbwbxbyapaBa5bza7bkbmbmbAbBQt", +"QtQtbC.y.Z.O.B.QbDbEbFbsbsbsbtbGbHa#bIayapaBa5a6bJbKblbmbLbMbNQt", +"QtQtbObP.Nai.CbQbRbSbTbsbsbtbubUa#bVaaapbWbXbYbZblbmb0bLb1b2b3Qt", +"QtQtb4b5.O.B.B#.b6b7bsbsbtbua.b8b9aaapaNbza7c.c#bmcacbcccdceQtQt", +"QtQtcfcgch.CaG.0b6b7#F#WbGa#amayciaAaBbzbYbZc#bmcjcbcccdckclQtQt", +"QtQtQtcmcncocpcpcqcrcs#XctbxancicucvcwcxcyczcAcBcCcDcDcEcFcGQtQt", +"QtQtQtQtQtQtQtQtQtcHcI#YcJaacicKcLcMcNcOcOcOcPcQQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtcRcScTazabcKaCbYa7cUbmbmcVcWcXQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtcYanabciaBaObYbZbkcZc0c1c2c3c4QtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtc5a4c6aBc7a6a7cUbmc8c9.Xd.d#daQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtdbdcbWaObYa8c#bmb0dddedfdgdhdiQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtQtdjdkdldmbmbmbLcVdndodpdqdrQtQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtQtdsdtdudvdwdxccccdydzdAdBQtQtQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtQtQtQtdCdDdEdFdGdGdHdIdJQtQtQtQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQt", +"QtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQtQt"};

1 0

[commit] r165 - sofaswitch/trunk/callflow/tests
by SofaSWITCH SVN 10 Nov '06

10 Nov '06

Author: derek Date: Thu Nov 9 19:49:35 2006 New Revision: 165 Added: sofaswitch/trunk/callflow/tests/helloworld.src Log: Add the standard "hello world" graph. Added: sofaswitch/trunk/callflow/tests/helloworld.src ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/tests/helloworld.src Thu Nov 9 19:49:35 2006 @@ -0,0 +1 @@ +1<B>374<B>36<B> extra <special>Tool Tip<ms>Start Processing<ms><special> <B><Shape>20<B>389<B>126<B> extra <special>Tool Tip<ms>Death<ms><special> <B><Shape>10<B>376<B>79<B> extra <special>Tool Tip<ms>Python<ms><special>Python Code<ms>print "hello world!"<ms><special> <B><Shape>

1 0

[commit] r164 - sofaswitch/trunk/callflow/docs
by SofaSWITCH SVN 10 Nov '06

10 Nov '06

Author: derek Date: Thu Nov 9 19:48:19 2006 New Revision: 164 Added: sofaswitch/trunk/callflow/docs/helloworld.png (contents, props changed) Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy Log: Extend docs, add hello world example. Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/executionflow.dxy (original) +++ sofaswitch/trunk/callflow/docs/executionflow.dxy Thu Nov 9 19:48:19 2006 @@ -1,19 +1,55 @@ /*! \page pageExecutionFlow Flow of execution through python code -\section secOverview Oversight +\section secIntro Introduction +We describe the operation of this utilitiy with a series of examples and +associated description. The first part of this document describes the +generation of the graph with the gui, and the second part describes the +running of the graph. + +\section secHelloWorld Hello World example +Perhaps the simplest example of a graph you can create is the standard "Hello +World" example, shown here. + +\image html helloworld.png + +Python will start executing at the very top box, process the code in the +middle, and then terminate at the bottom. Program flow is invariably top to +bottom. Arrows are drawn on the output and input of each box to indicate where +the flow is going. You will notice four black circles, filled, on this +graph. They indicate a connection between the different entitiy. The skull and +crossbones symbol indicates end this graph now. + +\section secForLoop For Loops + The flow of execution is to follow the graph on the screen. Thus, when given a graph like \image html forloop.png it will enter the for loop, and go around and around until the termination -condition is met. +condition is met. The for loop consists of the three boxes in the middle of +this image. On each iteration, a Python command is executed, which is defined +in the Python box in the very middle. You could, of course, put something +different in the middle of the for loop. +The loop variable, initialisation and termination condition are set at the +start of the for loop. To change these, right click on the for loop box and +adjust accordingly. It will generate an exception if you fail to provide an +entry to the Initialise, Test or Increment fields. If this Python code is +incorrect, it will except also. Notice too that the variables all have the +word "self." as the first half. This ensures that variables in one graph will +not interfere with those of another graph. If you wrote a nested for loop, +they should use different variables. + While processing each of the nodes in the supplied graph, it is ignoring all timer events. Execution continues until it falls of the end of the graph, -or passes through an Eventer type structure and goes nowhere. Consider the -following graph +or passes through an Eventer type structure and goes nowhere. + + +\section secEvent Event handling +We describe the handling of events in this section, with a simple example. +Consider the following graph \image html simpleevent.png Added: sofaswitch/trunk/callflow/docs/helloworld.png ============================================================================== Binary file. No diff available.

1 0

[commit] r163 - in sofaswitch/trunk: . callflow callflow/docs
by SofaSWITCH SVN 09 Nov '06

09 Nov '06

Author: derek Date: Thu Nov 9 18:02:28 2006 New Revision: 163 Added: sofaswitch/trunk/callflow/docs.cfg Removed: sofaswitch/trunk/callflow/callflow.dxy Modified: sofaswitch/trunk/Makefile sofaswitch/trunk/callflow/Makefile.am sofaswitch/trunk/callflow/docs/executionflow.dxy sofaswitch/trunk/callflow/docs/overview.dxy sofaswitch/trunk/intro.html sofaswitch/trunk/message.cxx Log: Work on improving the current documentation. Add in links to CallFlow utility, so this is part of SofaSwitch docs. Modified: sofaswitch/trunk/Makefile ============================================================================== --- sofaswitch/trunk/Makefile (original) +++ sofaswitch/trunk/Makefile Thu Nov 9 18:02:28 2006 @@ -29,20 +29,22 @@ all: - @cd sofa ; make both - @cd am ; make both - @cd voip ; make both - @cd mcu ; make both - @cd server ; make both - @cd sound ; make both + @cd sofa ; make both + @cd am ; make both + @cd callflow; make both + @cd mcu ; make both + @cd server ; make both + @cd sound ; make both + @cd voip ; make both all2: @cd sofa ; make -j 2 both - @cd am ; make -j 2 both - @cd voip ; make -j 2 both - @cd mcu ; make -j 2 both - @cd server ; make -j 2 both - @cd sound ; make -j 2 both + @cd am ; make -j 2 both + @cd callflow; make both + @cd mcu ; make -j 2 both + @cd server ; make -j 2 both + @cd sound ; make -j 2 both + @cd voip ; make -j 2 both @@ -50,18 +52,20 @@ @rm -fR $(HOME)/sofa_docs @rm -fR html @doxygen docs.cfg - @cd am ; doxygen docs.cfg - @cd mcu ; doxygen docs.cfg - @cd server ; doxygen docs.cfg - @cd sound ; doxygen docs.cfg - @cd sofa ; doxygen docs.cfg - @cd voip ; doxygen docs.cfg - @mv am/html html/am - @mv mcu/html html/mcu - @mv server/html html/server - @mv sofa/html html/sofa - @mv sound/html html/sound - @mv voip/html html/voip + @cd am ; doxygen docs.cfg + @cd callflow ; doxygen docs.cfg + @cd mcu ; doxygen docs.cfg + @cd server ; doxygen docs.cfg + @cd sofa ; doxygen docs.cfg + @cd sound ; doxygen docs.cfg + @cd voip ; doxygen docs.cfg + @mv am/html html/am + @mv callflow/html html/callflow + @mv mcu/html html/mcu + @mv server/html html/server + @mv sofa/html html/sofa + @mv sound/html html/sound + @mv voip/html html/voip @mv html $(HOME)/sofa_docs Modified: sofaswitch/trunk/callflow/Makefile.am ============================================================================== --- sofaswitch/trunk/callflow/Makefile.am (original) +++ sofaswitch/trunk/callflow/Makefile.am Thu Nov 9 18:02:28 2006 @@ -10,7 +10,7 @@ docs:dox dox: - doxygen callflow.dxy + doxygen docs.cfg veryclean:distclean Added: sofaswitch/trunk/callflow/docs.cfg ============================================================================== --- (empty file) +++ sofaswitch/trunk/callflow/docs.cfg Thu Nov 9 18:02:28 2006 @@ -0,0 +1,223 @@ +# Doxyfile 1.4.6 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = CallFlow +PROJECT_NUMBER = 1.0.0 +OUTPUT_DIRECTORY = +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +USE_WINDOWS_ENCODING = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +BUILTIN_STL_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_DIRECTORIES = NO +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = src docs . +FILE_PATTERNS = *.h *.dxy +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = src docs +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1400 +MAX_DOT_GRAPH_HEIGHT = 1800 +MAX_DOT_GRAPH_DEPTH = 10 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO Modified: sofaswitch/trunk/callflow/docs/executionflow.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/executionflow.dxy (original) +++ sofaswitch/trunk/callflow/docs/executionflow.dxy Thu Nov 9 18:02:28 2006 @@ -7,7 +7,7 @@ \image html forloop.png -it will enter the forloop, and go around and around until the termination +it will enter the for loop, and go around and around until the termination condition is met. While processing each of the nodes in the supplied graph, it is ignoring Modified: sofaswitch/trunk/callflow/docs/overview.dxy ============================================================================== --- sofaswitch/trunk/callflow/docs/overview.dxy (original) +++ sofaswitch/trunk/callflow/docs/overview.dxy Thu Nov 9 18:02:28 2006 @@ -11,11 +11,12 @@ functionality and ease of integrating with exWidgets) and has been released under the MPL license. -Last updated 15 September 2006 Copyright (C) 2006 Indranet Technologies Ltd, All right reserved -\section WhyCallFlow Why do we neeed CallFlow ? +Author, Derek J Smithies, <derek(a)indranet.co.nz> + +\section WhyCallFlow Why do we need CallFlow ? My (DJS) initial thoughts on the design of SofaSwitch was that there would be individual entities (server, voip, am etc) all controlled by a custom script, written in some scripting language. I wrote the entities first, and @@ -26,18 +27,25 @@ original design. This had the unfortunate outcome of making those scripts invalid. A second lesson was learnt - python is not very good on threads. Things like the global interpreter lock started to get in the -way. python script. +way. Further, the scripts became a maintainence nightmare. This was +discouraging. At this stage, I was uncertain. Should I change to a different (and more superior) scripting language? Some thought and discussion showed that python -is the way to go. Choosing an unknonw (but superior?) language like XYZ would +is the way to go. Choosing an unknown (but superior?) language like XYZ would indeed solve the above problems, but introduce two new problems: 1)it is now much harder to get get going in the project and 2)it becomes much harder to -install sofaswitch. Minor considerations such as, "we might loose +install SofaSwitch. Minor considerations such as, "we might loose cross-platform features if we switch to XYZ" were part of the problem space. +Worse still, by demanding the scripting language is written in Python (or +Perl, or Lua, or C, etc) I was raising the bar for the system administrator +before he/she could use SofaSwitch. They were now reqired to learn the +scripting language and how SofaSwitch works. Everyone understands flowcharts - +if only there was a scripting language based on flowcharts. + Clearly, the way ahead was to write a custom utility to write the python -controlscripts. Now, we expect that some may wish to write their own python +control scripts. Now, we expect that some may wish to write their own python scripts. This is fine - you are welcome to learn from our current codebase. Given the modular structure of SofaSwitch, this is inevitable. Different modules will be glued together in different ways. @@ -48,19 +56,22 @@ \section WhatDo What does CallFlow do ? In this section, I describe, in overview, what CallFlow does -\li Draw the diagram of the call handling for one call +\li Draw the diagram of the particular processing required. \li Compile this to python, which creates two files. The first file describes the graph, and the second file describes the handling of the graph. The second file is "hardwired" to load that particular graph file. However, the second file is is, essentially, the same between every compile. \li You use Python to execute the second file, which loads the graph file. +\li Multiple threads of execution in the Python control script are handled + easily, by loading in graph files. Thus, on detecting an incoming call + (for example) a graph file to deal with one incoming voip call is loaded - \subsection history History \li 15 September 2006 - Created by Derek J Smithies \li 21 September 2006 - Add Why section Derek J Smithies +\li 10 November 2006 - spelling & textual improvements Derek J Smithies */ Modified: sofaswitch/trunk/intro.html ============================================================================== --- sofaswitch/trunk/intro.html (original) +++ sofaswitch/trunk/intro.html Thu Nov 9 18:02:28 2006 @@ -18,11 +18,12 @@ <large> <center> -<li><a class="el" href="jopal/html/index.html">voip handler</a> </li> +<li><a class="el" href="voip/html/index.html">voip handler</a> </li> <li><a class="el" href="mcu/html/index.html">conference utility</a> </li> <li><a class="el" href="server/html/index.html">message server</a> </li> <li><a class="el" href="am/html/index.html">answering machine</a> </li> <li><a class="el" href="sound/html/index.html">sound card utility</a> </li> +<li><a class="el" href="callflow/html/index.html">GUI to generate control code</a> </li> </center> </large> Modified: sofaswitch/trunk/message.cxx ============================================================================== --- sofaswitch/trunk/message.cxx (original) +++ sofaswitch/trunk/message.cxx Thu Nov 9 18:02:28 2006 @@ -2,14 +2,10 @@ \page pageMessageProtocol Message Protocol -The protocol used for control communications is described here, in the -following sections. Also described is the relationship between different -components, which is required for the communications protocol to make any -"sense". \li \ref secIntroduction \li \ref secMessageContents -\li \ref secSupervisorWorker +\li \ref secSofaSwitchEntities \li \ref secCurrentCommands \li \ref secServerCommands \li \ref secTransferUdp @@ -21,29 +17,44 @@ \section secIntroduction Introduction -Workers and Supervisors are the doers - entities that control voice -calls. The distinction between them is explained in section -\ref secSupervisorWorker. +As stated before, SofaSwitch consists of many different running applications, +where each different application may run on a different machine and will have +a different purpose. Consequently, there is a need for a standardised method +of communication between the applications which will work transparently across +OS's, hardware types, and network types. -The method by which one Worker/Supervisor sends messages to another -Worker/Supervisor is very simple. A text message is composed, sent to -the server via a TCP socket, which then relays the message on to the -desired destination. Thus, we have a star network. Every -Worker/Supervisor has one TCP connection to the server, for -sending/receiving messages relevant to/from the server. +The protocol used for control communications is described in this page. Also +described is the relationship between different components, which is required +for the communications protocol to make any "sense". -We are opposed to "micro management". Thus, a Supervisor is not required to -worry about the details of any one voice circuit. In fact, the only control a -Supervisor will have over any voice circuit is to create the Worker to handle -that voice circuit. Note however that the Supervisor will be able to report -the status of individual workers/voice circuits. +We describe the syntax for placing the control messages inside TCP +packets. Some justification is given for the choices made. However, there +will be some topics that no amount of justification/discussion will be +convincing enough. -Similarily, when two Workers have to arrange the transfer of audio -data between themselves, it is none of the Controller's business. The -controller should merely say to one worker, "arrange audio transfer -with that worker". Consequently, the Controller is not aware of what -port the Worker is using for audio +A key element in understanding why we chose where communication flows is that +we are opposed to "micro manaagement". By "micro management", we refer to the +practice where one part of the software has an excessive interest in the +minute details of another component in the software. For more details, see +\htmlonly +<a href="http://en.wikipedia.org/wiki/Micromanagement">wikipedia-micro&nbspmanagement</a> +\endhtmlonly + +To illustrate, the Controlling entity directs two nodes to send audio between +them. There are two distinct methods for implementing this: +\li for the Controller to work out what ports are available in the two nodes, + and then advise both nodes to which port to send the audio data + \li two nodes are told they are talking to each other by the Controller. + Then, the two nodes discuss amongst themselves + how they communicate (which could be via tcp, bridging, pipes, etc) + +The first approach is micro management - the Controller does not need to know +about ports. Worse, it constrains the two nodes to only talk via network +ports. The second approach is harder - the nodes are all given some +"intelligence" and have to be able to respond to a wider range of messages. + + \section secMessageContents The contents of all messages Control communication is always via text messages on TCP sockets. The last @@ -56,37 +67,41 @@ Connect to this server. This server will then spawn of a TCPConnection class to listen for all further communications from switch. Node switch then sends a zero terminated string of - <center> "switch"0 </center> +to this server. This string identifies the remote node to this server. On +receipt of this string, the server can make a unique label for the +TCPConnection class, and add it to the internal list. Once the TCPConnection +class has been added to the internal list, full bidirectional comms is now +possible with node "switch". -to this server. This string identifies the remote node to this server. -On receipt of this string, the server can make a unique label for the -TCPConnection class, and add it to the internal list. Once the -TCPConnection class has been added to the internal list, full -bidirectional comms is now possible with node "switch". +The server assumes all remote nodes will correctly choose a valid unique ID. +My preference is that the supervisor connects with a label such as +"controller", "voip", or "am". Workers spawned by that supervisor have a +number appended to the supervisor's label. Thus, the voip supervisor connects +as "voip". All workers spawned by the voip supervisor will be called "voip1", +"voip2", etc. This naming scheme makes debugging somewhat easier, as you can +identify, from the label, the origin/destination of a message. + In some cases, the connecting node has no idea what unique ID to specify. It -will (in this case) use the string "?" and let the server assign a unique ID. +will (in this case) use the string "?"0 and let the server assign a unique ID. The connecting node can then use the command "whoami" to enquire of the server -to find out what unique ID was assigned. +to find out what unique ID was assigned. This indentification process is ideal +for Controllers. You can invoke a script which launches a new Controller to do +some adjustment, without worrying about "will this script correctly pick a +unique id?". -The server assumes all remote nodes will correctly choose a valid -unique ID. My preference is that the supervisor connects with a -label such as "controller", "voip", or "am". Workers spawned by -that supervisor have a number appended to the supervisor's -label. Thus, the voip supervisor connects as "voip". All workers -spawned by the voip supervisor will be called "voip1", "voip2", -etc. This naming scheme makes debugging somewhat easier, as you can -identify, from the label, the origin/destination of a message. - -A message sent to the server has the format -remoteNode : message - +A control message, which is sent via the server has the format +<center> + remoteNode : message +</center> The server changes the message, and sends it to the remote node as +<center> sourceNode : message +</center> Thus, this server has changed the message. This is acceptable, as it means that the receiving node is able to determine who sent the @@ -97,41 +112,77 @@ To illustrate, suppose A sends the message "status" to B. A sends to the sever - +<center> "B:status"0 (string, with a trailing zero byte) +</center> the server receives this packet and then sends to B - +<center> "A:status"0 (string, with a trailing zero byte) +</center> Note - the quotes are there to illustrate it is a string, and are not included in the packet. -\section secSupervisorWorker Supervisor and Worker -It is important to note that a sofaswitch application will have two distinct endpoints in it. -The application will have 1 Supervisor and multiple Workers. +\section secSofaSwitchEntities Entities provided by SofaSwitch +There are several distinct entities used by SofaSwitch. It is important to +understand the difference between them, and how the entities interact. + <center> <table width="600"> -<tr><td> Worker </td><td> handles commands associated with one particular voip circuit. - Thus, for a voice over IP application, there will be X workers - for the X active voice calls in the voip application. +<tr><td> Worker </td><td> handles commands associated with one particular audio circuit. + In a voip application, which is capable of handling 30 (say) concurrent calls, + there will be (at most) 30 active Workers. </td></tr> <tr><td> Supervisor</td><td> responsible for establishing (as required) new - Workers. It can be used to terminate the sofaswitch - application. Messages which are appropriate for a - particular Worker are never ever sent via the - supervisor </td></tr> -</table>. + Workers. It can be used to terminate the SofaSwitch + application. Messages which are appropriate for a particular + Worker are never ever sent via the Supervisor +</td></tr> +<tr><td>Server</td><td> is responsible for passing control messages between + different SofaSwitch entities. There is only one instance of + a Server in the SofaSwitch network, so all control messages + pass through the Server. Thus, the Server knows about every + active SofaSwitch entity. +</td></tr> +<tr><td>Controller</td><td> is responsible for generating control mesasges to + get things to happen. It is this entity who initiates + responses from the SofaSwitch system as real world events + happen. There may be multiple active Controllers - this is a + matter of implementation for the user. +</td></tr> +</table> </center> -Even the controller can be split up into a Worker/Supervisor -distinction. The Worker in the controller sends commands appropriate -to managing one current call. The Supervisor creates Workers to handle -new calls, as required. +Even the controller can be split up into a Worker/Supervisor distinction. The +Worker in the controller sends commands appropriate to managing one current +call. The Supervisor creates Workers to handle new calls, as required. How the +Controller is configured/written is entirely up to the user. We have provided +Python examples, and a graphical editor to generate those Python examples, but +the user may choose to implement a completely different system. + +Workers and Supervisors exist together inside one running application to +handle voice calls. The Worker is the only entity who "touches" raw audio +data. Everything else worries about control. The Supervisor is in direct +contact with 1 (or more) Workers. Thus, the supervisor is responsible for +Worker creation/initiation/deletion. There are several SofaSwitch +applications (am, mcu, voip), each of which contain one Supervisor and +multiple workers. By sending audio between the different workers, we can +create the functionality of a voice switch. + +We have a "star" shaped network, as all control messages go via the +server. However, this is not strictly true as raw audio will pass directly +between any two workers. Alternatively, audio is never ever passed through the +server. This design decision was made so that any extra burst of processing +required on the server will not slow down/interrupt audio traffic. Further, +removing audio traffic from the server reduces the load on the server +considerably. + \section secCurrentCommands Worker/Supervisor commands + The following commands are provided in this protocol. They are designed to be sent from a Worker/Supervisor to a Worker/Supervisor. Most will be sent by Workers, but there is no check @@ -186,10 +237,9 @@ Some commands are actioned by the server, and not passed on to the destination node. These commands do not have a destination node specified. They are therefore of the format: - - +<center> "command"0 - +</center> which contains no colon character, and is terminated by a zero byte. As before, the quotes are there to illustrate it is a string, and are not included in the packet. @@ -209,11 +259,13 @@ are. This command is useful when we are some controller who has connected to the server and asked the server to generate a unique Id for us. It is also a debugging tool from the command - prompt case - we can enquire of the server to check our ID. + prompt case - we can enquire of the server to report our ID. </td></tr> -<tr><td>adviseontermination remNode</td></td>This commands the server to (on this node - terminating) send a message to the specified node (remNode). The message - will advise remNode that this this node has died. +<tr><td>adviseontermination remNode</td><td>This commands the server to (on + this node terminating) send a message to the specified node + (remNode). The message will advise remNode that this this + node has died. Thus, the controller will get a message if the + box running the answer machine (for example) is unplugged. </td></tr> </table> </center>

1 0