Skip to main content
aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEugene Tarassov2012-05-04 15:47:54 -0400
committerEugene Tarassov2012-05-04 15:47:54 -0400
commit922786dbaaa7d51b7f5e0282ed99fac898c27184 (patch)
tree71386ae3ec82bfd9d021b97be77eea116d5a19bd /docs
parent48a8e4446f9ba18dac68840fd78f05ba797e0acc (diff)
downloadorg.eclipse.tcf-922786dbaaa7d51b7f5e0282ed99fac898c27184.tar.gz
org.eclipse.tcf-922786dbaaa7d51b7f5e0282ed99fac898c27184.tar.xz
org.eclipse.tcf-922786dbaaa7d51b7f5e0282ed99fac898c27184.zip
TCF Docs: moved Lua integration details into a separate file
Diffstat (limited to 'docs')
-rw-r--r--docs/TCF Getting Started.html161
-rw-r--r--docs/TCF Lua Integration.html179
-rwxr-xr-xdocs/TCF Service - Stack Trace.html2
-rw-r--r--docs/index.html4
4 files changed, 186 insertions, 160 deletions
diff --git a/docs/TCF Getting Started.html b/docs/TCF Getting Started.html
index 2f5145047..b3fa2a759 100644
--- a/docs/TCF Getting Started.html
+++ b/docs/TCF Getting Started.html
@@ -165,165 +165,8 @@ in Wind River VxWorks Simulator user's guide for details.</p>
<h2><a name='TcfLua'>TCF Integration with Lua</a></h2>
-<p>The TCF integration with Lua allows writing TCF client and server programs in the Lua programming lanugage. The integration is done so the main loop is the TCF event dispatch loop. At startup a Lua program is invoked to allow an initial setup after which it should return to enter the TCF dispatch loop.</p>
-
-<p>TCF functions are accessible from the Lua table named "tcf". Accessible functions are:</p>
-
-<table border=1 cellpadding=8>
- <tr>
- <th>Function
- <th>Callback
- <th>Description
- <tr>
- <td><code>read_command(read_command_callback)
- <td><code>read_command_callback(string)
- <td>Reads one line from stdin or if the -s command line option is specified from the specified file.
- <tr>
- <td><code>peer = peer_server_find(peer_name)
- <td>NA
- <td>Looks up peer object with the specified name. Returns <code>nil</code> if not found.
- <tr>
- <td><code>peers = peer_server_list()
- <td>NA
- <td>Returns a table of discovered peer objects.
- <tr>
- <td><code>peer = peer_server_from_url(peer_url)
- <td>NA
- <td>Creates a peer object from the specified URL.
- <tr>
- <td><code>protocol = protocol_alloc()
- <td>NA
- <td>Created a new protocol object.
- <tr>
- <td><code>channel_connect(peer, protocol, connect_callback)
- <td><code>connect_callback(channel, errorString)
- <td>Creates connection to specified peer.
- <tr>
- <td><code>event = post_event(post_event_callback, micro_seconds)
- <td><code>post_event_callback()
- <td>The <code>micro_seconds</code> argument is optional. Then not present the callback function will be invoked after currently pending event have been processed.
-</table>
-
-<p>Protocol object functions:</p>
-
-<table border=1 cellpadding=8>
- <tr>
- <th>Function
- <th>Callback
- <th>Description
- <tr>
- <td><code>command_handler(protocol, service, name, command_callback)
- <td><code>command_callback(token, data)
- <td>Register command handler for <code>service</code> and <code>name</code> with <code>protocol</code>. The <code>command_callback</code> function will be called each time a command of the specified name and service is received on a channel associated with the protocol object.
-</table>
-
-<p>Channel object functions:</p>
-
-<table border=1 cellpadding=8>
- <tr>
- <th>Function
- <th>Callback
- <th>Description
- <tr>
- <td><code>close(channel)
- <td>NA
- <td>Disconnects the specified channel.
- <tr>
- <td><code>connecting_handler(channel, connecting_callback)
- <td><code>connecting_callback()
- <td>Register callback function which is called when the channel enters connecting state.
- <tr>
- <td><code>connected_handler(channel, connected_callback)
- <td><code>connected_callback()
- <td>Register callback function which is called when the channel enters connected state.
- <tr>
- <td><code>receive_handler(channel, receive_callback)
- <td><code>receive_callback()
- <td>Register callback function which is called when the channel receives a message.
- <tr>
- <td><code>disconnected_handler(channel, disconnected_callback)
- <td><code>disconnected_callback()
- <td>Register callback function which is called when the channel is disconnected.
- <tr>
- <td><code>event_handler(channel, service, name, event_callback)
- <td><code>event_callback(data)
- <td>Register callback function which is called when an event for <code>service</code> and <code>name</code> is received.
- <tr>
- <td><code>start(channel)
- <td>NA
- <td>Starts communication on channel.
- <tr>
- <td><code>send_command(channel, service, name, data, replay_callback)
- <td><code>replay_callback(data, error)
- <td>Send a command to channel and register callback when reply is received.
- <tr>
- <td><code>services = get_services(channel)
- <td>NA
- <td>Create a table of service names supported by remote peer.
-</table>
-
-<p>Peer object functions:</p>
-
-<table border=1 cellpadding=8>
- <tr>
- <th>Function
- <th>Callback
- <th>Description
- <tr>
- <td><code>id = getid(peer)
- <td>NA
- <td>Return ID of peer.
- <tr>
- <td><code>getnames(peer)
- <td>NA
- <td>Return table of peer propery names.
- <tr>
- <td><code>getvalue(peer, name)
- <td>NA
- <td>Return value of propery <code>name</code>.
- <tr>
- <td><code>setvalue(peer, name, value)
- <td>NA
- <td>Set value of propery <code>name</code>.
- <tr>
- <td><code>getflags(peer)
- <td>NA
- <td>Return table of flags for peer.
- <tr>
- <td><code>setflags(peer, flags)
- <td>NA
- <td>Set flags for peer.
-</table>
-
-<p>Event object functions:</p>
-
-<table border=1 cellpadding=8>
- <tr>
- <th>Function
- <th>Callback
- <th>Description
- <tr>
- <td><code>cancel(event)
- <td>NA
- <td>Cancel event created by <code>post_event()</code>.
-</table>
-
-<h3>Download and Build</h3>
-
-The integration has only been tested on Linux at this point.
-
-<p><code>cd &lt;<i>luadir</i>&gt;
-<br>curl -O http://www.lua.org/ftp/lua-5.1.4.tar.gz
-<br>tar zxf lua-5.1.4.tar.gz
-<br>cd lua-5.1.4
-<br>make linux
-<br>make local
-<br>cd &lt;<i>tcfdir</i>&gt;/agent
-<br>make LUADIR=&lt;<i>luadir</i>&gt;/lua-5.1.4
-</code>
-
-<p><code>./obj/GNU/Linux/i686/Debug/tcflua tcf_example.lua
-</code>
+<p>The TCF integration with Lua allows writing TCF client and server programs in the Lua programming lanugage.
+See <a href='TCF Lua Integration.html'>TCF Lua Integration</a> for details.
<h2><a name='Browsing'>Browsing Agent Source Code in CDT</a></h2>
On Linux, the default configuration from the CDT .project file included in TCF
diff --git a/docs/TCF Lua Integration.html b/docs/TCF Lua Integration.html
new file mode 100644
index 000000000..a99b0ae5c
--- /dev/null
+++ b/docs/TCF Lua Integration.html
@@ -0,0 +1,179 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+ <title>Target Communication Framework: Lua Integration</title>
+</head>
+
+<body lang='EN-US'>
+
+<h1>Target Communication Framework: Lua Integration</h1>
+
+<p>Copyright (c) 2007, 2012 Wind River Systems, Inc. Made available under the EPL v1.0
+<p>Direct comments, questions to the <a href="https://dev.eclipse.org/mailman/listinfo/tcf-dev">tcf-dev@eclipse.org</a> mailing list
+
+<h2><a name='TcfLua'>TCF Integration with Lua</a></h2>
+
+<p>The TCF integration with Lua allows writing TCF client and server programs in the Lua programming language.
+The integration is done so the main loop is the TCF event dispatch loop.
+At startup a Lua program is invoked to allow an initial setup after which it should return to enter the TCF dispatch loop.</p>
+
+<p>TCF functions are accessible from the Lua table named "tcf". Accessible functions are:</p>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Function
+ <th>Callback
+ <th>Description
+ <tr>
+ <td><code>read_command(read_command_callback)
+ <td><code>read_command_callback(string)
+ <td>Reads one line from stdin or if the -s command line option is specified from the specified file.
+ <tr>
+ <td><code>peer = peer_server_find(peer_name)
+ <td>NA
+ <td>Looks up peer object with the specified name. Returns <code>nil</code> if not found.
+ <tr>
+ <td><code>peers = peer_server_list()
+ <td>NA
+ <td>Returns a table of discovered peer objects.
+ <tr>
+ <td><code>peer = peer_server_from_url(peer_url)
+ <td>NA
+ <td>Creates a peer object from the specified URL.
+ <tr>
+ <td><code>protocol = protocol_alloc()
+ <td>NA
+ <td>Created a new protocol object.
+ <tr>
+ <td><code>channel_connect(peer, protocol, connect_callback)
+ <td><code>connect_callback(channel, errorString)
+ <td>Creates connection to specified peer.
+ <tr>
+ <td><code>event = post_event(post_event_callback, micro_seconds)
+ <td><code>post_event_callback()
+ <td>The <code>micro_seconds</code> argument is optional. Then not present the callback function will be invoked after currently pending event have been processed.
+</table>
+
+<p>Protocol object functions:</p>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Function
+ <th>Callback
+ <th>Description
+ <tr>
+ <td><code>command_handler(protocol, service, name, command_callback)
+ <td><code>command_callback(token, data)
+ <td>Register command handler for <code>service</code> and <code>name</code> with <code>protocol</code>. The <code>command_callback</code> function will be called each time a command of the specified name and service is received on a channel associated with the protocol object.
+</table>
+
+<p>Channel object functions:</p>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Function
+ <th>Callback
+ <th>Description
+ <tr>
+ <td><code>close(channel)
+ <td>NA
+ <td>Disconnects the specified channel.
+ <tr>
+ <td><code>connecting_handler(channel, connecting_callback)
+ <td><code>connecting_callback()
+ <td>Register callback function which is called when the channel enters connecting state.
+ <tr>
+ <td><code>connected_handler(channel, connected_callback)
+ <td><code>connected_callback()
+ <td>Register callback function which is called when the channel enters connected state.
+ <tr>
+ <td><code>receive_handler(channel, receive_callback)
+ <td><code>receive_callback()
+ <td>Register callback function which is called when the channel receives a message.
+ <tr>
+ <td><code>disconnected_handler(channel, disconnected_callback)
+ <td><code>disconnected_callback()
+ <td>Register callback function which is called when the channel is disconnected.
+ <tr>
+ <td><code>event_handler(channel, service, name, event_callback)
+ <td><code>event_callback(data)
+ <td>Register callback function which is called when an event for <code>service</code> and <code>name</code> is received.
+ <tr>
+ <td><code>start(channel)
+ <td>NA
+ <td>Starts communication on channel.
+ <tr>
+ <td><code>send_command(channel, service, name, data, replay_callback)
+ <td><code>replay_callback(data, error)
+ <td>Send a command to channel and register callback when reply is received.
+ <tr>
+ <td><code>services = get_services(channel)
+ <td>NA
+ <td>Create a table of service names supported by remote peer.
+</table>
+
+<p>Peer object functions:</p>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Function
+ <th>Callback
+ <th>Description
+ <tr>
+ <td><code>id = getid(peer)
+ <td>NA
+ <td>Return ID of peer.
+ <tr>
+ <td><code>getnames(peer)
+ <td>NA
+ <td>Return table of peer propery names.
+ <tr>
+ <td><code>getvalue(peer, name)
+ <td>NA
+ <td>Return value of propery <code>name</code>.
+ <tr>
+ <td><code>setvalue(peer, name, value)
+ <td>NA
+ <td>Set value of propery <code>name</code>.
+ <tr>
+ <td><code>getflags(peer)
+ <td>NA
+ <td>Return table of flags for peer.
+ <tr>
+ <td><code>setflags(peer, flags)
+ <td>NA
+ <td>Set flags for peer.
+</table>
+
+<p>Event object functions:</p>
+
+<table border=1 cellpadding=8>
+ <tr>
+ <th>Function
+ <th>Callback
+ <th>Description
+ <tr>
+ <td><code>cancel(event)
+ <td>NA
+ <td>Cancel event created by <code>post_event()</code>.
+</table>
+
+<h3>Download and Build</h3>
+
+The integration has only been tested on Linux at this point.
+
+<p><code>cd &lt;<i>luadir</i>&gt;
+<br>curl -O http://www.lua.org/ftp/lua-5.1.4.tar.gz
+<br>tar zxf lua-5.1.4.tar.gz
+<br>cd lua-5.1.4
+<br>make linux
+<br>make local
+<br>cd &lt;<i>tcfdir</i>&gt;/agent
+<br>make LUADIR=&lt;<i>luadir</i>&gt;/lua-5.1.4
+</code>
+
+<p><code>./obj/GNU/Linux/i686/Debug/tcflua tcf_example.lua
+</code>
+
+</body>
+</html>
diff --git a/docs/TCF Service - Stack Trace.html b/docs/TCF Service - Stack Trace.html
index e9be5b37c..a9168d695 100755
--- a/docs/TCF Service - Stack Trace.html
+++ b/docs/TCF Service - Stack Trace.html
@@ -103,7 +103,7 @@ Cached context data should by flushed when parent thread is resumed.</p>
<li><code><b><font face="Courier New" size=2 color=#333399>"Name" : <i>&lt;string&gt;</i></font></b></code>
- context name if context is a stack.
-
+
<li><code><b><font face="Courier New" size=2 color=#333399>"TopFrame" : <i>&lt;boolean&gt;</i></font></b></code>
- true if the frame is top frame on a stack.
diff --git a/docs/index.html b/docs/index.html
index dfa0fa5d6..f1c031e1c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -48,6 +48,10 @@
<td>
<a href='TCF_UDP_Discovery.html'>TCF UDP Discovery</a>
<td width='500'>TCF UDP Discovery protocol specifications
+ <tr>
+ <td>
+ <a href='TCF Lua Integration.html'>TCF Lua Integration</a>
+ <td width='500'>Using Lua programming language with TCF
</table>
</body>

Back to the top