I2P_Developers/i2p.itoopie
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
e622fdc885fd2102a87040e8e61f618dc32d6e2f
i2p.itoopie/apps/sam/python/doc/epydoc/html/private/i2p.samclasses.StreamSession-class.html
sunshine 4ed4ce8240 Updated Python I2P version 0.91 by sunshine
2004-08-02 14:00:56 +00:00

277 lines
15 KiB
HTML
Raw Blame History

<?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.samclasses.StreamSession</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="i2p-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;i2p</a> ::
<a href="..\private\i2p.samclasses-module.html">Module&nbsp;samclasses</a> ::
Class&nbsp;StreamSession
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<b>show&nbsp;private</b>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="..\private\i2p.samclasses.StreamSession-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class StreamSession</h2>
<pre class="base-tree">
<a href="..\private\i2p.samclasses.BaseSession-class.html"><code>BaseSession</code></a> --+
|
<b>StreamSession</b>
</pre><br />
<hr/>
Stream session. All methods are blocking and threadsafe.
<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">&nbsp;</font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>addr</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#__len__" class="summary-sig-name"><code>__len__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Unconnected session; has no read data available.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#_on_STREAM_CLOSED" class="summary-sig-name"><code>_on_STREAM_CLOSED</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Got STREAM CLOSED command.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#_on_STREAM_CONNECTED" class="summary-sig-name"><code>_on_STREAM_CONNECTED</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Got STREAM CONNECTED command.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#_on_STREAM_RECEIVED" class="summary-sig-name"><code>_on_STREAM_RECEIVED</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Got STREAM RECEIVED command.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#_on_STREAM_STATUS" class="summary-sig-name"><code>_on_STREAM_STATUS</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Internal command, got STREAM STATUS.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#_send_stream" class="summary-sig-name"><code>_send_stream</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>id</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Internal command, send data to stream id.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#accept" class="summary-sig-name"><code>accept</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Wait for incoming connection, and return a Stream object for it.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dest</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Create a stream connected to remote destination 'dest'.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.StreamSession-class.html#listen" class="summary-sig-name"><code>listen</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>backlog</span>)</span></code>
<br />
Set maximum number of queued connections.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from BaseSession</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_encode_kwargs" class="summary-sig-name"><code>_encode_kwargs</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Internal command, encode extra kwargs for passing to SESSION
CREATE.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_hello" class="summary-sig-name"><code>_hello</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Internal command, handshake with SAM terminal.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_namelookup" class="summary-sig-name"><code>_namelookup</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Internal command, does a NAMING LOOKUP query.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_on_HELLO_REPLY" class="summary-sig-name"><code>_on_HELLO_REPLY</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Internal command, got HELLO REPLY.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_on_NAMING_REPLY" class="summary-sig-name"><code>_on_NAMING_REPLY</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Internal command, got NAMING REPLY.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_on_SESSION_STATUS" class="summary-sig-name"><code>_on_SESSION_STATUS</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Internal command, got SESSION STATUS.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#_set_properties" class="summary-sig-name"><code>_set_properties</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Internal command, call at end of __init__ to set up properties.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><code><span class="summary-sig"><a href="..\private\i2p.samclasses.BaseSession-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Close the session.</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="__len__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__len__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Length operator)</i>
</h3>
Unconnected session; has no read data available.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_on_STREAM_CLOSED"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_on_STREAM_CLOSED</span>(<span class=sig-arg>self</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
Got STREAM CLOSED command. Call idmap[id].on_close(e) and delete
idmap[id].
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_on_STREAM_CONNECTED"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_on_STREAM_CONNECTED</span>(<span class=sig-arg>self</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
Got STREAM CONNECTED command. This is what accept() commands wait
for.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_on_STREAM_RECEIVED"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_on_STREAM_RECEIVED</span>(<span class=sig-arg>self</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
Got STREAM RECEIVED command. Dispatch to
idmap[id].on_receive(s).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_on_STREAM_STATUS"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_on_STREAM_STATUS</span>(<span class=sig-arg>self</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
Internal command, got STREAM STATUS. Unblocks connect.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_send_stream"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_send_stream</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>id</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Internal command, send data to stream id. Use Stream.send in your
code.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="accept"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">accept</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span>
</h3>
Wait for incoming connection, and return a Stream object for it.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connect</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>dest</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span>
</h3>
Create a stream connected to remote destination 'dest'. The id is
random. If the timeout is exceeded, do NOT raise an error; rather,
return a Stream object with .didconnect set to False.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listen"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listen</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>backlog</span>)</span>
</h3>
Set maximum number of queued connections.
<dl><dt></dt><dd>
</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="i2p-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>
Reference in New Issue View Git Blame Copy Permalink