mirror of
https://github.com/evennia/evennia.git
synced 2026-04-04 06:57:16 +02:00
446 lines
No EOL
35 KiB
HTML
446 lines
No EOL
35 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.telnet — 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.telnet_oob" href="evennia.server.portal.telnet_oob.html" />
|
||
<link rel="prev" title="evennia.server.portal.suppress_ga" href="evennia.server.portal.suppress_ga.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.telnet_oob.html" title="evennia.server.portal.telnet_oob"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.server.portal.suppress_ga.html" title="evennia.server.portal.suppress_ga"
|
||
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.telnet</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.server.portal.telnet">
|
||
<span id="evennia-server-portal-telnet"></span><h1>evennia.server.portal.telnet<a class="headerlink" href="#module-evennia.server.portal.telnet" title="Link to this heading">¶</a></h1>
|
||
<p>This module implements the telnet protocol.</p>
|
||
<p>This depends on a generic session module that implements
|
||
the actual login procedure of the game, tracks
|
||
sessions etc.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetServerFactory">
|
||
<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.telnet.</span></span><span class="sig-name descname"><span class="pre">TelnetServerFactory</span></span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetServerFactory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetServerFactory" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ServerFactory</span></code></p>
|
||
<p>This exists only to name this better in logs.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetServerFactory.noisy">
|
||
<span class="sig-name descname"><span class="pre">noisy</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#evennia.server.portal.telnet.TelnetServerFactory.noisy" title="Link to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetServerFactory.logPrefix">
|
||
<span class="sig-name descname"><span class="pre">logPrefix</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetServerFactory.logPrefix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetServerFactory.logPrefix" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Describe this factory for log messages.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol">
|
||
<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.telnet.</span></span><span class="sig-name descname"><span class="pre">TelnetProtocol</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/telnet.html#TelnetProtocol"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Telnet</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">StatefulTelnetProtocol</span></code>, <a class="reference internal" href="evennia.server.session.html#evennia.server.session.Session" title="evennia.server.session.Session"><code class="xref py py-class docutils literal notranslate"><span class="pre">Session</span></code></a></p>
|
||
<p>Each player connecting over telnet (ie using most traditional mud
|
||
clients) gets a telnet protocol instance assigned to them. All
|
||
communication between game and player goes through here.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.__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/telnet.html#TelnetProtocol.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.__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.telnet.TelnetProtocol.dataReceived">
|
||
<span class="sig-name descname"><span class="pre">dataReceived</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.dataReceived"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.dataReceived" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Unused by default, but a good place to put debug printouts
|
||
of incoming data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.connectionMade">
|
||
<span class="sig-name descname"><span class="pre">connectionMade</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.connectionMade"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.connectionMade" title="Link to this definition">¶</a></dt>
|
||
<dd><p>This is called when the connection is first established.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.toggle_nop_keepalive">
|
||
<span class="sig-name descname"><span class="pre">toggle_nop_keepalive</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.toggle_nop_keepalive"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.toggle_nop_keepalive" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Allow to toggle the NOP keepalive for those sad clients that
|
||
can’t even handle a NOP instruction. This is turned off by the
|
||
protocol_flag NOPKEEPALIVE (settable e.g. by the default
|
||
<strong>option</strong> command).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.handshake_done">
|
||
<span class="sig-name descname"><span class="pre">handshake_done</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</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/telnet.html#TelnetProtocol.handshake_done"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.handshake_done" title="Link to this definition">¶</a></dt>
|
||
<dd><p>This is called by all telnet extensions once they are finished.
|
||
When all have reported, a sync with the server is performed.
|
||
The system will force-call this sync after a small time to handle
|
||
clients that don’t reply to handshakes at all.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.at_login">
|
||
<span class="sig-name descname"><span class="pre">at_login</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.at_login"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.at_login" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Called when this session gets authenticated by the server.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.enableRemote">
|
||
<span class="sig-name descname"><span class="pre">enableRemote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.enableRemote"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.enableRemote" title="Link to this definition">¶</a></dt>
|
||
<dd><p>This sets up the remote-activated options we allow for this protocol.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>option</strong> (<em>char</em>) – The telnet option to enable.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><em>enable (bool)</em> – If this option should be enabled.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.disableRemote">
|
||
<span class="sig-name descname"><span class="pre">disableRemote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.disableRemote"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.disableRemote" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Signal a programming error by raising an exception.</p>
|
||
<p>L{enableRemote} must return true for the given value of C{option} in
|
||
order for this method to be called. If a subclass of L{Telnet}
|
||
overrides enableRemote to allow certain options to be enabled, it must
|
||
also override disableRemote tto disable those options.</p>
|
||
<p>@raise NotImplementedError: Always raised.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.enableLocal">
|
||
<span class="sig-name descname"><span class="pre">enableLocal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.enableLocal"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.enableLocal" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Call to allow the activation of options for this protocol</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>option</strong> (<em>char</em>) – The telnet option to enable locally.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><em>enable (bool)</em> – If this option should be enabled.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.disableLocal">
|
||
<span class="sig-name descname"><span class="pre">disableLocal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">option</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.disableLocal"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.disableLocal" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Disable a given option locally.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>option</strong> (<em>char</em>) – The telnet option to disable locally.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.connectionLost">
|
||
<span class="sig-name descname"><span class="pre">connectionLost</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.connectionLost"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.connectionLost" title="Link to this definition">¶</a></dt>
|
||
<dd><p>this is executed when the connection is lost for whatever
|
||
reason. it can also be called directly, from the disconnect
|
||
method</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>reason</strong> (<em>str</em>) – Motivation for losing connection.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.applicationDataReceived">
|
||
<span class="sig-name descname"><span class="pre">applicationDataReceived</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.applicationDataReceived"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.applicationDataReceived" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Telnet method called when non-telnet-command data is coming in
|
||
over the telnet connection. We pass it on to the game engine
|
||
directly.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>data</strong> (<em>str</em>) – Incoming data.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.sendLine">
|
||
<span class="sig-name descname"><span class="pre">sendLine</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.sendLine"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.sendLine" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Hook overloading the one used by linereceiver.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>line</strong> (<em>str</em>) – Line to send.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.disconnect">
|
||
<span class="sig-name descname"><span class="pre">disconnect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reason</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.disconnect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.disconnect" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Generic hook for the engine to call in order to
|
||
disconnect this protocol.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>reason</strong> (<em>str</em><em>, </em><em>optional</em>) – Reason for disconnecting.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.data_in">
|
||
<span class="sig-name descname"><span class="pre">data_in</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">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.data_in"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.data_in" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Data User -> Evennia</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>kwargs</strong> (<em>any</em>) – Options from the protocol.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.data_out">
|
||
<span class="sig-name descname"><span class="pre">data_out</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">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/telnet.html#TelnetProtocol.data_out"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.data_out" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Data Evennia -> User</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Keyword Arguments<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>kwargs</strong> (<em>any</em>) – Options to the protocol</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.send_text">
|
||
<span class="sig-name descname"><span class="pre">send_text</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/telnet.html#TelnetProtocol.send_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.send_text" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Send text data. This is an in-band telnet operation.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>text</strong> (<em>str</em>) – The first argument is always the text string to send. No other arguments
|
||
are considered.</p>
|
||
</dd>
|
||
<dt class="field-even">Keyword Arguments<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>options</strong> (<em>dict</em>) – <p>Send-option flags</p>
|
||
<ul class="simple">
|
||
<li><p>mxp: Enforce MXP link support.</p></li>
|
||
<li><p>ansi: Enforce no ANSI colors.</p></li>
|
||
<li><p>xterm256: Enforce xterm256 colors, regardless of TTYPE.</p></li>
|
||
<li><p>noxterm256: Enforce no xterm256 color support, regardless of TTYPE.</p></li>
|
||
<li><p>nocolor: Strip all Color, regardless of ansi/xterm256 setting.</p></li>
|
||
<li><p>truecolor: Enforce truecolor, regardless of TTYPE.</p></li>
|
||
<li><dl class="simple">
|
||
<dt>raw: Pass string through without any ansi processing</dt><dd><p>(i.e. include Evennia ansi markers but do not
|
||
convert them into ansi tokens)</p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl class="simple">
|
||
<dt>echo: Turn on/off line echo on the client. Turn</dt><dd><p>off line echo for client, for example for password.
|
||
Note that it must be actively turned back on again!</p>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.send_prompt">
|
||
<span class="sig-name descname"><span class="pre">send_prompt</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/telnet.html#TelnetProtocol.send_prompt"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.send_prompt" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Send a prompt - a text without a line end. See send_text for argument options.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="evennia.server.portal.telnet.TelnetProtocol.send_default">
|
||
<span class="sig-name descname"><span class="pre">send_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cmdname</span></span></em>, <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/telnet.html#TelnetProtocol.send_default"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.server.portal.telnet.TelnetProtocol.send_default" title="Link to this definition">¶</a></dt>
|
||
<dd><p>Send other oob data</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.telnet</a><ul>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetServerFactory"><code class="docutils literal notranslate"><span class="pre">TelnetServerFactory</span></code></a><ul>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetServerFactory.noisy"><code class="docutils literal notranslate"><span class="pre">TelnetServerFactory.noisy</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetServerFactory.logPrefix"><code class="docutils literal notranslate"><span class="pre">TelnetServerFactory.logPrefix()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol</span></code></a><ul>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.__init__"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.__init__()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.dataReceived"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.dataReceived()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.connectionMade"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.connectionMade()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.toggle_nop_keepalive"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.toggle_nop_keepalive()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.handshake_done"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.handshake_done()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.at_login"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.at_login()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.enableRemote"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.enableRemote()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.disableRemote"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.disableRemote()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.enableLocal"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.enableLocal()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.disableLocal"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.disableLocal()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.connectionLost"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.connectionLost()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.applicationDataReceived"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.applicationDataReceived()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.sendLine"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.sendLine()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.disconnect"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.disconnect()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.data_in"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.data_in()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.data_out"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.data_out()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.send_text"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.send_text()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.send_prompt"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.send_prompt()</span></code></a></li>
|
||
<li><a class="reference internal" href="#evennia.server.portal.telnet.TelnetProtocol.send_default"><code class="docutils literal notranslate"><span class="pre">TelnetProtocol.send_default()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.server.portal.suppress_ga.html"
|
||
title="previous chapter">evennia.server.portal.suppress_ga</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.server.portal.telnet_oob.html"
|
||
title="next chapter">evennia.server.portal.telnet_oob</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.telnet.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.telnet_oob.html" title="evennia.server.portal.telnet_oob"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.server.portal.suppress_ga.html" title="evennia.server.portal.suppress_ga"
|
||
>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.telnet</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> |