Browse Source

Added brief section about the models currently in use, including a
figure of the network communication

Yentl Van Tendeloo 5 years ago
parent
commit
229d03c30e

BIN
doc/_build/doctrees/index.doctree


BIN
doc/_build/doctrees/models.doctree


File diff suppressed because it is too large
+ 5017 - 0
doc/_build/html/_images/mvk_server.svg


File diff suppressed because it is too large
+ 1719 - 0
doc/_build/html/_images/mvs_server.svg


+ 1 - 0
doc/_build/html/_sources/index.txt

@@ -20,3 +20,4 @@ Contents:
    Advanced examples <advanced>
    Common problems and solutions <problems>
    Internal workings <internal>
+   Models <models>

+ 26 - 0
doc/_build/html/_sources/models.txt

@@ -0,0 +1,26 @@
+Models
+======
+
+Practically every part of the Modelverse is modelled one way or the other.
+We briefly touch upon the different aspects and how they are modelled.
+
+Network interface
+-----------------
+
+The network communication in the Modelverse builds on top of the raw socket implementation of Python.
+Whereas we use normal HTTP requests, we explicitly opted not to use these libraries.
+Many of these libraries hide important implementation details, such as how successive requests are handled (sequential, threaded, ...), whether or not to keep connections open and reuse them, which HTTP version to implement, and so on.
+As the HTTP protocol is a simple protocol, we reimplemented it completely in SCCD (StateCharts and Class Diagrams).
+
+There are two network components: a server in the MvS, and a server and client in the MvK.
+These are discussed next.
+
+MvS server
+^^^^^^^^^^
+
+.. image:: img/mvs_server.svg
+
+MvK server
+^^^^^^^^^^
+
+.. image:: img/mvk_server.svg

+ 4 - 0
doc/_build/html/index.html

@@ -111,6 +111,10 @@
 <li class="toctree-l2"><a class="reference internal" href="internal.html#adding-a-precompiled-function">Adding a precompiled function</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="models.html">Models</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="models.html#network-interface">Network interface</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </div>

+ 10 - 0
doc/_build/html/internal.html

@@ -24,6 +24,7 @@
     <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="next" title="Models" href="models.html" />
     <link rel="prev" title="Common problems and solutions" href="problems.html" /> 
   </head>
   <body role="document">
@@ -33,6 +34,9 @@
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="models.html" title="Models"
+             accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="problems.html" title="Common problems and solutions"
              accesskey="P">previous</a> |</li>
@@ -313,6 +317,9 @@ A restart of the MvK is needed for Python to pick up the new functions.</p>
   <h4>Previous topic</h4>
   <p class="topless"><a href="problems.html"
                         title="previous chapter">Common problems and solutions</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="models.html"
+                        title="next chapter">Models</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -340,6 +347,9 @@ A restart of the MvK is needed for Python to pick up the new functions.</p>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
+        <li class="right" >
+          <a href="models.html" title="Models"
+             >next</a> |</li>
         <li class="right" >
           <a href="problems.html" title="Common problems and solutions"
              >previous</a> |</li>

+ 128 - 0
doc/_build/html/models.html

@@ -0,0 +1,128 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Models &#8212; Modelverse 0.4.0 documentation</title>
+    
+    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '0.4.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <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="prev" title="Internal workings" href="internal.html" /> 
+  </head>
+  <body role="document">
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</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>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="models">
+<h1>Models<a class="headerlink" href="#models" title="Permalink to this headline">¶</a></h1>
+<p>Practically every part of the Modelverse is modelled one way or the other.
+We briefly touch upon the different aspects and how they are modelled.</p>
+<div class="section" id="network-interface">
+<h2>Network interface<a class="headerlink" href="#network-interface" title="Permalink to this headline">¶</a></h2>
+<p>The network communication in the Modelverse builds on top of the raw socket implementation of Python.
+Whereas we use normal HTTP requests, we explicitly opted not to use these libraries.
+Many of these libraries hide important implementation details, such as how successive requests are handled (sequential, threaded, ...), whether or not to keep connections open and reuse them, which HTTP version to implement, and so on.
+As the HTTP protocol is a simple protocol, we reimplemented it completely in SCCD (StateCharts and Class Diagrams).</p>
+<p>There are two network components: a server in the MvS, and a server and client in the MvK.
+These are discussed next.</p>
+<div class="section" id="mvs-server">
+<h3>MvS server<a class="headerlink" href="#mvs-server" title="Permalink to this headline">¶</a></h3>
+<img alt="_images/mvs_server.svg" src="_images/mvs_server.svg" /></div>
+<div class="section" id="mvk-server">
+<h3>MvK server<a class="headerlink" href="#mvk-server" title="Permalink to this headline">¶</a></h3>
+<img alt="_images/mvk_server.svg" src="_images/mvk_server.svg" /></div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">Models</a><ul>
+<li><a class="reference internal" href="#network-interface">Network interface</a><ul>
+<li><a class="reference internal" href="#mvs-server">MvS server</a></li>
+<li><a class="reference internal" href="#mvk-server">MvK server</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="internal.html"
+                        title="previous chapter">Internal workings</a></p>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/models.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             >index</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>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2016, Yentl Van Tendeloo.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
+    </div>
+  </body>
+</html>

BIN
doc/_build/html/objects.inv


File diff suppressed because it is too large
+ 1 - 1
doc/_build/html/searchindex.js


File diff suppressed because it is too large
+ 5017 - 0
doc/img/mvk_server.svg


File diff suppressed because it is too large
+ 1719 - 0
doc/img/mvs_server.svg


+ 1 - 0
doc/index.rst

@@ -20,3 +20,4 @@ Contents:
    Advanced examples <advanced>
    Common problems and solutions <problems>
    Internal workings <internal>
+   Models <models>

+ 26 - 0
doc/models.rst

@@ -0,0 +1,26 @@
+Models
+======
+
+Practically every part of the Modelverse is modelled one way or the other.
+We briefly touch upon the different aspects and how they are modelled.
+
+Network interface
+-----------------
+
+The network communication in the Modelverse builds on top of the raw socket implementation of Python.
+Whereas we use normal HTTP requests, we explicitly opted not to use these libraries.
+Many of these libraries hide important implementation details, such as how successive requests are handled (sequential, threaded, ...), whether or not to keep connections open and reuse them, which HTTP version to implement, and so on.
+As the HTTP protocol is a simple protocol, we reimplemented it completely in SCCD (StateCharts and Class Diagrams).
+
+There are two network components: a server in the MvS, and a server and client in the MvK.
+These are discussed next.
+
+MvS server
+^^^^^^^^^^
+
+.. image:: img/mvs_server.svg
+
+MvK server
+^^^^^^^^^^
+
+.. image:: img/mvk_server.svg