twisted.conch.interfaces.IConchUser.html [plain text]
<?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>twisted.conch.interfaces.IConchUser</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="twisted.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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.conch.html">Package conch</a> ::
<a href="twisted.conch.interfaces.html">Module interfaces</a> ::
Class IConchUser
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.conch.interfaces.IConchUser.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IConchUser</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IConchUser</b>
</pre><br />
<hr/>
A user who has been authenticated to Cred through Conch. This is the
interface between the SSH connection and the user.
<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="twisted.conch.interfaces.IConchUser.html#gotGlobalRequest" class="summary-sig-name"><code>gotGlobalRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>requestType</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
A global request was sent from the other side.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> subclass of <code>SSHChannel</code>/<code>tuple</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.interfaces.IConchUser.html#lookupChannel" class="summary-sig-name"><code>lookupChannel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>channelType</span>,
<span class=summary-sig-arg>windowSize</span>,
<span class=summary-sig-arg>maxPacket</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
The other side requested a channel of some sort.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.interfaces.IConchUser.html#lookupSubsystem" class="summary-sig-name"><code>lookupSubsystem</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>subsystem</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
The other side requested a subsystem.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.conch.interfaces.IConchUser.html#conn"><code>conn</code></a></b>: The SSHConnection object for this user.</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="gotGlobalRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">gotGlobalRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>requestType</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>A global request was sent from the other side.</p>
By default, this dispatches to a method 'channel_channelType' with
any non-alphanumerics in the channelType replace with _'s. If it cannot
find a suitable method, it returns an OPEN_UNKNOWN_CHANNEL_TYPE error.
The method is called with arguments of windowSize, maxPacket, data.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="lookupChannel"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">lookupChannel</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>channelType</span>,
<span class=sig-arg>windowSize</span>,
<span class=sig-arg>maxPacket</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>The other side requested a channel of some sort. channelType is the
type of channel being requested, windowSize is the initial size of the
remote window, maxPacket is the largest packet we should send, data is
any other packet data (often nothing).</p>
We return a subclass of SSHChannel. If an appropriate channel can
not be found, an exception will be raised. If a ConchError is raised,
the .value will be the message, and the .data will be the error
code.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>channelType</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>windowSize</b></code>
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>maxPacket</b></code>
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
subclass of <code>SSHChannel</code>/<code>tuple</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="lookupSubsystem"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">lookupSubsystem</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>subsystem</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>The other side requested a subsystem. subsystem is the name of the
subsystem being requested. data is any other packet data (often
nothing).</p>
We return a Protocol.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="conn"></a>
<h3>conn</h3>
The SSHConnection object for this user.
</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="twisted.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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:09 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>