Page History

<style type="text/css">
.highlight .hll { background-color: #ffffcc }
.highlight  { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #303030 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
</style>


<div class="section" id="understanding-the-client">
<span id="index-0"></span><span id="id1"></span>
<p>All communication with the <a class="reference internal" href="../wiki../display../ECFLOWglossary/Glossary#term#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a> is done with <a class="reference internal" href="../wiki../display../ECFLOWglossary/Glossary#term#term-ecflow-client"><em class="xref std std-term">ecflow_client</em></a></p>
<div class="line-block">
<div class="line">For any communication with the server, the client needs to know the machine</div>
<div class="line">where the server is running, and the port on the server. There can be multiple</div>
<div class="line">server&#8217;s running on the same machine, hence the port number is important.</div>
</div>
<p>This tutorial will show examples of using the client at the shell and in a python script.</p>
<div class="section" id="client-shell-interface">
<h2>Client Shell Interface<a class="headerlink" href="#client-shell-interface" title="Permalink to this headline">¶</a></h2>
<p>For a full list of available commands type:</p>
<div class="highlight-python"><pre>&gt; ecflow_client --help</pre>
</div>
<div class="line-block">
<div class="line">The <a class="reference internal" href="../wiki../display../ECFLOWglossary/Glossary#term#term-ecflow-client"><em class="xref std std-term">ecflow_client</em></a> uses the following method of determining the <strong>host</strong> and <strong>port</strong></div>
</div>
<ul>
<li><p class="first">Default host and port is <strong>localhost</strong>:<strong>3141</strong></p>
</li>
<li><p class="first">These defaults are overridden by ECF_NODE and ECF_PORT environment variables</p>
</li>
<li><div class="first line-block">
<div class="line">This can be further overridden by using &#8211;port and &#8211;host options</div>
<div class="line">and can be used for any of shell level command shown with &#8211;help option.</div>
<div class="line">For example to ping a server on the command line we can use:</div>
</div>
<div class="highlight-python"><pre>&gt; ecflow_client --ping --host=machineX --port=4141</pre>
</div>
</li>
</ul>
</div>
<div class="section" id="client-python-interface">
<h2>Client Python Interface<a class="headerlink" href="#client-python-interface" title="Permalink to this headline">¶</a></h2>
<div class="line-block">
<div class="line">The functionality provided by <a class="reference internal" href="../wiki../display../ECFLOWglossary/Glossary#term#term-ecflow-client"><em class="xref std std-term">ecflow_client</em></a> is also available via the <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a>.</div>
<div class="line">Please see <tt class="xref py py-class docutils literal"><span class="pre">ecflow.Client</span></tt>.</div>
</div>
<div class="line-block">
<div class="line">The python interface uses the same algorithm for determining the host and port,</div>
<div class="line">and allows the host and port to be set explicitly. See class <tt class="xref py py-class docutils literal"><span class="pre">ecflow.Client</span></tt></div>
<div class="line">This is shown by the following python example:</div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">ecflow</span>

<span class="n">ci</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Client</span><span class="p">()</span>
<span class="n">ci</span><span class="o">.</span><span class="n">set_host_port</span><span class="p">(</span><span class="s">&quot;oetzi&quot;</span><span class="p">,</span><span class="s">&quot;3444&quot;</span><span class="p">)</span>  <span class="c"># Explicitly set host and port</span>
<span class="k">try</span><span class="p">:</span>
   <span class="n">ci</span><span class="o">.</span><span class="n">ping</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
   <span class="k">print</span> <span class="s">&quot;failed: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">);</span>
</pre></div>
</div>
<p>What to do:</p>
<div class="line-block">
<div class="line">If your <a class="reference internal" href="../wiki../display../ECFLOWglossary/Glossary#term#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a> was started with <strong>ecf_start.sh</strong> and wish to use the shell</div>
<div class="line">interface, then set ECF_NODE and ECF_PORT environment variables</div>
</div>
</div>
</div>