177 lines
8.7 KiB
HTML
177 lines
8.7 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<title>optimizer_server module — PySecondo-API 1.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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
</head><body>
|
||
<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="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">PySecondo-API 1.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="module-optimizer_server">
|
||
<span id="optimizer-server-module"></span><h1>optimizer_server module<a class="headerlink" href="#module-optimizer_server" title="Permalink to this headline">¶</a></h1>
|
||
<p>The module optimizer_server implements the connection to Optimizer server.</p>
|
||
<dl class="class">
|
||
<dt id="optimizer_server.Optimizer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">optimizer_server.</code><code class="sig-name descname">Optimizer</code><span class="sig-paren">(</span><em class="sig-param">server</em>, <em class="sig-param">port</em><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This class contains attributes and methods for connecting to a running Optimizer server,
|
||
optimizing commands and queries, returning the result queries to be executed by Secondo.</p>
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.__init__">
|
||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">server</em>, <em class="sig-param">port</em><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.__init__" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The constructor of the calss Optimizer.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>server</strong> – The IP-address of Optimizer server.</p></li>
|
||
<li><p><strong>port</strong> – The port number of the socket.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>None.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.close">
|
||
<code class="sig-name descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.close" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method closes the connections to Optimizer server.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.connect">
|
||
<em class="property">async </em><code class="sig-name descname">connect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.connect" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method connects to Optimizer server using asyncio methods and sets the connection,
|
||
stream- reader and writer attributes of the Optimizer class.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.get_opt_conn">
|
||
<code class="sig-name descname">get_opt_conn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.get_opt_conn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method returns the connection attribute of Optimizer object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The connection attribute of Optimizer object.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.get_opt_initialized">
|
||
<code class="sig-name descname">get_opt_initialized</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.get_opt_initialized" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.get_opt_streams">
|
||
<code class="sig-name descname">get_opt_streams</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.get_opt_streams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method returns the stream reader/ writer attributes of Optimizer object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The stream reader/ writer attributes of Optimizer object.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.get_port">
|
||
<code class="sig-name descname">get_port</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.get_port" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method returns the port attributes of Optimizer object.
|
||
:return: The port attributes of Optimizer object, which consists of an integer number as port eg. 5678.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.get_server">
|
||
<code class="sig-name descname">get_server</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.get_server" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method returns the server attributes of Optimizer object.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The server attributes of Optimizer object, which consists of an IP-address eg. 127.0.0.0.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="optimizer_server.Optimizer.set_opt_initialized">
|
||
<code class="sig-name descname">set_opt_initialized</code><span class="sig-paren">(</span><em class="sig-param">val</em><span class="sig-paren">)</span><a class="headerlink" href="#optimizer_server.Optimizer.set_opt_initialized" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This method sets an attribute of Optimizer object that shows if the Optimizer is initialised and running.
|
||
:param initialized: A boolean value, when True means the Optimizer is initialised and running.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/optimizer_server.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</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="py-modindex.html" title="Python Module Index"
|
||
>modules</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="index.html">PySecondo-API 1.0 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, Mahsa Davari.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.0.
|
||
</div>
|
||
</body>
|
||
</html> |