Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > 166a9807065357168d48043297ca7304 > files > 41

ocamlviz-1.01-9.mga5.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Ocamlviz_threads.html">
<link rel="next" href="Timemap.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Binary" rel="Chapter" href="Binary.html">
<link title="Bproto" rel="Chapter" href="Bproto.html">
<link title="Db" rel="Chapter" href="Db.html">
<link title="Graph" rel="Chapter" href="Graph.html">
<link title="Monitor_sig" rel="Chapter" href="Monitor_sig.html">
<link title="Ocamlviz" rel="Chapter" href="Ocamlviz.html">
<link title="Ocamlviz_threads" rel="Chapter" href="Ocamlviz_threads.html">
<link title="Protocol" rel="Chapter" href="Protocol.html">
<link title="Timemap" rel="Chapter" href="Timemap.html"><title>Protocol</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Ocamlviz_threads.html" title="Ocamlviz_threads">Previous</a>
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;<a class="post" href="Timemap.html" title="Timemap">Next</a>
</div>
<h1>Module <a href="type_Protocol.html">Protocol</a></h1>

<pre><span class="keyword">module</span> Protocol: <code class="code">sig</code> <a href="Protocol.html">..</a> <code class="code">end</code></pre><div class="info module top">
The signature of protocol datas<br>
</div>
<hr width="100%">

<pre><code><span id="TYPEkind"><span class="keyword">type</span> <code class="type"></code>kind</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Point"><span class="constructor">Point</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Time"><span class="constructor">Time</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Value_int"><span class="constructor">Value_int</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Value_float"><span class="constructor">Value_float</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Value_bool"><span class="constructor">Value_bool</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Value_string"><span class="constructor">Value_string</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Tag_count"><span class="constructor">Tag_count</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Tag_size"><span class="constructor">Tag_size</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Ktree"><span class="constructor">Ktree</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Hash"><span class="constructor">Hash</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Special"><span class="constructor">Special</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >for the garbage collector stats and total execution time</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Klog"><span class="constructor">Klog</span></span></code></td>

</tr></table>



<pre><code><span id="TYPEvariant"><span class="keyword">type</span> <code class="type"></code>variant</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvariant.Node"><span class="constructor">Node</span></span> <span class="keyword">of</span> <code class="type">string * <a href="Protocol.html#TYPEvariant">variant</a> list</code></code></td>

</tr></table>

<div class="info ">
The type that will be observed in the module Tree.<br>
</div>


<pre><code><span id="TYPEvalue"><span class="keyword">type</span> <code class="type"></code>value</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Int"><span class="constructor">Int</span></span> <span class="keyword">of</span> <code class="type">int</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Float"><span class="constructor">Float</span></span> <span class="keyword">of</span> <code class="type">float</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.String"><span class="constructor">String</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Bool"><span class="constructor">Bool</span></span> <span class="keyword">of</span> <code class="type">bool</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Int64"><span class="constructor">Int64</span></span> <span class="keyword">of</span> <code class="type">Int64.t</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Tree"><span class="constructor">Tree</span></span> <span class="keyword">of</span> <code class="type"><a href="Protocol.html#TYPEvariant">variant</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.No_value"><span class="constructor">No_value</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Collected"><span class="constructor">Collected</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Killed"><span class="constructor">Killed</span></span></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Hashtable"><span class="constructor">Hashtable</span></span> <span class="keyword">of</span> <code class="type"><a href="Protocol.html#TYPEvalue">value</a> * <a href="Protocol.html#TYPEvalue">value</a> * <a href="Protocol.html#TYPEvalue">value</a> * <a href="Protocol.html#TYPEvalue">value</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTvalue.Log"><span class="constructor">Log</span></span> <span class="keyword">of</span> <code class="type">(float * string) list</code></code></td>

</tr></table>



<pre><span id="TYPEtag"><span class="keyword">type</span> <code class="type"></code>tag</span> = <code class="type">int</code> </pre>
<div class="info ">
A tag is an unique representation of a Ocamlviz data. The tags 0,1,2 are always taken.<br>
</div>


<pre><code><span id="TYPEmsg"><span class="keyword">type</span> <code class="type"></code>msg</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmsg.Declare"><span class="constructor">Declare</span></span> <span class="keyword">of</span> <code class="type"><a href="Protocol.html#TYPEtag">tag</a> * <a href="Protocol.html#TYPEkind">kind</a> * string</code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmsg.Send"><span class="constructor">Send</span></span> <span class="keyword">of</span> <code class="type"><a href="Protocol.html#TYPEtag">tag</a> * <a href="Protocol.html#TYPEvalue">value</a></code></code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTmsg.Bind"><span class="constructor">Bind</span></span> <span class="keyword">of</span> <code class="type"><a href="Protocol.html#TYPEtag">tag</a> list</code></code></td>

</tr></table>

<div class="info ">
There are 3 sorts of messages: <ul>
<li><code class="code">Declare</code> to send tags to new clients</li>
<li><code class="code">Send</code> to send values to clients</li>
<li><code class="code">Bind</code> to send bindings to new clients</li>
</ul>
<br>
</div>

</body></html>