211 lines
10 KiB
HTML
211 lines
10 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.SAMTerminal</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="..\private\i2p.samclasses-module.html">Module samclasses</a> ::
|
||
|
|
Class SAMTerminal
|
||
|
|
</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.SAMTerminal-class.html" target="_top">no frames</a>]</font></td></tr>
|
||
|
|
</table></td>
|
||
|
|
</tr></table>
|
||
|
|
|
||
|
|
<!-- =========== START OF CLASS DESCRIPTION =========== -->
|
||
|
|
<h2 class="class">Class SAMTerminal</h2>
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
Message-by-message communication with SAM through a single pysocket.
|
||
|
|
_on_* messages are dispatched to msgobj.
|
||
|
|
<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><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>addr</span>,
|
||
|
|
<span class=summary-sig-arg>msgobj</span>)</span></code>
|
||
|
|
</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.samclasses.SAMTerminal-class.html#_poll_loop" class="summary-sig-name"><code>_poll_loop</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Polling loop for incoming messages.</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.samclasses.SAMTerminal-class.html#_samdecode" class="summary-sig-name"><code>_samdecode</code></a>(<span class=summary-sig-arg>self</span>,
|
||
|
|
<span class=summary-sig-arg>s</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Given a SAM command, returns (a, b), where a is the string at the
|
||
|
|
beginning of the command, and b is a dictionary of name, value pairs for
|
||
|
|
the command.</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.samclasses.SAMTerminal-class.html#check" class="summary-sig-name"><code>check</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Raise an error if terminal was closed, otherwise do nothing.</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.samclasses.SAMTerminal-class.html#check_message" class="summary-sig-name"><code>check_message</code></a>(<span class=summary-sig-arg>self</span>,
|
||
|
|
<span class=summary-sig-arg>kwargs</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Raises an error if kwargs['RESULT'] != 'OK'.</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.samclasses.SAMTerminal-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Close the SAM terminal.</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.samclasses.SAMTerminal-class.html#on_message" class="summary-sig-name"><code>on_message</code></a>(<span class=summary-sig-arg>self</span>,
|
||
|
|
<span class=summary-sig-arg>msg</span>,
|
||
|
|
<span class=summary-sig-arg>kwargs</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Process a SAM message that was received.</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.samclasses.SAMTerminal-class.html#queue_get" class="summary-sig-name"><code>queue_get</code></a>(<span class=summary-sig-arg>self</span>,
|
||
|
|
<span class=summary-sig-arg>q</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Identical to q.get() unless a call to self.check() fails, in which
|
||
|
|
case the waiting is cut short with an error.</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.samclasses.SAMTerminal-class.html#send_message" class="summary-sig-name"><code>send_message</code></a>(<span class=summary-sig-arg>self</span>,
|
||
|
|
<span class=summary-sig-arg>msg</span>)</span></code>
|
||
|
|
<br />
|
||
|
|
Send a message to the SAM bridge.</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="_poll_loop"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">_poll_loop</span>(<span class=sig-arg>self</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Polling loop for incoming messages.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="_samdecode"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">_samdecode</span>(<span class=sig-arg>self</span>,
|
||
|
|
<span class=sig-arg>s</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Given a SAM command, returns (a, b), where a is the string at the
|
||
|
|
beginning of the command, and b is a dictionary of name, value pairs
|
||
|
|
for the command.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></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>self</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Raise an error if terminal was closed, otherwise do nothing.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="check_message"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">check_message</span>(<span class=sig-arg>self</span>,
|
||
|
|
<span class=sig-arg>kwargs</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Raises an error if kwargs['RESULT'] != 'OK'.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="close"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Close the SAM terminal.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="on_message"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">on_message</span>(<span class=sig-arg>self</span>,
|
||
|
|
<span class=sig-arg>msg</span>,
|
||
|
|
<span class=sig-arg>kwargs</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Process a SAM message that was received. Dispatch to
|
||
|
|
self._on_MESSAGE_NAME(**kwargs).
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="queue_get"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">queue_get</span>(<span class=sig-arg>self</span>,
|
||
|
|
<span class=sig-arg>q</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Identical to q.get() unless a call to self.check() fails, in which
|
||
|
|
case the waiting is cut short with an error.
|
||
|
|
<dl><dt></dt><dd>
|
||
|
|
</dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
<a name="send_message"></a>
|
||
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
||
|
|
<h3><span class="sig"><span class="sig-name">send_message</span>(<span class=sig-arg>self</span>,
|
||
|
|
<span class=sig-arg>msg</span>)</span>
|
||
|
|
</h3>
|
||
|
|
Send a message to the SAM bridge. A newline will be automatically
|
||
|
|
added if none is present.
|
||
|
|
<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"> <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>
|