266 lines
12 KiB
HTML
266 lines
12 KiB
HTML
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
|
|
<head>
|
||
|
|
<title>i2p.router</title>
|
||
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
|
||
|
|
</head>
|
||
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
||
|
|
alink="#204080">
|
||
|
|
|
||
|
|
<!-- =========== START OF NAVBAR =========== -->
|
||
|
|
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
|
||
|
|
<tr valign="center">
|
||
|
|
<th class="navbar"> <a class="navbar" href="i2p-module.html">Home</a> </th>
|
||
|
|
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
|
||
|
|
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
|
||
|
|
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
|
||
|
|
<th class="navbar" width="100%"></th>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
||
|
|
<tr valign="top">
|
||
|
|
<td width="100%">
|
||
|
|
<font size="-1"><b class="breadcrumbs">
|
||
|
|
<a href="i2p-module.html">Package i2p</a> ::
|
||
|
|
Module router
|
||
|
|
</b></font></br>
|
||
|
|
</td>
|
||
|
|
<td><table cellpadding="0" cellspacing="0">
|
||
|
|
<tr><td align="right"><font size="-2">[show private | <a href="../public/i2p.router-module.html">hide private</a>]</font></td></tr>
|
||
|
|
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="i2p.router-module.html" target="_top">no frames</a>]</font></td></tr>
|
||
|
|
</table></td>
|
||
|
|
</tr></table>
|
||
|
|
|
||
|
|
<!-- =========== START OF MODULE DESCRIPTION =========== -->
|
||
|
|
<h2 class="module">Module i2p.router</h2>
|
||
|
|
|
||
|
|
Router control module
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<!-- =========== START OF FUNCTION SUMMARY =========== -->
|
||
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
||
|
|
<tr bgcolor="#70b0f0" class="summary">
|
||
|
|
<th colspan="2">Function Summary</th></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
||
|
|
<td><code><span class="summary-sig"><a href="i2p.router-module.html#check" class="summary-sig-name"><code>check</code></a>(<span class=summary-sig-arg>dir</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Checks whether a locally installed router is running.</td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
||
|
|
<td><code><span class="summary-sig"><a href="i2p.router-module.html#find" class="summary-sig-name"><code>find</code></a>(<span class=summary-sig-arg>dir</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Find the absolute path to a locally installed I2P router.</td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
||
|
|
<td><code><span class="summary-sig"><a href="i2p.router-module.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>dir</span>,
|
||
|
|
<span class=summary-sig-arg>hidden</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Start a locally installed I2P router.</td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
||
|
|
<td><code><span class="summary-sig"><a href="i2p.router-module.html#stop" class="summary-sig-name"><code>stop</code></a>(<span class=summary-sig-arg>dir</span>,
|
||
|
|
<span class=summary-sig-arg>force</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Stop a locally installed I2P router, if it was started by the current
|
||
|
|
Python program.</td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
||
|
|
<td><code><span class="summary-sig"><a href="..\private\i2p.router-module.html#_parse_config" class="summary-sig-name"><code>_parse_config</code></a>(<span class=summary-sig-arg>filename</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Return a dict with (name, value) items for the given I2P configuration
|
||
|
|
file.</td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
||
|
|
<td><code><span class="summary-sig"><a href="..\private\i2p.router-module.html#_run_program" class="summary-sig-name"><code>_run_program</code></a>(<span class=summary-sig-arg>filename</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Runs the given program in a new process and new terminal.</td></tr>
|
||
|
|
</table><br />
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== START OF VARIABLE SUMMARY =========== -->
|
||
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
||
|
|
<tr bgcolor="#70b0f0" class="summary">
|
||
|
|
<th colspan="2">Variable Summary</th></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
|
||
|
|
<td><b><a href="i2p.router-module.html#check_addrlist"><code>check_addrlist</code></a></b> = <span title="['127.0.0.1:7656', '127.0.0.1:4444']"><code>['127.0.0.1:7656', '127.0.0.1:4444'] </code>
|
||
|
|
</span></td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td>
|
||
|
|
<td><b><a href="i2p.router-module.html#our_router"><code>our_router</code></a></b> = <span title="False"><code>False </code>
|
||
|
|
</span></td></tr>
|
||
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>lock</code></font></td>
|
||
|
|
<td><b><a href="i2p.router-module.html#our_router_lock"><code>our_router_lock</code></a></b> = <span title="<thread.lock object at 0x0089D120>"><code><thread.lock object at 0x0089D120> </code>
|
||
|
|
</span></td></tr>
|
||
|
|
</table><br />
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== START OF FUNCTION DETAILS =========== -->
|
||
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
||
|
|
<tr bgcolor="#70b0f0" class="details">
|
||
|
|
<th colspan="2">Function Details</th></tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<a name="check"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">check</span>(<span class=sig-arg>dir</span>=<span class=sig-default>None</span>)</span>
|
||
|
|
</h3>
|
||
|
|
<p>Checks whether a locally installed router is running. Does nothing
|
||
|
|
if successful, otherwise raises i2p.RouterError.</p>
|
||
|
|
An I2P installation is located by using find(dir). The router.config
|
||
|
|
file is parsed for 'router.adminPort'. This port is queried to
|
||
|
|
determine whether the router is running.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="find"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">find</span>(<span class=sig-arg>dir</span>=<span class=sig-default>None</span>)</span>
|
||
|
|
</h3>
|
||
|
|
<p>Find the absolute path to a locally installed I2P router.</p>
|
||
|
|
An I2P installation is located by looking in the environment I2P,
|
||
|
|
then in PATH, then in the dir argument given to the function. It looks
|
||
|
|
for startRouter.sh or startRouter.bat. Raises ValueError if an I2P
|
||
|
|
installation could not be located.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="start"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">start</span>(<span class=sig-arg>dir</span>=<span class=sig-default>None</span>,
|
||
|
|
<span class=sig-arg>hidden</span>=<span class=sig-default>False</span>)</span>
|
||
|
|
</h3>
|
||
|
|
<p>Start a locally installed I2P router. Does nothing if the router has
|
||
|
|
already been started.</p>
|
||
|
|
<p>An I2P installation is located by using find(dir).</p>
|
||
|
|
If hidden is True, do not show a terminal for the router.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="stop"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">stop</span>(<span class=sig-arg>dir</span>=<span class=sig-default>None</span>,
|
||
|
|
<span class=sig-arg>force</span>=<span class=sig-default>False</span>)</span>
|
||
|
|
</h3>
|
||
|
|
<p>Stop a locally installed I2P router, if it was started by the
|
||
|
|
current Python program. If force is True, stop the router even if it
|
||
|
|
was started by another process. Do nothing if force is False and the
|
||
|
|
router was started by another program.</p>
|
||
|
|
<p>The file 'router.config' is located using the same search process
|
||
|
|
used for find(dir). It is parsed for 'router.shutdownPassword' and
|
||
|
|
'router.adminPort'. The router is shut down through the admin port.</p>
|
||
|
|
Raises i2p.RouterError if the I2P router is running but cannot be
|
||
|
|
stopped. You must uncomment the 'router.shutdownPassword' line for this
|
||
|
|
command to work.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="_parse_config"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">_parse_config</span>(<span class=sig-arg>filename</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Return a dict with (name, value) items for the given I2P
|
||
|
|
configuration file.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="_run_program"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">_run_program</span>(<span class=sig-arg>filename</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Runs the given program in a new process and new terminal.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== START OF VARIABLE DETAILS =========== -->
|
||
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
||
|
|
<tr bgcolor="#70b0f0" class="details">
|
||
|
|
<th colspan="2">Variable Details</th></tr>
|
||
|
|
</table>
|
||
|
|
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<a name="check_addrlist"></a>
|
||
|
|
<h3>check_addrlist</h3>
|
||
|
|
<dl>
|
||
|
|
<dt></dt>
|
||
|
|
<dd>
|
||
|
|
<dl>
|
||
|
|
<dt><b>Type:</b></dt>
|
||
|
|
<dd>
|
||
|
|
<code>list</code>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<span title="['127.0.0.1:7656', '127.0.0.1:4444']"> <dt><b>Value:</b></dt>
|
||
|
|
<dd><table><tr><td>
|
||
|
|
<pre class="variable">
|
||
|
|
['127.0.0.1:7656', '127.0.0.1:4444'] </pre>
|
||
|
|
</td></tr></table></dd>
|
||
|
|
</span> </dl>
|
||
|
|
</dd>
|
||
|
|
</dl></td></tr></table>
|
||
|
|
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<a name="our_router"></a>
|
||
|
|
<h3>our_router</h3>
|
||
|
|
<dl>
|
||
|
|
<dt></dt>
|
||
|
|
<dd>
|
||
|
|
<dl>
|
||
|
|
<dt><b>Type:</b></dt>
|
||
|
|
<dd>
|
||
|
|
<code>bool</code>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<span title="False"> <dt><b>Value:</b></dt>
|
||
|
|
<dd><table><tr><td>
|
||
|
|
<pre class="variable">
|
||
|
|
False </pre>
|
||
|
|
</td></tr></table></dd>
|
||
|
|
</span> </dl>
|
||
|
|
</dd>
|
||
|
|
</dl></td></tr></table>
|
||
|
|
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<a name="our_router_lock"></a>
|
||
|
|
<h3>our_router_lock</h3>
|
||
|
|
<dl>
|
||
|
|
<dt></dt>
|
||
|
|
<dd>
|
||
|
|
<dl>
|
||
|
|
<dt><b>Type:</b></dt>
|
||
|
|
<dd>
|
||
|
|
<code>lock</code>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<span title="<thread.lock object at 0x0089D120>"> <dt><b>Value:</b></dt>
|
||
|
|
<dd><table><tr><td>
|
||
|
|
<pre class="variable">
|
||
|
|
<thread.lock object at 0x0089D120> </pre>
|
||
|
|
</td></tr></table></dd>
|
||
|
|
</span> </dl>
|
||
|
|
</dd>
|
||
|
|
</dl></td></tr></table>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== START OF NAVBAR =========== -->
|
||
|
|
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
|
||
|
|
<tr valign="center">
|
||
|
|
<th class="navbar"> <a class="navbar" href="i2p-module.html">Home</a> </th>
|
||
|
|
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
|
||
|
|
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
|
||
|
|
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
|
||
|
|
<th class="navbar" width="100%"></th>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Aug 02 01:07:41 2004</font></td>
|
||
|
|
<td align="right"><a href="http://epydoc.sourceforge.net"
|
||
|
|
><font size="-2">http://epydoc.sf.net</font></a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|