<!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>API — Stem 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.1.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>
<script type="text/javascript" src="_static/theme_extras.js"></script>
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="top" title="Stem 1.1.0 documentation" href="index.html" />
<link rel="up" title="Contents" href="contents.html" />
<link rel="next" title="Controller" href="api/control.html" />
<link rel="prev" title="Frequently Asked Questions" href="faq.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="_static/logo.png" alt="Logo"/><h1 class="heading"><a href="index.html">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>API</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="index.html">Home</a></li>
<li><a href="tutorials.html">Tutorials</a>
<ul>
<li><a href="tutorials/the_little_relay_that_could.html">Hello World</a></li>
<li><a href="tutorials/to_russia_with_love.html">Client Usage</a></li>
<li><a href="tutorials/tortoise_and_the_hare.html">Event Listening</a></li>
<li><a href="tutorials/mirror_mirror_on_the_wall.html">Tor Descriptors</a></li>
<li><a href="tutorials/east_of_the_sun.html">Utilities</a></li>
<li><a href="tutorials/double_double_toil_and_trouble.html">Examples</a></li>
</ul>
</li>
<li><a href="#">API</a>
<ul>
<li><a href="api/control.html">stem.control</a></li>
<li><a href="api/connection.html">stem.connection</a></li>
<li><a href="api/socket.html">stem.socket</a></li>
<li><a href="api/process.html">stem.process</a></li>
<li><a href="api/response.html">stem.response</a></li>
<li><a href="api/exit_policy.html">stem.exit_policy</a></li>
<li><a href="api/version.html">stem.version</a></li>
<li><a href="##descriptors">Descriptors</a></li>
<li><a href="##utilities">Utilities</a></li>
</ul>
</li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a>
<ul>
<li><a href="faq.html">FAQ</a></li>
<li><a href="change_log.html">Change Log</a></li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li>
<li><a href="download.html">Download</a></li>
</ul>
</li>
</ul>
</p>
</div>
<div class="content">
<div class="section" id="api">
<h1>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h1>
<div class="section" id="controller">
<h2>Controller<a class="headerlink" href="#controller" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><strong>Core</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="api/control.html">stem.control</a> - <strong>Controller used to talk with Tor</strong>.</li>
<li><a class="reference external" href="api/connection.html">stem.connection</a> - Connection and authentication to the Tor control socket.</li>
<li><a class="reference external" href="api/socket.html">stem.socket</a> - Low level control socket used to talk with Tor.</li>
<li><a class="reference external" href="api/process.html">stem.process</a> - Launcher for the Tor process.</li>
<li><a class="reference external" href="api/response.html">stem.response</a> - Messages that Tor may provide the controller.</li>
</ul>
</div></blockquote>
<ul class="simple">
<li><strong>Types</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="api/exit_policy.html">stem.exit_policy</a> - Relay policy for the destinations it will or won’t allow traffic to.</li>
<li><a class="reference external" href="api/version.html">stem.version</a> - Tor versions that can be compared to determine Tor’s capabilities.</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="descriptors">
<h2>Descriptors<a class="headerlink" href="#descriptors" title="Permalink to this headline">¶</a></h2>
<p>To read descriptors from disk use <a class="reference internal" href="api/descriptor/descriptor.html#stem.descriptor.__init__.parse_file" title="stem.descriptor.__init__.parse_file"><tt class="xref py py-func docutils literal"><span class="pre">parse_file()</span></tt></a> for
individual files and <a class="reference external" href="api/descriptor/reader.html">stem.descriptor.reader</a> for batches. You can also use
<a class="reference external" href="api/descriptor/remote.html">stem.descriptor.remote</a> to download descriptors
remotely like tor does.</p>
<ul class="simple">
<li><strong>Classes</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="api/descriptor/descriptor.html">stem.descriptor</a> - Base class for descriptors.</li>
<li><a class="reference external" href="api/descriptor/server_descriptor.html">stem.descriptor.server_descriptor</a> - Relay and bridge server descriptors.</li>
<li><a class="reference external" href="api/descriptor/extrainfo_descriptor.html">stem.descriptor.extrainfo_descriptor</a> - Relay and bridge extrainfo descriptors.</li>
<li><a class="reference external" href="api/descriptor/microdescriptor.html">stem.descriptor.microdescriptor</a> - Minimalistic counterpart for server descriptors.</li>
<li><a class="reference external" href="api/descriptor/networkstatus.html">stem.descriptor.networkstatus</a> - Network status documents which make up the Tor consensus.</li>
<li><a class="reference external" href="api/descriptor/router_status_entry.html">stem.descriptor.router_status_entry</a> - Relay entries within a network status document.</li>
<li><a class="reference external" href="api/descriptor/tordnsel.html">stem.descriptor.tordnsel</a> - <a class="reference external" href="https://www.torproject.org/projects/tordnsel.html.en">TorDNSEL</a> exit lists.</li>
</ul>
</div></blockquote>
<ul class="simple">
<li><a class="reference external" href="api/descriptor/reader.html">stem.descriptor.reader</a> - Reads and parses descriptor files from disk.</li>
<li><a class="reference external" href="api/descriptor/remote.html">stem.descriptor.remote</a> - Downloads descriptors from directory mirrors and authorities.</li>
<li><a class="reference external" href="api/descriptor/export.html">stem.descriptor.export</a> - Exports descriptors to other formats.</li>
</ul>
</div>
<div class="section" id="utilities">
<h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="api/util/conf.html">stem.util.conf</a> - Configuration file handling.</li>
<li><a class="reference external" href="api/util/connection.html">stem.util.connection</a> - Connection and IP related utilities.</li>
<li><a class="reference external" href="api/util/enum.html">stem.util.enum</a> - Enumeration class.</li>
<li><a class="reference external" href="api/util/str_tools.html">stem.util.str_tools</a> - String utilities.</li>
<li><a class="reference external" href="api/util/system.html">stem.util.system</a> - Tools related to the local system.</li>
<li><a class="reference external" href="api/util/term.html">stem.util.term</a> - Tools for interacting with the terminal.</li>
</ul>
</div>
</div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
