Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-20 14:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.server.webserver.html

332 lines
24 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-07-14 00:21:00 +02:00
<!DOCTYPE html>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<html>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<head>
<meta charset="utf-8" />
Updated HTML docs
2021-05-16 00:06:01 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
Updated HTML docs
2020-07-14 00:21:00 +02:00
<title>evennia.server.webserver &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
Updated HTML docs
2021-10-26 21:41:11 +02:00
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.webserver</a></li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</ul>
Updated HTML docs
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
Updated HTML docs
2021-05-16 00:06:01 +02:00
<section id="module-evennia.server.webserver">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<span id="evennia-server-webserver"></span><h1>evennia.server.webserver<a class="headerlink" href="#module-evennia.server.webserver" title="Permalink to this headline"></a></h1>
<p>This implements resources for Twisted webservers using the WSGI
interface of Django. This alleviates the need of running e.g. an
Apache server to serve Evennia’s web presence (although you could do
that too if desired).</p>
<p>The actual servers are started inside server.py as part of the Evennia
application.</p>
<p>(Lots of thanks to <a class="reference external" href="http://github.com/clemesha/twisted-wsgi-django">http://github.com/clemesha/twisted-wsgi-django</a> for
a great example/aid on how to do this.)</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.LockableThreadPool">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">LockableThreadPool</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#LockableThreadPool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.LockableThreadPool" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.python.threadpool.ThreadPool</span></code></p>
<p>Threadpool that can be locked from accepting new requests.</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.LockableThreadPool.__init__">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#LockableThreadPool.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.LockableThreadPool.__init__" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Create a new threadpool.</p>
<p>&#64;param minthreads: minimum number of threads in the pool
&#64;type minthreads: L{int}</p>
<p>&#64;param maxthreads: maximum number of threads in the pool
&#64;type maxthreads: L{int}</p>
<p>&#64;param name: The name to give this threadpool; visible in log messages.
&#64;type name: native L{str}</p>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.LockableThreadPool.lock">
<code class="sig-name descname">lock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#LockableThreadPool.lock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.LockableThreadPool.lock" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.LockableThreadPool.callInThread">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">callInThread</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">func</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#LockableThreadPool.callInThread"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.LockableThreadPool.callInThread" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>called in the main reactor thread. Makes sure the pool
is not locked before continuing.</p>
</dd></dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.HTTPChannelWithXForwardedFor">
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">HTTPChannelWithXForwardedFor</code><a class="reference internal" href="../_modules/evennia/server/webserver.html#HTTPChannelWithXForwardedFor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.HTTPChannelWithXForwardedFor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.web.http.HTTPChannel</span></code></p>
<p>HTTP xforward class</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.HTTPChannelWithXForwardedFor.allHeadersReceived">
<code class="sig-name descname">allHeadersReceived</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#HTTPChannelWithXForwardedFor.allHeadersReceived"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.HTTPChannelWithXForwardedFor.allHeadersReceived" title="Permalink to this definition"></a></dt>
<dd><p>Check to see if this is a reverse proxied connection.</p>
</dd></dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.EvenniaReverseProxyResource">
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">EvenniaReverseProxyResource</code><span class="sig-paren">(</span><em class="sig-param">host</em>, <em class="sig-param">port</em>, <em class="sig-param">path</em>, <em class="sig-param">reactor=&lt;twisted.internet.epollreactor.EPollReactor object&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#EvenniaReverseProxyResource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.EvenniaReverseProxyResource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.web.proxy.ReverseProxyResource</span></code></p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.EvenniaReverseProxyResource.getChild">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">getChild</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#EvenniaReverseProxyResource.getChild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.EvenniaReverseProxyResource.getChild" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Create and return a proxy resource with the same proxy configuration
as this one, except that its path also contains the segment given by
path at the end.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<em>str</em>) – Url path.</p></li>
<li><p><strong>request</strong> (<em>Request object</em>) – Incoming request.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>resource (EvenniaReverseProxyResource)</em> – A proxy resource.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.EvenniaReverseProxyResource.render">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">render</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#EvenniaReverseProxyResource.render"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.EvenniaReverseProxyResource.render" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Render a request by forwarding it to the proxied server.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>request</strong> (<em>Request</em>) – Incoming request.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><em>not_done (char)</em> – Indicator to note request not yet finished.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.DjangoWebRoot">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">DjangoWebRoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pool</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#DjangoWebRoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.DjangoWebRoot" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.web.resource.Resource</span></code></p>
<p>This creates a web root (/) that Django
understands by tweaking the way
child instances are recognized.</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.DjangoWebRoot.__init__">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pool</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#DjangoWebRoot.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.DjangoWebRoot.__init__" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Setup the django+twisted resource.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>pool</strong> (<em>ThreadPool</em>) – The twisted threadpool.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.DjangoWebRoot.empty_threadpool">
<code class="sig-name descname">empty_threadpool</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#DjangoWebRoot.empty_threadpool"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.DjangoWebRoot.empty_threadpool" title="Permalink to this definition"></a></dt>
<dd><p>Converts our _pending_requests list of deferreds into a DeferredList</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>deflist (DeferredList)</em> – Contains all deferreds of pending requests.</p>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.DjangoWebRoot.getChild">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">getChild</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#DjangoWebRoot.getChild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.DjangoWebRoot.getChild" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>To make things work we nudge the url tree to make this the
root.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path</strong> (<em>str</em>) – Url path.</p></li>
<li><p><strong>request</strong> (<em>Request object</em>) – Incoming request.</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>We make sure to save the request queue so
that we can safely kill the threadpool
on a server reload.</p>
</dd></dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.Website">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">Website</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">resource</span></em>, <em class="sig-param"><span class="n">requestFactory</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#Website"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.Website" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.web.server.Site</span></code></p>
<p>This class will only log http requests if settings.DEBUG is True.</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py attribute">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.Website.noisy">
<code class="sig-name descname">noisy</code><em class="property"> = False</em><a class="headerlink" href="#evennia.server.webserver.Website.noisy" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.Website.logPrefix">
<code class="sig-name descname">logPrefix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#Website.logPrefix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.Website.logPrefix" title="Permalink to this definition"></a></dt>
<dd><p>How to be named in logs</p>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.Website.log">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">log</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#Website.log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.Website.log" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Conditional logging</p>
</dd></dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.WSGIWebServer">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">WSGIWebServer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pool</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#WSGIWebServer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.WSGIWebServer" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.application.internet.TCPServer</span></code></p>
<p>This is a WSGI webserver. It makes sure to start
the threadpool after the service itself started,
so as to register correctly with the twisted daemon.</p>
<p>call with WSGIWebServer(threadpool, port, wsgi_resource)</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.WSGIWebServer.__init__">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">pool</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#WSGIWebServer.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.WSGIWebServer.__init__" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>This just stores the threadpool.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pool</strong> (<em>ThreadPool</em>) – The twisted threadpool.</p></li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li><p><strong>args</strong> (<em>any</em>) – Passed on to the TCPServer.</p></li>
<li><p><strong>kwargs</strong> (<em>any</em>) – Passed on to the TCPServer.</p></li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</ul>
</dd>
</dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.WSGIWebServer.startService">
<code class="sig-name descname">startService</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#WSGIWebServer.startService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.WSGIWebServer.startService" title="Permalink to this definition"></a></dt>
<dd><p>Start the pool after the service starts.</p>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.WSGIWebServer.stopService">
<code class="sig-name descname">stopService</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#WSGIWebServer.stopService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.WSGIWebServer.stopService" title="Permalink to this definition"></a></dt>
<dd><p>Safely stop the pool after the service stops.</p>
</dd></dl>
</dd></dl>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py class">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.PrivateStaticRoot">
Updated HTML docs
2020-10-15 01:31:30 +02:00
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.webserver.</code><code class="sig-name descname">PrivateStaticRoot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em>, <em class="sig-param"><span class="n">defaultType</span><span class="o">=</span><span class="default_value">'text/html'</span></em>, <em class="sig-param"><span class="n">ignoredExts</span><span class="o">=</span><span class="default_value">()</span></em>, <em class="sig-param"><span class="n">registry</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">allowExt</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#PrivateStaticRoot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.PrivateStaticRoot" title="Permalink to this definition"></a></dt>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">twisted.web.static.File</span></code></p>
<p>This overrides the default static file resource so as to not make the
directory listings public (that is, if you go to /media or /static you
won’t see an index of all static/media files on the server).</p>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<dl class="py method">
Updated HTML docs
2020-07-14 00:21:00 +02:00
<dt id="evennia.server.webserver.PrivateStaticRoot.directoryListing">
<code class="sig-name descname">directoryListing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/webserver.html#PrivateStaticRoot.directoryListing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.webserver.PrivateStaticRoot.directoryListing" title="Permalink to this definition"></a></dt>
<dd><p>Return a resource that generates an HTML listing of the
directory this path represents.</p>
<p>&#64;return: A resource that renders the directory to HTML.
&#64;rtype: L{DirectoryLister}</p>
</dd></dl>
</dd></dl>
Updated HTML docs
2021-05-16 00:06:01 +02:00
</section>
Updated HTML docs
2020-07-14 00:21:00 +02:00
Updated HTML docs
2020-10-15 01:31:30 +02:00
<div class="clearer"></div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
Updated HTML docs
2021-10-26 21:41:11 +02:00
<li><a href="../_sources/api/evennia.server.webserver.md.txt"
Updated HTML docs
2020-07-14 00:21:00 +02:00
rel="nofollow">Show Page Source</a></li>
</ul>
Updated HTML docs
2021-03-06 01:37:43 +01:00
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
Updated HTML docs
2021-08-06 00:47:51 +02:00
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
Updated HTML docs
2021-08-06 00:53:44 +02:00
<a href="https://evennia.blogspot.com/">Blog</a>
Updated HTML docs
2021-03-06 01:37:43 +01:00
</li>
</ul>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<h3>Versions</h3>
<ul>
<li><a href="evennia.server.webserver.html">1.0-dev (develop branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.webserver</a></li>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</ul>
Updated HTML docs
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-07-14 00:21:00 +02:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Updated HTML docs
2020-10-15 01:31:30 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
Updated HTML docs
2020-07-14 00:21:00 +02:00
</div>
</body>
</html>
Reference in a new issue Copy permalink