146 lines
6.0 KiB
HTML
146 lines
6.0 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.samclasses</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 samclasses
|
|
</b></font></br>
|
|
</td>
|
|
<td><table cellpadding="0" cellspacing="0">
|
|
<tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr>
|
|
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="..\private\i2p.samclasses-module.html" target="_top">no frames</a>]</font></td></tr>
|
|
</table></td>
|
|
</tr></table>
|
|
|
|
<!-- =========== START OF MODULE DESCRIPTION =========== -->
|
|
<h2 class="module">Module i2p.samclasses</h2>
|
|
|
|
<p>Lower-level SAM API, interfaces with SAM Bridge.</p>
|
|
<p>For internal use only.</p>
|
|
<p>Use the higher level i2p.socket module for your own programs.</p>
|
|
<p>For details on SAM, see "Simple Anonymous Messaging (SAM)
|
|
v1.0," as published by jrandom.</p>
|
|
Class Overview:
|
|
<ul>
|
|
<li>
|
|
SAMTerminal: Message sender/reader, talks to SAM Bridge.
|
|
</li>
|
|
<li>
|
|
StringBuffer: Queue for character data.
|
|
</li>
|
|
<li>
|
|
BaseSession: SAM session classes are derived from this.
|
|
</li>
|
|
<li>
|
|
StreamSession: SAM stream session class, threadsafe, high
|
|
level.
|
|
</li>
|
|
<li>
|
|
DatagramSession: SAM datagram session, threadsafe, high level.
|
|
</li>
|
|
<li>
|
|
RawSession: SAM raw session, threadsafe, high level.
|
|
</li>
|
|
</ul>
|
|
<p>Note that a 'None' timeout is an infinite timeout: it blocks forever
|
|
if necessary.</p>
|
|
Todo:
|
|
<ul>
|
|
<li>
|
|
Error handling is a huge mess. Neaten it up. Subclass a ErrorMixin
|
|
class, then use set_error(e), check_error(), get_error().
|
|
</li>
|
|
<li>
|
|
Streams are a huge mess. Neaten them up.
|
|
</li>
|
|
<li>
|
|
This whole interface is a tad confusing. Neaten it up.
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
|
|
<!-- =========== START OF CLASSES =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Classes</th></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.BaseSession-class.html"><code>BaseSession</code></a></b></td>
|
|
<td>Base session, from which StreamSession, DatagramSession, and
|
|
RawSession are derived.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.DatagramSession-class.html"><code>DatagramSession</code></a></b></td>
|
|
<td>Datagram session.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.Deque-class.html"><code>Deque</code></a></b></td>
|
|
<td>A double-ended queue.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.RawSession-class.html"><code>RawSession</code></a></b></td>
|
|
<td>Raw session.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.SAMTerminal-class.html"><code>SAMTerminal</code></a></b></td>
|
|
<td>Message-by-message communication with SAM through a single
|
|
pysocket.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.Stream-class.html"><code>Stream</code></a></b></td>
|
|
<td>Receives and sends data for an individual stream.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.StreamSession-class.html"><code>StreamSession</code></a></b></td>
|
|
<td>Stream session.</td></tr>
|
|
<tr><td width="15%">
|
|
<b><a href="..\private\i2p.samclasses.StringBuffer-class.html"><code>StringBuffer</code></a></b></td>
|
|
<td>A FIFO for characters.</td></tr>
|
|
</table><br />
|
|
|
|
|
|
<!-- =========== 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><a name="sleep"></a><span class="summary-sig"><span class="summary-sig-name">sleep</span>()</span></code>
|
|
</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>
|