mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
2188 lines
165 KiB
HTML
2188 lines
165 KiB
HTML
|
|
||
|
|
|
||
|
|
<!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>server Package — vCloud Suite SDK for Python 6.0.0 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: '',
|
||
|
|
VERSION: '6.0.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="vCloud Suite SDK for Python 6.0.0 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="vapi Package" href="vmware.vapi.html" />
|
||
|
|
<link rel="next" title="settings Package" href="vmware.vapi.settings.html" />
|
||
|
|
<link rel="prev" title="security Package" href="vmware.vapi.security.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<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="right" >
|
||
|
|
<a href="vmware.vapi.settings.html" title="settings Package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.security.html" title="security Package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="vmware.html" >vmware Package</a> »</li>
|
||
|
|
<li><a href="vmware.vapi.html" accesskey="U">vapi Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="server-package">
|
||
|
|
<h1>server Package<a class="headerlink" href="#server-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="id1">
|
||
|
|
<h2><tt class="xref py py-mod docutils literal"><span class="pre">server</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<span class="target" id="module-vmware.vapi.server"></span></div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.asyncore_http">
|
||
|
|
<span id="asyncore-http-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">asyncore_http</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.asyncore_http" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Asyncore http connection</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">AsyncChatWriteAdapter</tt><big>(</big><em>chat_obj</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncChatWriteAdapter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Async chat write adapter</p>
|
||
|
|
<p>Async chat write adapter init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>chat_obj</strong> (<tt class="xref py py-class docutils literal"><span class="pre">asynchat.async_chat</span></tt>) – async chat object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncChatWriteAdapter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter.flush">
|
||
|
|
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncChatWriteAdapter.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>buf</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncChatWriteAdapter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncChatWriteAdapter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>buf</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">AsyncoreHttpConnection</tt><big>(</big><em>server</em>, <em>sock_map</em>, <em>sock</em>, <em>from_addr</em>, <em>protocol_factory</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">asynchat.async_chat</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">BaseHTTPServer.BaseHTTPRequestHandler</span></tt></p>
|
||
|
|
<p>Async Http connection with async chat</p>
|
||
|
|
<p>Async Http connection with async chat</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>sock_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Global socket map</li>
|
||
|
|
<li><strong>sock</strong> (<tt class="xref py py-class docutils literal"><span class="pre">socket.socket</span></tt>) – http connection socket</li>
|
||
|
|
<li><strong>from_addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt>) – remote address bound to the socket</li>
|
||
|
|
<li><strong>protocol_factory</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpFactory" title="vmware.vapi.server.asyncore_http.HttpFactory"><tt class="xref py py-class docutils literal"><span class="pre">HttpFactory</span></tt></a>) – protocol factory</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.cleanup">
|
||
|
|
<tt class="descname">cleanup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.cleanup" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>connection cleanup</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.close_when_done">
|
||
|
|
<tt class="descname">close_when_done</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.close_when_done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.close_when_done" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>close the connection after all data written</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.do_POST">
|
||
|
|
<tt class="descname">do_POST</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.do_POST"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.do_POST" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handle HTTP Post</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.finish">
|
||
|
|
<tt class="descname">finish</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.finish" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>finish: Not used</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle">
|
||
|
|
<tt class="descname">handle</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.handle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle: Not used</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle_error">
|
||
|
|
<tt class="descname">handle_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle error callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle_expt">
|
||
|
|
<tt class="descname">handle_expt</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.handle_expt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle_expt" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle exception callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle_write">
|
||
|
|
<tt class="descname">handle_write</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.handle_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.handle_write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle write</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_body_begin">
|
||
|
|
<tt class="descname">http_body_begin</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.http_body_begin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_body_begin" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>request body begin</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_body_continue">
|
||
|
|
<tt class="descname">http_body_continue</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.http_body_continue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_body_continue" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>request body continue</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_body_end">
|
||
|
|
<tt class="descname">http_body_end</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.http_body_end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_body_end" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>request body ended</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_headers_end">
|
||
|
|
<tt class="descname">http_headers_end</tt><big>(</big><em>headers</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.http_headers_end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.http_headers_end" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>http headers end callback</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>headers</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – http headers string</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.log_message">
|
||
|
|
<tt class="descname">log_message</tt><big>(</big><em>format</em>, <em>*args</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.log_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.log_message" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Override the BaseHTTPServer.BaseHTTPRequestHandler method to send the
|
||
|
|
log message to the log file instead of stderr.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>:param format string
|
||
|
|
:type args: <tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt>
|
||
|
|
:param args: format argument(s)</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.protocol_version">
|
||
|
|
<tt class="descname">protocol_version</tt><em class="property"> = 'HTTP/1.1'</em><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.protocol_version" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.readable">
|
||
|
|
<tt class="descname">readable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.readable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.readable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Can read more data?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if this can handle more data</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.request_too_large">
|
||
|
|
<tt class="descname">request_too_large</tt><big>(</big><em>data_size</em>, <em>max_data_size</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.request_too_large"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.request_too_large" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Send request too large error</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>data_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – request data size</li>
|
||
|
|
<li><strong>max_data_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – max request data size allowed</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.send_error_">
|
||
|
|
<tt class="descname">send_error_</tt><big>(</big><em>response_code</em>, <em>response_txt</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.send_error_"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.send_error_" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Send http error</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>response_code</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – http response code</li>
|
||
|
|
<li><strong>response_txt</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – http response text</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.set_handlers">
|
||
|
|
<tt class="descname">set_handlers</tt><big>(</big><em>found_term_handler</em>, <em>terminator</em>, <em>collect_in_data_handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.set_handlers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.set_handlers" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>setup asynchat handlers</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>found_term_handler</strong> (<tt class="xref py py-class docutils literal"><span class="pre">function</span></tt>) – terminator found handler</li>
|
||
|
|
<li><strong>terminator</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – terminator string</li>
|
||
|
|
<li><strong>collect_in_data_handler</strong> (<tt class="xref py py-class docutils literal"><span class="pre">function</span></tt>) – collect incoming data handler</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup">
|
||
|
|
<tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>setup: Not used</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup_chunked_handler">
|
||
|
|
<tt class="descname">setup_chunked_handler</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.setup_chunked_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup_chunked_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>setup asynchat http chunked handlers</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup_http_headers_handler">
|
||
|
|
<tt class="descname">setup_http_headers_handler</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.setup_http_headers_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup_http_headers_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>setup asynchat http headers handlers</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup_message_handler">
|
||
|
|
<tt class="descname">setup_message_handler</tt><big>(</big><em>content_len</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.setup_message_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.setup_message_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>setup asynchat http message body handlers</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.writable">
|
||
|
|
<tt class="descname">writable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#AsyncoreHttpConnection.writable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection.writable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Have something to write to http connection?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if data is ready to write</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedHandler">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">ChunkedHandler</tt><big>(</big><em>channel</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedHandler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpBodyHandler" title="vmware.vapi.server.asyncore_http.HttpBodyHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.asyncore_http.HttpBodyHandler</span></tt></a></p>
|
||
|
|
<p>Async chat http chunked handler</p>
|
||
|
|
<p>Async chat http chunked handler init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>channel</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler" title="vmware.vapi.server.asyncore_http.HttpRequestHandler"><tt class="xref py py-class docutils literal"><span class="pre">HttpRequestHandler</span></tt></a>) – http request handler</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedHandler.chunked_data_collect_incoming_data">
|
||
|
|
<tt class="descname">chunked_data_collect_incoming_data</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedHandler.chunked_data_collect_incoming_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedHandler.chunked_data_collect_incoming_data" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>incoming data handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – incoming data</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedHandler.chunked_size_found_terminator">
|
||
|
|
<tt class="descname">chunked_size_found_terminator</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedHandler.chunked_size_found_terminator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedHandler.chunked_size_found_terminator" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Found chunked size handler</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedHandler.chunked_trailer_found_terminator">
|
||
|
|
<tt class="descname">chunked_trailer_found_terminator</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedHandler.chunked_trailer_found_terminator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedHandler.chunked_trailer_found_terminator" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Found chunked trailer terminator handler</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">ChunkedMessageBodyWriter</tt><big>(</big><em>wfile</em>, <em>chunk_size=4096</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedMessageBodyWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Chunked message writer</p>
|
||
|
|
<p>Chunked message writer init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>wfile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">file</span></tt>) – file object to write to</li>
|
||
|
|
<li><strong>chunk_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – max write chunk size</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedMessageBodyWriter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter.flush">
|
||
|
|
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedMessageBodyWriter.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>buf</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#ChunkedMessageBodyWriter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.ChunkedMessageBodyWriter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>buf</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DataHandler">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">DataHandler</tt><big>(</big><em>channel</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DataHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DataHandler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Async chat data handler</p>
|
||
|
|
<p>Async chat data handler init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>channel</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler" title="vmware.vapi.server.asyncore_http.HttpRequestHandler"><tt class="xref py py-class docutils literal"><span class="pre">HttpRequestHandler</span></tt></a>) – http request handler</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DataHandler.append_data_collect_incoming_data">
|
||
|
|
<tt class="descname">append_data_collect_incoming_data</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DataHandler.append_data_collect_incoming_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DataHandler.append_data_collect_incoming_data" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Generic incoming data handler: Append data to self.data</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – incoming data</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DataHandler.clear_data">
|
||
|
|
<tt class="descname">clear_data</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DataHandler.clear_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DataHandler.clear_data" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Clear self.data</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DataHandler.set_handlers">
|
||
|
|
<tt class="descname">set_handlers</tt><big>(</big><em>found_term_handler</em>, <em>terminator</em>, <em>collect_in_data_handler</em>, <em>max_data_size</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DataHandler.set_handlers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DataHandler.set_handlers" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Set asynchat handlers</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>found_term_handler</strong> (<tt class="xref py py-class docutils literal"><span class="pre">function</span></tt>) – terminator found handler</li>
|
||
|
|
<li><strong>terminator</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – terminator string</li>
|
||
|
|
<li><strong>collect_in_data_handler</strong> (<tt class="xref py py-class docutils literal"><span class="pre">function</span></tt>) – collect incoming data handler</li>
|
||
|
|
<li><strong>max_data_size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – max data size before abort</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DeflateWriter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">DeflateWriter</tt><big>(</big><em>wfile</em>, <em>compresslevel=5</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DeflateWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DeflateWriter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Deflate (zlib) writer</p>
|
||
|
|
<p>Deflate (zlib) writer init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wfile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">file</span></tt>) – file object to write to</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DeflateWriter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DeflateWriter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DeflateWriter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DeflateWriter.flush">
|
||
|
|
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DeflateWriter.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DeflateWriter.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.DeflateWriter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>buf</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#DeflateWriter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.DeflateWriter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>buf</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.GzipWriter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">GzipWriter</tt><big>(</big><em>wfile</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#GzipWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.GzipWriter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Gzip writer</p>
|
||
|
|
<p>Gzip writer init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wfile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">file</span></tt>) – file object to write to</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.GzipWriter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#GzipWriter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.GzipWriter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.GzipWriter.flush">
|
||
|
|
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#GzipWriter.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.GzipWriter.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.GzipWriter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>buf</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#GzipWriter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.GzipWriter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>buf</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">HeadOfLineWriter</tt><big>(</big><em>wfile</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Head of line writer</p>
|
||
|
|
<p>Head of line writer init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wfile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">file</span></tt>) – file object to write to</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer">
|
||
|
|
<em class="property">class </em><tt class="descname">Writer</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.Writer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Chile writer</p>
|
||
|
|
<p>Chile writer init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parent</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter" title="vmware.vapi.server.asyncore_http.HeadOfLineWriter"><tt class="xref py py-class docutils literal"><span class="pre">HeadOfLineWriter</span></tt></a>) – Parent writer</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.Writer.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.flush">
|
||
|
|
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.Writer.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.is_closed">
|
||
|
|
<tt class="descname">is_closed</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.Writer.is_closed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.is_closed" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>is writer closed</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if closed, False otherwise</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.Writer.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.close">
|
||
|
|
<tt class="descclassname">HeadOfLineWriter.</tt><tt class="descname">close</tt><big>(</big><em>writer</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Close a child writer</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>writer</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer" title="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer"><tt class="xref py py-class docutils literal"><span class="pre">Writer</span></tt></a>) – child writer</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.flush">
|
||
|
|
<tt class="descclassname">HeadOfLineWriter.</tt><tt class="descname">flush</tt><big>(</big><em>writer</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>flush a child writer (only possible for head of line writer)</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>writer</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer" title="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer"><tt class="xref py py-class docutils literal"><span class="pre">Writer</span></tt></a>) – child writer</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.flush_pending_reply">
|
||
|
|
<tt class="descclassname">HeadOfLineWriter.</tt><tt class="descname">flush_pending_reply</tt><big>(</big><em>writer</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.flush_pending_reply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.flush_pending_reply" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Flush pending reply</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>writer</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer" title="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer"><tt class="xref py py-class docutils literal"><span class="pre">Writer</span></tt></a>) – child writer</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.new_writer">
|
||
|
|
<tt class="descclassname">HeadOfLineWriter.</tt><tt class="descname">new_writer</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.new_writer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.new_writer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a new child writer</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer" title="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer"><tt class="xref py py-class docutils literal"><span class="pre">Writer</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A new writer</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HeadOfLineWriter.write">
|
||
|
|
<tt class="descclassname">HeadOfLineWriter.</tt><tt class="descname">write</tt><big>(</big><em>writer</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HeadOfLineWriter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Write to child writer</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>writer</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer" title="vmware.vapi.server.asyncore_http.HeadOfLineWriter.Writer"><tt class="xref py py-class docutils literal"><span class="pre">Writer</span></tt></a>) – child writer</li>
|
||
|
|
<li><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpBodyHandler">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">HttpBodyHandler</tt><big>(</big><em>channel</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpBodyHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpBodyHandler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.asyncore_http.DataHandler" title="vmware.vapi.server.asyncore_http.DataHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.asyncore_http.DataHandler</span></tt></a></p>
|
||
|
|
<p>Async chat http body handler</p>
|
||
|
|
<p>Async chat http body handler init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>channel</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler" title="vmware.vapi.server.asyncore_http.HttpRequestHandler"><tt class="xref py py-class docutils literal"><span class="pre">HttpRequestHandler</span></tt></a>) – http request handler</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpBodyHandler.http_body_collect_incoming_data">
|
||
|
|
<tt class="descname">http_body_collect_incoming_data</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpBodyHandler.http_body_collect_incoming_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpBodyHandler.http_body_collect_incoming_data" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>incoming data handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – incoming data</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpBodyHandler.http_body_found_terminator">
|
||
|
|
<tt class="descname">http_body_found_terminator</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpBodyHandler.http_body_found_terminator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpBodyHandler.http_body_found_terminator" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Found terminator handler</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">HttpFactory</tt><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Http factory</p>
|
||
|
|
<p>Http factory init</p>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory.HTTP_CONTENT_MAPPING">
|
||
|
|
<tt class="descname">HTTP_CONTENT_MAPPING</tt><em class="property"> = {'xml': 'text/xml', 'json': 'application/json'}</em><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory.HTTP_CONTENT_MAPPING" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory.abspath">
|
||
|
|
<em class="property">static </em><tt class="descname">abspath</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpFactory.abspath"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory.abspath" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get posix absolute path</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – url path</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">posix style abs path</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory.add_handler">
|
||
|
|
<tt class="descname">add_handler</tt><big>(</big><em>path</em>, <em>msg_type</em>, <em>protocol_handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpFactory.add_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory.add_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>add handler associated with url path and transport message</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>path</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – url path</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – message type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – async protocol handler</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory.get_handler">
|
||
|
|
<tt class="descname">get_handler</tt><big>(</big><em>path</em>, <em>content_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpFactory.get_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory.get_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>get handler for a particular url path and content type</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>path</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – url path</li>
|
||
|
|
<li><strong>content_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – http content-type</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">protocol handler</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory.get_path_handlers">
|
||
|
|
<tt class="descname">get_path_handlers</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpFactory.get_path_handlers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory.get_path_handlers" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>get handlers for a particular url path</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – url path</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt> of (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>, <a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a dict of content type to protocol handler mapping</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpFactory.handle_accept">
|
||
|
|
<tt class="descname">handle_accept</tt><big>(</big><em>server</em>, <em>sock_map</em>, <em>sock</em>, <em>from_addr</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpFactory.handle_accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpFactory.handle_accept" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle newly accepted socket connection</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>sock_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Global socket map</li>
|
||
|
|
<li><strong>sock</strong> (<tt class="xref py py-class docutils literal"><span class="pre">socket.socket</span></tt>) – accepted socket</li>
|
||
|
|
<li><strong>from_addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt>) – remote address bound to the socket</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpHeadersHandler">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">HttpHeadersHandler</tt><big>(</big><em>channel</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpHeadersHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpHeadersHandler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.asyncore_http.DataHandler" title="vmware.vapi.server.asyncore_http.DataHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.asyncore_http.DataHandler</span></tt></a></p>
|
||
|
|
<p>Async chat http header handler</p>
|
||
|
|
<p>Async chat http headers handler init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>channel</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler" title="vmware.vapi.server.asyncore_http.HttpRequestHandler"><tt class="xref py py-class docutils literal"><span class="pre">HttpRequestHandler</span></tt></a>) – http request handler</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpHeadersHandler.http_headers_found_terminator">
|
||
|
|
<tt class="descname">http_headers_found_terminator</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpHeadersHandler.http_headers_found_terminator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpHeadersHandler.http_headers_found_terminator" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Found terminator handler</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">HttpRequestHandler</tt><big>(</big><em>http_conn</em>, <em>wfile</em>, <em>content_type</em>, <em>protocol_handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Http request handler</p>
|
||
|
|
<p>Http request handler init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>http_conn</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.AsyncoreHttpConnection" title="vmware.vapi.server.asyncore_http.AsyncoreHttpConnection"><tt class="xref py py-class docutils literal"><span class="pre">AsyncoreHttpConnection</span></tt></a>) – http connection</li>
|
||
|
|
<li><strong>wfile</strong> (<tt class="xref py py-class docutils literal"><span class="pre">file</span></tt>) – file object to write to</li>
|
||
|
|
<li><strong>content_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – request content type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – async protocol handler</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.close_http_conn_when_done">
|
||
|
|
<tt class="descname">close_http_conn_when_done</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.close_http_conn_when_done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.close_http_conn_when_done" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>close the connection after all data written</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.request_continue">
|
||
|
|
<tt class="descname">request_continue</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.request_continue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.request_continue" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>request data continue</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – request data</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.request_end">
|
||
|
|
<tt class="descname">request_end</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.request_end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.request_end" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>request data ended</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.response_continue">
|
||
|
|
<tt class="descname">response_continue</tt><big>(</big><em>response</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.response_continue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.response_continue" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>response data continue</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>response</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – http response data</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.response_end">
|
||
|
|
<tt class="descname">response_end</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.response_end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.response_end" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>response data end</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.send_response_headers">
|
||
|
|
<tt class="descname">send_response_headers</tt><big>(</big><em>response_code</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.send_response_headers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.send_response_headers" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>send response headers</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>response_code</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – http response code</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.HttpRequestHandler.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#HttpRequestHandler.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.MessageHandler">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">MessageHandler</tt><big>(</big><em>channel</em>, <em>content_len=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#MessageHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.MessageHandler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpBodyHandler" title="vmware.vapi.server.asyncore_http.HttpBodyHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.asyncore_http.HttpBodyHandler</span></tt></a></p>
|
||
|
|
<p>Async chat http message handler</p>
|
||
|
|
<p>Async chat http message handler init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>channel</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_http.HttpRequestHandler" title="vmware.vapi.server.asyncore_http.HttpRequestHandler"><tt class="xref py py-class docutils literal"><span class="pre">HttpRequestHandler</span></tt></a>) – http request handler</li>
|
||
|
|
<li><strong>content_len</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt> or None) – http content length</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.MessageHandler.message_body_collect_incoming_data">
|
||
|
|
<tt class="descname">message_body_collect_incoming_data</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#MessageHandler.message_body_collect_incoming_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.MessageHandler.message_body_collect_incoming_data" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>incoming data handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – incoming data</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.MessageHandler.message_body_found_terminator">
|
||
|
|
<tt class="descname">message_body_found_terminator</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#MessageHandler.message_body_found_terminator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.MessageHandler.message_body_found_terminator" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Found http message terminator handler</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.find_token">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">find_token</tt><big>(</big><em>tokens</em>, <em>token_to_find</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#find_token"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.find_token" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Find token and token value from a comma separated tokens</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>tokens</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – comma separated tokens string</li>
|
||
|
|
<li><strong>token_to_find</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – a string to find in the tokens</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> if token is found, None otherwise
|
||
|
|
:return: tuple of (token_to_find, value)</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_http.log_exception">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.asyncore_http.</tt><tt class="descname">log_exception</tt><big>(</big><em>msg</em>, <em>err</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_http.html#log_exception"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_http.log_exception" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handy function to log exception with stack trace</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>msg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – error message</li>
|
||
|
|
<li><strong>err</strong> (<tt class="xref py py-class docutils literal"><span class="pre">Exception</span></tt>) – exception to log</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.asyncore_server">
|
||
|
|
<span id="asyncore-server-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">asyncore_server</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.asyncore_server" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Asyncore server</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_server.</tt><tt class="descname">AsyncoreLoopController</tt><big>(</big><em>sock_map</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">asyncore.dispatcher</span></tt></p>
|
||
|
|
<p>Asyncore loop controller</p>
|
||
|
|
<p>Asyncore loop controller init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sock_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Global socket map</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_close">
|
||
|
|
<tt class="descname">handle_close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.handle_close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle close callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_error">
|
||
|
|
<tt class="descname">handle_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle error callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_expt">
|
||
|
|
<tt class="descname">handle_expt</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.handle_expt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_expt" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle exception callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_read">
|
||
|
|
<tt class="descname">handle_read</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.handle_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.handle_read" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>read data available callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.intr">
|
||
|
|
<tt class="descname">intr</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.intr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.intr" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Interrupt the asyncore loop</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.readable">
|
||
|
|
<tt class="descname">readable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.readable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.readable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Can accept more data?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if this can handle more data</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreLoopController.writable">
|
||
|
|
<tt class="descname">writable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreLoopController.writable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController.writable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Have something to write to this connection?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if data is ready to write</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_server.</tt><tt class="descname">AsyncoreSslConnection</tt><big>(</big><em>server</em>, <em>sock_map</em>, <em>sock</em>, <em>from_addr</em>, <em>protocol_factory</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">asyncore.dispatcher</span></tt></p>
|
||
|
|
<p>Asyncore ssl connection</p>
|
||
|
|
<p>Asyncore ssl connection init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>sock_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Global socket map</li>
|
||
|
|
<li><strong>sock</strong> (<tt class="xref py py-class docutils literal"><span class="pre">socket.socket</span></tt>) – connection socket</li>
|
||
|
|
<li><strong>from_addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt>) – remote address bound to the socket</li>
|
||
|
|
<li><strong>protocol_factory</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt> with method handle_accept) – protocol factory</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.cleanup">
|
||
|
|
<tt class="descname">cleanup</tt><big>(</big><em>close_socket=False</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.cleanup" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>connection cleanup</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>close_socket</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – close internal socket (or not)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.do_handshake_continue">
|
||
|
|
<tt class="descname">do_handshake_continue</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.do_handshake_continue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.do_handshake_continue" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>ssl do handshake continue</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_close">
|
||
|
|
<tt class="descname">handle_close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.handle_close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle close callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_error">
|
||
|
|
<tt class="descname">handle_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle error callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_expt">
|
||
|
|
<tt class="descname">handle_expt</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.handle_expt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_expt" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle exception callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_read">
|
||
|
|
<tt class="descname">handle_read</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.handle_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_read" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>read data available callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_write">
|
||
|
|
<tt class="descname">handle_write</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.handle_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.handle_write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>write ready callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.readable">
|
||
|
|
<tt class="descname">readable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.readable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.readable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Can read more data?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if this can handle more data</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreSslConnection.writable">
|
||
|
|
<tt class="descname">writable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreSslConnection.writable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreSslConnection.writable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Have something to write to ssl connection?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if data is ready to write</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_server.</tt><tt class="descname">AsyncoreTcpListener</tt><big>(</big><em>loop_controller</em>, <em>sock_map</em>, <em>addr</em>, <em>ssl_args</em>, <em>protocol_factory</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">asyncore.dispatcher</span></tt></p>
|
||
|
|
<p>Asyncore tcp listener</p>
|
||
|
|
<p>Asyncore tcp listener init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>loop_controller</strong> (<a class="reference internal" href="#vmware.vapi.server.asyncore_server.AsyncoreLoopController" title="vmware.vapi.server.asyncore_server.AsyncoreLoopController"><tt class="xref py py-class docutils literal"><span class="pre">AsyncoreLoopController</span></tt></a>) – loop controller</li>
|
||
|
|
<li><strong>sock_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Global socket map</li>
|
||
|
|
<li><strong>addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – tcp addr and port</li>
|
||
|
|
<li><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</li>
|
||
|
|
<li><strong>protocol_factory</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt> with method handle_accept) – protocol factory</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_accept">
|
||
|
|
<tt class="descname">handle_accept</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener.handle_accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_accept" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>accept connection callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_close">
|
||
|
|
<tt class="descname">handle_close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener.handle_close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle close callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_error">
|
||
|
|
<tt class="descname">handle_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle error callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_expt">
|
||
|
|
<tt class="descname">handle_expt</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener.handle_expt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener.handle_expt" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>handle exception callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener.init_ssl">
|
||
|
|
<tt class="descname">init_ssl</tt><big>(</big><em>ssl_args</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener.init_ssl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener.init_ssl" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Setup SSL arguments</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpListener.writable">
|
||
|
|
<tt class="descname">writable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpListener.writable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpListener.writable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Have something to write to this connection?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if data is ready to write</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpServer">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_server.</tt><tt class="descname">AsyncoreTcpServer</tt><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpServer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></p>
|
||
|
|
<p>Asyncore tcp server</p>
|
||
|
|
<p>Asyncore tcp server init</p>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpServer.SUPPORTED_SCHEMES">
|
||
|
|
<tt class="descname">SUPPORTED_SCHEMES</tt><em class="property"> = ('http', 'https')</em><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpServer.SUPPORTED_SCHEMES" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpServer.register_handler">
|
||
|
|
<tt class="descname">register_handler</tt><big>(</big><em>addr</em>, <em>msg_type</em>, <em>protocol_handler</em>, <em>ssl_args=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpServer.register_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpServer.register_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Register protocol handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – addr url</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – protocol message type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this addr</li>
|
||
|
|
<li><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpServer.serve_forever">
|
||
|
|
<tt class="descname">serve_forever</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpServer.serve_forever"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpServer.serve_forever" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server loop</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.AsyncoreTcpServer.shutdown">
|
||
|
|
<tt class="descname">shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#AsyncoreTcpServer.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.AsyncoreTcpServer.shutdown" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server shutdown</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.asyncore_server.</tt><tt class="descname">SyncWriteToAsyncWriteAdapter</tt><big>(</big><em>async_socket</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Sync write to async write adapter</p>
|
||
|
|
<p>Sync write to async write adapter init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>async_socket</strong> (<tt class="xref py py-class docutils literal"><span class="pre">socket.socket</span></tt>) – async socket</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.close_when_done">
|
||
|
|
<tt class="descname">close_when_done</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.close_when_done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.close_when_done" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>close when all data written</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.flush">
|
||
|
|
<tt class="descname">flush</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.flush" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.tcp_cork">
|
||
|
|
<tt class="descname">tcp_cork</tt><big>(</big><em>enable</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.tcp_cork"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.tcp_cork" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>tcp cork</p>
|
||
|
|
<p>Python failed to merge small send into big packet, which is
|
||
|
|
very inefficient. Use TCP_CORK to queue partial packets to bigger
|
||
|
|
packet before sending it. Alternatively we should use writev, but
|
||
|
|
it is not available on standard python socket lib.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>enable</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – 1 => turn TCP_CORK on, 0 => off</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">socket.error</span></tt> if TCP_CORK is not supported on this socket</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.writable">
|
||
|
|
<tt class="descname">writable</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.writable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.writable" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Have something to write to http connection?</p>
|
||
|
|
<p>:rtype <tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>
|
||
|
|
:return True if data is ready to write</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Write the given bytes</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bytes</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.write_ready">
|
||
|
|
<tt class="descname">write_ready</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#SyncWriteToAsyncWriteAdapter.write_ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.SyncWriteToAsyncWriteAdapter.write_ready" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>write ready callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.asyncore_server.get_server">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.asyncore_server.</tt><tt class="descname">get_server</tt><big>(</big><em>cfg</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/asyncore_server.html#get_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.asyncore_server.get_server" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get asyncore server</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cfg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">ConfigParser.SafeConfigParser</span></tt>) – Config parser</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">subclass of ServerInterface</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.server_interface">
|
||
|
|
<span id="server-interface-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">server_interface</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.server_interface" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Server interface</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.server_interface.ServerInterface">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.server_interface.</tt><tt class="descname">ServerInterface</tt><a class="reference internal" href="_modules/vmware/vapi/server/server_interface.html#ServerInterface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.server_interface.ServerInterface" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Server interface</p>
|
||
|
|
<p>Server interface init</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.server_interface.ServerInterface.register_handler">
|
||
|
|
<tt class="descname">register_handler</tt><big>(</big><em>addr</em>, <em>msg_type</em>, <em>protocol_handler</em>, <em>ssl_args=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/server_interface.html#ServerInterface.register_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.server_interface.ServerInterface.register_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Register protocol handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – addr url</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – protocol message type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this addr</li>
|
||
|
|
<li><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.server_interface.ServerInterface.serve_forever">
|
||
|
|
<tt class="descname">serve_forever</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/server_interface.html#ServerInterface.serve_forever"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.server_interface.ServerInterface.serve_forever" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server loop</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.server_interface.ServerInterface.shutdown">
|
||
|
|
<tt class="descname">shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/server_interface.html#ServerInterface.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.server_interface.ServerInterface.shutdown" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server shutdown</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.stdio_server">
|
||
|
|
<span id="stdio-server-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">stdio_server</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.stdio_server" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>STDIO server : This handles all protocol requests over stdin/out</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.stdio_server.StdioServer">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.stdio_server.</tt><tt class="descname">StdioServer</tt><a class="reference internal" href="_modules/vmware/vapi/server/stdio_server.html#StdioServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.stdio_server.StdioServer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></p>
|
||
|
|
<p>stdio server</p>
|
||
|
|
<p>Initialize the Stdio Server instance</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.stdio_server.StdioServer.register_handler">
|
||
|
|
<tt class="descname">register_handler</tt><big>(</big><em>addr</em>, <em>msg_type</em>, <em>protocol_handler</em>, <em>ssl_args=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/stdio_server.html#StdioServer.register_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.stdio_server.StdioServer.register_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the struct definition corresponding to the method’s input
|
||
|
|
parameters. The field names in the struct definition are the parameter
|
||
|
|
names and the field values correspond to the data definition of the
|
||
|
|
respective fields.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Url of the provider</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Message Type of the provider</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.html#vmware.vapi.protocol.server.api_handler.ApiHandler" title="vmware.vapi.protocol.server.api_handler.ApiHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.api_handler.ApiHandler</span></tt></a>) – The handler for the message protocol</li>
|
||
|
|
<li><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Any ssl related arguments</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.stdio_server.StdioServer.serve_forever">
|
||
|
|
<tt class="descname">serve_forever</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/stdio_server.html#StdioServer.serve_forever"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.stdio_server.StdioServer.serve_forever" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Receives the input from the std in of the process.
|
||
|
|
Processes the message, handles it via the protocol_handler and then
|
||
|
|
sends the response back.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.stdio_server.StdioServer.shutdown">
|
||
|
|
<tt class="descname">shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/stdio_server.html#StdioServer.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.stdio_server.StdioServer.shutdown" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.stdio_server.get_server">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.stdio_server.</tt><tt class="descname">get_server</tt><big>(</big><em>cfg</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/stdio_server.html#get_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.stdio_server.get_server" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>get stdio server</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cfg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">ConfigParser.SafeConfigParser</span></tt>) – Config parser</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">subclass of ServerInterface</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.twisted_server">
|
||
|
|
<span id="twisted-server-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">twisted_server</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.twisted_server" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Twisted server</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedAsyncProtocolHandlerAdapter</tt><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedAsyncProtocolHandlerAdapter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">twisted.internet.protocol.Protocol</span></tt></p>
|
||
|
|
<p>Twisted async protocol handler adapter</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter.connectionLost">
|
||
|
|
<tt class="descname">connectionLost</tt><big>(</big><em>reason</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedAsyncProtocolHandlerAdapter.connectionLost"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter.connectionLost" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Twisted connection lost</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>reason</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Connection lost reason</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter.connectionMade">
|
||
|
|
<tt class="descname">connectionMade</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedAsyncProtocolHandlerAdapter.connectionMade"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter.connectionMade" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>connection established callback</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter.dataReceived">
|
||
|
|
<tt class="descname">dataReceived</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedAsyncProtocolHandlerAdapter.dataReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter.dataReceived" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>data received</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedConnectionAdapter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedConnectionAdapter</tt><big>(</big><em>transport</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedConnectionAdapter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedConnectionAdapter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Twisted connection adapter</p>
|
||
|
|
<p>Twisted connection adapter init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>transport</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.internet.interfaces.ITransport</span></tt>) – Twisted transport</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedConnectionAdapter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedConnectionAdapter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedConnectionAdapter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedConnectionAdapter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedConnectionAdapter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedConnectionAdapter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedHttpConnectionAdapter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedHttpConnectionAdapter</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedHttpConnectionAdapter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedHttpConnectionAdapter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Twisted http connection adapter</p>
|
||
|
|
<p>Twisted http connection init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.web.http.Request</span></tt>) – Twisted http request object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedHttpConnectionAdapter.close">
|
||
|
|
<tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedHttpConnectionAdapter.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedHttpConnectionAdapter.close" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedHttpConnectionAdapter.write">
|
||
|
|
<tt class="descname">write</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedHttpConnectionAdapter.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedHttpConnectionAdapter.write" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – data to write</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedHttpSite">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedHttpSite</tt><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedHttpSite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedHttpSite" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">twisted.web.server.Site</span></tt></p>
|
||
|
|
<p>Twisted http site</p>
|
||
|
|
<p>Http site site init</p>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedHttpSite.HTTP_CONTENT_MAPPING">
|
||
|
|
<tt class="descname">HTTP_CONTENT_MAPPING</tt><em class="property"> = {'xml': 'text/xml', '': '', 'json': 'application/json'}</em><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedHttpSite.HTTP_CONTENT_MAPPING" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedHttpSite.add_res_handler">
|
||
|
|
<tt class="descname">add_res_handler</tt><big>(</big><em>path</em>, <em>msg_type</em>, <em>protocol_handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedHttpSite.add_res_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedHttpSite.add_res_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Add resource handler for a path</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>path</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – url path</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – transport msg type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this path</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if added. False otherwise</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedServer">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedServer</tt><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedServer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></p>
|
||
|
|
<p>Twisted server</p>
|
||
|
|
<p>Twisted server init</p>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedServer.SUPPORTED_SCHEMES">
|
||
|
|
<tt class="descname">SUPPORTED_SCHEMES</tt><em class="property"> = ('vmware', 'vmwares', 'http', 'https')</em><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedServer.SUPPORTED_SCHEMES" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedServer.get_ssl_context">
|
||
|
|
<tt class="descname">get_ssl_context</tt><big>(</big><em>ssl_args</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedServer.get_ssl_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedServer.get_ssl_context" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>get ssl context</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">twisted.internet.ssl.DefaultOpenSSLContextFactory</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">twisted ssl context factory instance</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedServer.register_handler">
|
||
|
|
<tt class="descname">register_handler</tt><big>(</big><em>addr</em>, <em>msg_type</em>, <em>protocol_handler</em>, <em>ssl_args=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedServer.register_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedServer.register_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Register protocol handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – addr url</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – protocol message type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this addr</li>
|
||
|
|
<li><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedServer.serve_forever">
|
||
|
|
<tt class="descname">serve_forever</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedServer.serve_forever"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedServer.serve_forever" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server loop</p>
|
||
|
|
<p>Note: Twisted limitation: Must be running from main thread</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedServer.shutdown">
|
||
|
|
<tt class="descname">shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedServer.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedServer.shutdown" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Server shutdown</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedVapiResource</tt><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">twisted.web.resource.Resource</span></tt></p>
|
||
|
|
<p>Twisted vapi resource</p>
|
||
|
|
<p>Twisted vapi resource init</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource.add_handler">
|
||
|
|
<tt class="descname">add_handler</tt><big>(</big><em>content_type</em>, <em>protocol_handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource.add_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource.add_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>add content handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>content_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – MIME content type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this path</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource.handle_error">
|
||
|
|
<tt class="descname">handle_error</tt><big>(</big><em>failure</em>, <em>request</em>, <em>response_code</em>, <em>text_msg</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource.handle_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource.handle_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handle error</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>failure</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.python.failure.Failure</span></tt>) – Twisted failure instance</li>
|
||
|
|
<li><strong>request</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.web.http.Request</span></tt>) – Twisted http request object</li>
|
||
|
|
<li><strong>response_code</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Http response code</li>
|
||
|
|
<li><strong>text_msg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Http error code</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource.handle_read">
|
||
|
|
<tt class="descname">handle_read</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource.handle_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource.handle_read" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handle read</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.web.http.Request</span></tt>) – Twisted http request object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource.handle_request">
|
||
|
|
<tt class="descname">handle_request</tt><big>(</big><em>request_msg</em>, <em>request</em>, <em>handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource.handle_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource.handle_request" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handle request</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>request_msg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Request msg</li>
|
||
|
|
<li><strong>request</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.web.http.Request</span></tt>) – Twisted http request object</li>
|
||
|
|
<li><strong>handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this addr</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource.render_GET">
|
||
|
|
<tt class="descname">render_GET</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource.render_GET"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource.render_GET" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handle HTTP GET</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.web.http.Request</span></tt>) – Twisted http request object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVapiResource.render_POST">
|
||
|
|
<tt class="descname">render_POST</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVapiResource.render_POST"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVapiResource.render_POST" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Handle POST</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> (<tt class="xref py py-class docutils literal"><span class="pre">twisted.web.http.Request</span></tt>) – Twisted http request object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVmwareProtocolFactory">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">TwistedVmwareProtocolFactory</tt><big>(</big><em>protocol_handler</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#TwistedVmwareProtocolFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVmwareProtocolFactory" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">twisted.internet.protocol.Factory</span></tt></p>
|
||
|
|
<p>Twisted vmacre protocol factory</p>
|
||
|
|
<p>Twisted vmacre protocol factory init</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this addr</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.TwistedVmwareProtocolFactory.protocol">
|
||
|
|
<tt class="descname">protocol</tt><a class="headerlink" href="#vmware.vapi.server.twisted_server.TwistedVmwareProtocolFactory.protocol" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>alias of <a class="reference internal" href="#vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter" title="vmware.vapi.server.twisted_server.TwistedAsyncProtocolHandlerAdapter"><tt class="xref py py-class docutils literal"><span class="pre">TwistedAsyncProtocolHandlerAdapter</span></tt></a></p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.twisted_server.get_server">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.twisted_server.</tt><tt class="descname">get_server</tt><big>(</big><em>cfg</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/twisted_server.html#get_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.twisted_server.get_server" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get twisted server</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cfg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">ConfigParser.SafeConfigParser</span></tt>) – Config parser</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">subclass of ServerInterface</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.vapid">
|
||
|
|
<span id="vapid-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">vapid</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.vapid" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Vapi server</p>
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.check_file_exists">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">check_file_exists</tt><big>(</big><em>filename</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#check_file_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.check_file_exists" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Check if name is a file and exists</p>
|
||
|
|
<p>:type <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>
|
||
|
|
:param file name</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.configure_logging">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">configure_logging</tt><big>(</big><em>log_config=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#configure_logging"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.configure_logging" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Configure logging using properties file</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>log_config</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – File path of the properties file</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.create_servers">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">create_servers</tt><big>(</big><em>spec</em>, <em>singleton=True</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#create_servers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.create_servers" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create RPC servers</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>spec</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Protocol configurations</li>
|
||
|
|
<li><strong>singleton</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Specify whether to create new instances of Providers or
|
||
|
|
use existing ones</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of servers</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.get_ssl_args">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">get_ssl_args</tt><big>(</big><em>cfg</em>, <em>protocol_prefix</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#get_ssl_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.get_ssl_args" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Extract the ssl arguments</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>cfg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">configparser.SafeConfigParser</span></tt>) – Configuration</li>
|
||
|
|
<li><strong>protocol_prefix</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Prefix of the protocol configuration</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">SSL arguments for this protocol configuration</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.main">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">main</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.main" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.set_process_title">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">set_process_title</tt><big>(</big><em>cfg</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#set_process_title"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.set_process_title" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>If setproctitle library is available, set the process title
|
||
|
|
:type cfg: <tt class="xref py py-class docutils literal"><span class="pre">configparser</span></tt>
|
||
|
|
:param cfg: configparser object</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.setup_provider_chain">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">setup_provider_chain</tt><big>(</big><em>cfg</em>, <em>singleton</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#setup_provider_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.setup_provider_chain" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Setup the API Provider chain</p>
|
||
|
|
<p>In the properties file, users would specify the order of ApiProviders
|
||
|
|
For ex: InterposerProvider, ApiAggregator. In this case all incoming
|
||
|
|
requests would first go to InterposerProvider and then forwarded to
|
||
|
|
ApiAggregator after processing.</p>
|
||
|
|
<p>This function initializes all these providers in the reverse order
|
||
|
|
and passes the reference of n+1th provider to nth provider.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
|
|
<li><strong>cfg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">configparser.SafeConfigParser</span></tt>) – Configuration</li>
|
||
|
|
<li><strong>singleton</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Specify whether to create new instances of Providers or
|
||
|
|
use existing ones</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiProvider" title="vmware.vapi.core.ApiProvider"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.ApiProvider</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of API Providers</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.vapid.shutdown_servers">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.vapid.</tt><tt class="descname">shutdown_servers</tt><big>(</big><em>servers</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/vapid.html#shutdown_servers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.vapid.shutdown_servers" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Shutdown all servers</p>
|
||
|
|
<p>:type <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of servers
|
||
|
|
:param List of servers to shutdown</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="windows-vapid-module">
|
||
|
|
<h2><tt class="xref py py-mod docutils literal"><span class="pre">windows_vapid</span></tt> Module<a class="headerlink" href="#windows-vapid-module" title="Permalink to this headline">¶</a></h2>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.server.wsgi_server">
|
||
|
|
<span id="wsgi-server-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">wsgi_server</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.server.wsgi_server" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Wsgi Server</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiApplication">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.wsgi_server.</tt><tt class="descname">WsgiApplication</tt><big>(</big><em>msg_handler_map</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#WsgiApplication"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiApplication" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
<p>Python WSGI application. For more details about WSGI
|
||
|
|
specification, see PEP 333.</p>
|
||
|
|
<p>Initialize WsgiApplication</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg_handler_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and
|
||
|
|
<a class="reference internal" href="vmware.vapi.protocol.server.html#vmware.vapi.protocol.server.api_handler.ApiHandler" title="vmware.vapi.protocol.server.api_handler.ApiHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.api_handler.ApiHandler</span></tt></a>) – Map of content type to the message
|
||
|
|
handler for that content type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.server.wsgi_server.</tt><tt class="descname">WsgiServer</tt><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#WsgiServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></p>
|
||
|
|
<p>Server wrapper class for Wsgi application.</p>
|
||
|
|
<p>Initialize WsgiServer</p>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer.HTTP_CONTENT_MAPPING">
|
||
|
|
<tt class="descname">HTTP_CONTENT_MAPPING</tt><em class="property"> = {'xml': 'text/xml', '': '', 'json': 'application/json'}</em><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer.HTTP_CONTENT_MAPPING" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer.SUPPORTED_SCHEMES">
|
||
|
|
<tt class="descname">SUPPORTED_SCHEMES</tt><em class="property"> = ('http', 'https')</em><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer.SUPPORTED_SCHEMES" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer.get_wsgi_application">
|
||
|
|
<tt class="descname">get_wsgi_application</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#WsgiServer.get_wsgi_application"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer.get_wsgi_application" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the WSGI application.</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.server.wsgi_server.WsgiApplication" title="vmware.vapi.server.wsgi_server.WsgiApplication"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.wsgi_server.WsgiApplication</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">WSGI application.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer.register_handler">
|
||
|
|
<tt class="descname">register_handler</tt><big>(</big><em>addr</em>, <em>msg_type</em>, <em>protocol_handler</em>, <em>ssl_args=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#WsgiServer.register_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer.register_handler" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Register protocol handler</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
|
|
<li><strong>addr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – addr url</li>
|
||
|
|
<li><strong>msg_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – protocol message type</li>
|
||
|
|
<li><strong>protocol_handler</strong> (<a class="reference internal" href="vmware.vapi.protocol.server.transport.html#vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler" title="vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.server.transport.async_protocol_handler.AsyncProtocolHandler</span></tt></a>) – protocol handler for this addr</li>
|
||
|
|
<li><strong>ssl_args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – ssl arguments</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer.serve_forever">
|
||
|
|
<tt class="descname">serve_forever</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#WsgiServer.serve_forever"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer.serve_forever" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.WsgiServer.shutdown">
|
||
|
|
<tt class="descname">shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#WsgiServer.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.WsgiServer.shutdown" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.server.wsgi_server.get_server">
|
||
|
|
<tt class="descclassname">vmware.vapi.server.wsgi_server.</tt><tt class="descname">get_server</tt><big>(</big><em>cfg</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/server/wsgi_server.html#get_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.server.wsgi_server.get_server" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Get wsgi server</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cfg</strong> (<tt class="xref py py-class docutils literal"><span class="pre">ConfigParser.SafeConfigParser</span></tt>) – Config parser</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.server.server_interface.ServerInterface" title="vmware.vapi.server.server_interface.ServerInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.server.server_interface.ServerInterface</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">subclass of ServerInterface</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">server Package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">server</span></tt> Package</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.asyncore_http"><tt class="docutils literal"><span class="pre">asyncore_http</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.asyncore_server"><tt class="docutils literal"><span class="pre">asyncore_server</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.server_interface"><tt class="docutils literal"><span class="pre">server_interface</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.stdio_server"><tt class="docutils literal"><span class="pre">stdio_server</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.twisted_server"><tt class="docutils literal"><span class="pre">twisted_server</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.vapid"><tt class="docutils literal"><span class="pre">vapid</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#windows-vapid-module"><tt class="docutils literal"><span class="pre">windows_vapid</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.server.wsgi_server"><tt class="docutils literal"><span class="pre">wsgi_server</span></tt> Module</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.vapi.security.html"
|
||
|
|
title="previous chapter">security Package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.vapi.settings.html"
|
||
|
|
title="next chapter">settings Package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/vmware.vapi.server.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<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="right" >
|
||
|
|
<a href="vmware.vapi.settings.html" title="settings Package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.security.html" title="security Package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="vmware.html" >vmware Package</a> »</li>
|
||
|
|
<li><a href="vmware.vapi.html" >vapi Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014, VMware, Inc..
|
||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|