mirror of
https://github.com/evennia/evennia.git
synced 2026-04-05 07:27:17 +02:00
275 lines
No EOL
20 KiB
HTML
275 lines
No EOL
20 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>evennia.server.portal.service — Evennia latest documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
|
||
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
|
||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<link rel="icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="evennia.server.portal.ssh" href="evennia.server.portal.ssh.html" />
|
||
<link rel="prev" title="evennia.server.portal.rss" href="evennia.server.portal.rss.html" />
|
||
</head><body>
|
||
<div class="related" role="navigation" aria-label="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="evennia.server.portal.ssh.html" title="evennia.server.portal.ssh"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.server.portal.rss.html" title="evennia.server.portal.rss"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.server.html" >evennia.server</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.server.portal.html" accesskey="U">evennia.server.portal</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.server.portal.service</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.server.portal.service">
|
||
<span id="evennia-server-portal-service"></span><h1>evennia.server.portal.service<a class="headerlink" href="#module-evennia.server.portal.service" title="Link to this heading">¶</a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.server.portal.service.</span></span><span class="sig-name descname"><span class="pre">EvenniaPortalService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">MultiService</span></code></p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.__init__">
|
||
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.__init__" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.portal_maintenance">
|
||
<span class="sig-name descname"><span class="pre">portal_maintenance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.portal_maintenance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.portal_maintenance" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Repeated maintenance tasks for the portal.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.privilegedStartService">
|
||
<span class="sig-name descname"><span class="pre">privilegedStartService</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.privilegedStartService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.privilegedStartService" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.register_plugins">
|
||
<span class="sig-name descname"><span class="pre">register_plugins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.register_plugins"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.register_plugins" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.check_lockdown">
|
||
<span class="sig-name descname"><span class="pre">check_lockdown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interfaces</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.check_lockdown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.check_lockdown" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.register_ssl">
|
||
<span class="sig-name descname"><span class="pre">register_ssl</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.register_ssl"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.register_ssl" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.register_ssh">
|
||
<span class="sig-name descname"><span class="pre">register_ssh</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.register_ssh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.register_ssh" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.register_webserver">
|
||
<span class="sig-name descname"><span class="pre">register_webserver</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.register_webserver"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.register_webserver" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.register_telnet">
|
||
<span class="sig-name descname"><span class="pre">register_telnet</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.register_telnet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.register_telnet" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.register_amp">
|
||
<span class="sig-name descname"><span class="pre">register_amp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.register_amp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.register_amp" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.get_info_dict">
|
||
<span class="sig-name descname"><span class="pre">get_info_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.get_info_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.get_info_dict" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Return the Portal info, for display.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.service.EvenniaPortalService.shutdown">
|
||
<span class="sig-name descname"><span class="pre">shutdown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_reactor_stopping</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_stop_server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/service.html#EvenniaPortalService.shutdown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.service.EvenniaPortalService.shutdown" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Shuts down the server from inside it.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>_reactor_stopping</strong> (<em>bool</em><em>, </em><em>optional</em>) – This is set if server
|
||
is already in the process of shutting down; in this case
|
||
we don’t need to stop it again.</p></li>
|
||
<li><p><strong>_stop_server</strong> (<em>bool</em><em>, </em><em>optional</em>) – Only used in portal-interactive mode;
|
||
makes sure to stop the Server cleanly.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p>Note that restarting (regardless of the setting) will not work
|
||
if the Portal is currently running in daemon mode. In that
|
||
case it always needs to be restarted manually.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
<div class="clearer"></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
|
||
</a></p>
|
||
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">evennia.server.portal.service</a><ul>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService</span></code></a><ul>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.__init__"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.__init__()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.portal_maintenance"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.portal_maintenance()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.privilegedStartService"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.privilegedStartService()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.register_plugins"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.register_plugins()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.check_lockdown"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.check_lockdown()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.register_ssl"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.register_ssl()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.register_ssh"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.register_ssh()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.register_webserver"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.register_webserver()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.register_telnet"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.register_telnet()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.register_amp"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.register_amp()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.get_info_dict"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.get_info_dict()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.service.EvenniaPortalService.shutdown"><code class="docutils literal notranslate"><span class="pre">EvenniaPortalService.shutdown()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.server.portal.rss.html"
|
||
title="previous chapter">evennia.server.portal.rss</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.server.portal.ssh.html"
|
||
title="next chapter">evennia.server.portal.ssh</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.server.portal.service.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><h3>Links</h3>
|
||
<ul>
|
||
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
||
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
||
<li>
|
||
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
||
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
||
<a href="https://evennia.blogspot.com/">Blog</a>
|
||
</li>
|
||
</ul>
|
||
<h3>Doc Versions</h3>
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
|
||
</li>
|
||
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="related" role="navigation" aria-label="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="evennia.server.portal.ssh.html" title="evennia.server.portal.ssh"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.server.portal.rss.html" title="evennia.server.portal.rss"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.server.html" >evennia.server</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.server.portal.html" >evennia.server.portal</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.server.portal.service</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2024, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
||
</div>
|
||
</body>
|
||
</html> |