181 lines
8.2 KiB
HTML
181 lines
8.2 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.tunnel.TunnelClient</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> ::
|
|
<a href="i2p.tunnel-module.html">Module tunnel</a> ::
|
|
Class TunnelClient
|
|
</b></font></br>
|
|
</td>
|
|
<td><table cellpadding="0" cellspacing="0">
|
|
<tr><td align="right"><font size="-2">[show private | <a href="../public/i2p.tunnel.TunnelClient-class.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.tunnel.TunnelClient-class.html" target="_top">no frames</a>]</font></td></tr>
|
|
</table></td>
|
|
</tr></table>
|
|
|
|
<!-- =========== START OF CLASS DESCRIPTION =========== -->
|
|
<h2 class="class">Class TunnelClient</h2>
|
|
|
|
<pre class="base-tree">
|
|
<a href="i2p.tunnel.Tunnel-class.html"><code>Tunnel</code></a> --+
|
|
|
|
|
<b>TunnelClient</b>
|
|
</pre><br />
|
|
|
|
<hr/>
|
|
|
|
|
|
<!-- =========== START OF METHOD SUMMARY =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Method 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.tunnel.TunnelClient-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>session</span>,
|
|
<span class=summary-sig-arg>port</span>,
|
|
<span class=summary-sig-arg>dest</span>,
|
|
<span class=summary-sig-arg>samaddr</span>,
|
|
<span class=summary-sig-arg>nconnect</span>,
|
|
<span class=summary-sig-arg>timeout</span>,
|
|
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
|
|
<br />
|
|
Tunnels localhost:port --> I2P Destination dest.</td></tr>
|
|
<tr bgcolor="#e8f0f8" class="group">
|
|
<th colspan="2"> Inherited from Tunnel</th></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="i2p.tunnel.Tunnel-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Close all connections made for this tunnel.</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.tunnel.Tunnel-class.html#_run" class="summary-sig-name"><code>_run</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Manage the tunnel in a separate thread.</td></tr>
|
|
</table><br />
|
|
|
|
|
|
<!-- =========== START OF PROPERTY SUMMARY =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Property Summary</th></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><b><a href="i2p.tunnel.TunnelClient-class.html#dest"><code>dest</code></a></b></td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><b><a href="i2p.tunnel.TunnelClient-class.html#remotedest"><code>remotedest</code></a></b>: Remote Destination.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><b><a href="i2p.tunnel.TunnelClient-class.html#session"><code>session</code></a></b></td></tr></table><br />
|
|
|
|
|
|
<!-- =========== START OF METHOD DETAILS =========== -->
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="details">
|
|
<th colspan="2">Method Details</th></tr>
|
|
</table>
|
|
|
|
<a name="__init__"></a>
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
|
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
|
|
<span class=sig-arg>session</span>,
|
|
<span class=sig-arg>port</span>,
|
|
<span class=sig-arg>dest</span>,
|
|
<span class=sig-arg>samaddr</span>=<span class=sig-default>'127.0.0.1:7656'</span>,
|
|
<span class=sig-arg>nconnect</span>=<span class=sig-default>-1</span>,
|
|
<span class=sig-arg>timeout</span>=<span class=sig-default>None</span>,
|
|
<span class="sig-kwarg">**kwargs</span>)</span>
|
|
<br /><i>(Constructor)</i>
|
|
</h3>
|
|
<p>Tunnels localhost:port --> I2P Destination dest.</p>
|
|
A session named 'session' is created locally, for purposes of
|
|
routing to 'dest'. nconnect and timeout are the maximum number of
|
|
connections and maximum time per connection. All other arguments are
|
|
passed to socket.socket(). This call blocks until the tunnel is
|
|
ready.
|
|
<dl><dt></dt><dd>
|
|
<dl><dt><b>Overrides:</b></dt>
|
|
<dd><a href="i2p.tunnel.Tunnel-class.html#__init__"><code>i2p.tunnel.Tunnel.__init__</code></a></dd>
|
|
</dl>
|
|
</dd></dl>
|
|
</td></tr></table>
|
|
<br />
|
|
|
|
|
|
<!-- =========== START OF PROPERTY DETAILS =========== -->
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="details">
|
|
<th colspan="2">Property Details</th></tr>
|
|
</table>
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
|
|
|
<a name="dest"></a>
|
|
<h3>dest</h3>
|
|
<dl>
|
|
<dt></dt>
|
|
<dd>
|
|
<dl>
|
|
<dt><b>Get Method:</b></dt>
|
|
<dd><code><span class="variable-quote">'</span>Local Destination used for routing.<span class="variable-quote">'</span> </code>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
|
|
|
<a name="remotedest"></a>
|
|
<h3>remotedest</h3>
|
|
Remote Destination.
|
|
</td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
|
|
|
<a name="session"></a>
|
|
<h3>session</h3>
|
|
<dl>
|
|
<dt></dt>
|
|
<dd>
|
|
<dl>
|
|
<dt><b>Get Method:</b></dt>
|
|
<dd><code><span class="variable-quote">'</span>Local Destination used for routing.<span class="variable-quote">'</span> </code>
|
|
|
|
</dd>
|
|
</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>
|