Author: derek Date: Mon Jun 11 18:51:11 2007 New Revision: 306 Modified: sofaswitch/trunk/callflow/docs/chap3.sgml sofaswitch/trunk/callflow/src/callflow.cpp Log: Tidy up docs Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Mon Jun 11 18:51:11 2007 @@ -25,7 +25,7 @@ Consider figure <xref xrefstyle="select: labelnumber" linkend="answercallicon"/> which shows the icon and graph representation of the control structure used to indicate to a remote &sofaswitch; node that an incoming voip/TDM call can be answered with a yes (or no). -<figure id="icon"> +<figure id="answercallicon"> <title>Accept call control element</title> <informaltable frame="all"> <tgroup cols="2"> @@ -401,10 +401,10 @@ <para> The connections to this box are: <itemizedlist> - <listitem><para>top: is linked to the body of the - loop</para></listitem> + <listitem><para>top: is linked to the body of the loop + </para></listitem> <listitem><para>left: is joined to the left connector of the for loop. - + </para></listitem> <listitem><para>bottom: is joined to the control structrues that are to be executed after the for loop has finished. </para></listitem> @@ -1169,7 +1169,7 @@ linkend="masternodeicon"/> which shows the icon and graph representation of the control structure used to indicate that a remote &sofaswitch; node should send events (such as <literal>incoming call, answer ?</literal>) to this graph. -<figure id="icon"> +<figure id="masternodeicon"> <title>Master node control element</title> <informaltable frame="all"> <tgroup cols="2"> @@ -1249,8 +1249,8 @@ <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="messageicon"/> which shows the icon and graph representation of the control structure used to send an arbitrary -&sofaswitch command -<figure id="icon"> +&sofaswitch; command to a remote &sofaswitch; entity. +<figure id="messageicon"> <title>Message control element</title> <informaltable frame="all"> <tgroup cols="2"> @@ -1277,6 +1277,21 @@ </figure> </para> +<para> +<literal>Message</literal> represents the core component of the &callflow; +control structures that control the operation of remote &sofaswitch; +nodes. With this message control structure, one can extend &sofaswitch; to send +different messages as required. Thus, you could use this to communicate between +two control graphs, or send custom messages to a &sofaswitch; entity. +</para> + +<para> +All &sofaswitch; messages have a trailing <literal>0</literal> byte at the +end. This provides a simple means of breaking up messages joined in the TCP +transmission process. It is not required for the user to place a +<literal>0</literal> byte at end of the custom message. The operation of this +control structure will always append the <literal>0</literal> byte. +</para> <para> The message control structure, on selecting the right mouse button, brings up a properties @@ -1291,13 +1306,17 @@ </literal></entry> <entry><para> The text which is displayed when the mouse hovers over this object for 3 seconds. -Ideally, you should extend this to contain information +Ideally, you should extend this to contain information about the message type +and destination &sofaswitch; node. </para></entry></row> <row> <entry><literal> +Message to send (Python code) </literal></entry> <entry><para> - +This Python code (or string literal) describes the message to be sent. The +format you should use is <literal>remoteNodeId</literal> followed by a colon, +followed by the <literal>message to be sent</literal> </para></entry></row> @@ -1442,7 +1461,7 @@ and graph representation of the control structure used to cause DTMF to be sent to a TDM or voip &sofaswitch; element, which in turn sends the DTMF to the remote end of the call. -<figure id="icon"> +<figure id="senddtmficon"> <title>Send DTMF control element</title> <informaltable frame="all"> <tgroup cols="2"> Modified: sofaswitch/trunk/callflow/src/callflow.cpp ============================================================================== --- sofaswitch/trunk/callflow/src/callflow.cpp (original) +++ sofaswitch/trunk/callflow/src/callflow.cpp Mon Jun 11 18:51:11 2007 @@ -594,7 +594,7 @@ callflowHelpWindow->Create(core, wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE); - callflowHtmlHelp.AddBook(wxFileName(_T("../docs/doc.zip"))); + callflowHtmlHelp.AddBook(wxFileName(_T("doc.zip"))); callflowHtmlHelp.Display(_T("Introduction")); #else //Respond to menu here