Kaynağa Gözat

More notes on MvK communication

Yentl Van Tendeloo 8 yıl önce
ebeveyn
işleme
5ea1c5b3d2

BIN
doc/_build/doctrees/interface.doctree


+ 7 - 0
doc/_build/html/_sources/interface.txt

@@ -83,6 +83,13 @@ While this list mostly resembles JSON, there are some important differences:
 * Null object is not supported;
 * Action type is new, and contains a string representation (without quotes!) of the action language construct to add
 
+As response, the *set_input* will always receive the same reply if the message was correctly deserialized.
+Receiving a reply does *NOT* mean that a message was consumed by the user, it only means that the message was correctly added to the input queue of that user.
+
+A *get_output* request blocks until a value is available in the users output queue.
+The reply to this message will then contain a JSON serialized (with identical remarks as for *set_input*) containing the value that was output.
+Note that now the *null* message is possible, in case the node that is being outputted does not contain a value (or is an edge).
+
 Performance notes
 ^^^^^^^^^^^^^^^^^
 

+ 26 - 1
doc/_build/html/interface.html

@@ -23,7 +23,9 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="Modelverse 0.4.0 documentation" href="index.html" /> 
+    <link rel="top" title="Modelverse 0.4.0 documentation" href="index.html" />
+    <link rel="next" title="Communication models" href="communication_models.html" />
+    <link rel="prev" title="Internal workings" href="internal.html" /> 
   </head>
   <body role="document">
     <div class="related" role="navigation" aria-label="related navigation">
@@ -32,6 +34,12 @@
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="communication_models.html" title="Communication models"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="internal.html" title="Internal workings"
+             accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Modelverse 0.4.0 documentation</a> &#187;</li> 
       </ul>
     </div>  
@@ -177,6 +185,11 @@ Note that there are some minor differences between our encoding and JSON encodin
 <li>Null object is not supported;</li>
 <li>Action type is new, and contains a string representation (without quotes!) of the action language construct to add</li>
 </ul>
+<p>As response, the <em>set_input</em> will always receive the same reply if the message was correctly deserialized.
+Receiving a reply does <em>NOT</em> mean that a message was consumed by the user, it only means that the message was correctly added to the input queue of that user.</p>
+<p>A <em>get_output</em> request blocks until a value is available in the users output queue.
+The reply to this message will then contain a JSON serialized (with identical remarks as for <em>set_input</em>) containing the value that was output.
+Note that now the <em>null</em> message is possible, in case the node that is being outputted does not contain a value (or is an edge).</p>
 <div class="section" id="performance-notes">
 <h3>Performance notes<a class="headerlink" href="#performance-notes" title="Permalink to this headline">¶</a></h3>
 <p>For performance reasons, sending a huge amount of data to the Modelverse (<em>e.g.</em>, a compiled program), should not happen with individual requests for each line.
@@ -204,6 +217,12 @@ The content of this parameter should be a JSON encoded list of all individual va
 </li>
 </ul>
 
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="internal.html"
+                        title="previous chapter">Internal workings</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="communication_models.html"
+                        title="next chapter">Communication models</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -231,6 +250,12 @@ The content of this parameter should be a JSON encoded list of all individual va
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
+        <li class="right" >
+          <a href="communication_models.html" title="Communication models"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="internal.html" title="Internal workings"
+             >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Modelverse 0.4.0 documentation</a> &#187;</li> 
       </ul>
     </div>

Dosya farkı çok büyük olduğundan ihmal edildi
+ 1 - 1
doc/_build/html/searchindex.js


+ 7 - 0
doc/interface.rst

@@ -83,6 +83,13 @@ While this list mostly resembles JSON, there are some important differences:
 * Null object is not supported;
 * Action type is new, and contains a string representation (without quotes!) of the action language construct to add
 
+As response, the *set_input* will always receive the same reply if the message was correctly deserialized.
+Receiving a reply does *NOT* mean that a message was consumed by the user, it only means that the message was correctly added to the input queue of that user.
+
+A *get_output* request blocks until a value is available in the users output queue.
+The reply to this message will then contain a JSON serialized (with identical remarks as for *set_input*) containing the value that was output.
+Note that now the *null* message is possible, in case the node that is being outputted does not contain a value (or is an edge).
+
 Performance notes
 ^^^^^^^^^^^^^^^^^