<!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 href="Ocamlviz_threads.html">Previous</a> <a href="index.html">Up</a> <a href="Timemap.html">Next</a> </div> <center><h1>Module <a href="type_Protocol.html">Protocol</a></h1></center> <br> <pre><span class="keyword">module</span> Protocol: <code class="code">sig</code> <a href="Protocol.html">..</a> <code class="code">end</code></pre>The signature of protocol datas<br> <hr width="100%"> <br><code><span class="keyword">type</span> <a name="TYPEkind"></a><code class="type"></code>kind = </code><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Point</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Time</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Value_int</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Value_float</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Value_bool</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Value_string</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Tag_count</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Tag_size</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Ktree</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Hash</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Special</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 class="constructor">Klog</span></code></td> </tr></table> <br><code><span class="keyword">type</span> <a name="TYPEvariant"></a><code class="type"></code>variant = </code><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Node</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> <br><code><span class="keyword">type</span> <a name="TYPEvalue"></a><code class="type"></code>value = </code><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Int</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 class="constructor">Float</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 class="constructor">String</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 class="constructor">Bool</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 class="constructor">Int64</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 class="constructor">Tree</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 class="constructor">No_value</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Collected</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Killed</span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Hashtable</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 class="constructor">Log</span> <span class="keyword">of</span> <code class="type">(float * string) list</code></code></td> </tr></table> <pre><span class="keyword">type</span> <a name="TYPEtag"></a><code class="type"></code>tag = <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> <br><code><span class="keyword">type</span> <a name="TYPEmsg"></a><code class="type"></code>msg = </code><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span class="constructor">Declare</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 class="constructor">Send</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 class="constructor">Bind</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>
