twisted.conch.ssh.channel.SSHChannel.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.ssh.channel.SSHChannel</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.ssh.html">Package ssh</a> ::
<a href="twisted.conch.ssh.channel.html">Module channel</a> ::
Class SSHChannel
</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.ssh.channel.SSHChannel.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class SSHChannel</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.conch.ssh.forwarding.SSHConnectForwardingChannel.html"><code>SSHConnectForwardingChannel</code></a>,
<a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html"><code>SSHListenForwardingChannel</code></a>,
<a href="twisted.conch.ssh.session.SSHSession.html"><code>SSHSession</code></a>,
<a href="twisted.conch.client.unix.SSHUnixChannel.html"><code>SSHUnixChannel</code></a></dd></dl>
<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>localWindow</span>,
<span class=summary-sig-arg>localMaxPacket</span>,
<span class=summary-sig-arg>remoteWindow</span>,
<span class=summary-sig-arg>remoteMaxPacket</span>,
<span class=summary-sig-arg>conn</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>avatar</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</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="twisted.conch.ssh.channel.SSHChannel.html#addWindowBytes" class="summary-sig-name"><code>addWindowBytes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>bytes</span>)</span></code>
<br />
Called when bytes are added to the remote window.</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.ssh.channel.SSHChannel.html#channelOpen" class="summary-sig-name"><code>channelOpen</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>specificData</span>)</span></code>
<br />
Called when the channel is opened.</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.ssh.channel.SSHChannel.html#closed" class="summary-sig-name"><code>closed</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the channel is closed.</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.ssh.channel.SSHChannel.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Called when we receive data.</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.ssh.channel.SSHChannel.html#eofReceived" class="summary-sig-name"><code>eofReceived</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the other side will send no more data.</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.ssh.channel.SSHChannel.html#extReceived" class="summary-sig-name"><code>extReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dataType</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Called when we receive extended data (usually standard error).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>tuple</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.channel.SSHChannel.html#getHost" class="summary-sig-name"><code>getHost</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a tuple describing our side of the connection.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>tuple</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.channel.SSHChannel.html#getPeer" class="summary-sig-name"><code>getPeer</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a tuple describing the other side of the connection.</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.ssh.channel.SSHChannel.html#loseConnection" class="summary-sig-name"><code>loseConnection</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Close the channel.</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.ssh.channel.SSHChannel.html#openFailed" class="summary-sig-name"><code>openFailed</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reason</span>)</span></code>
<br />
Called when the the open failed for some reason.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>bool</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.channel.SSHChannel.html#requestReceived" class="summary-sig-name"><code>requestReceived</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 />
Called when a request is sent to this channel.</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.ssh.channel.SSHChannel.html#startWriting" class="summary-sig-name"><code>startWriting</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the remote buffer has more room, as a hint to continue
writing.</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.ssh.channel.SSHChannel.html#stopWriting" class="summary-sig-name"><code>stopWriting</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the remote buffer is full, as a hint to stop writing.</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.ssh.channel.SSHChannel.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Write some data to the channel.</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.ssh.channel.SSHChannel.html#writeExtended" class="summary-sig-name"><code>writeExtended</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dataType</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Send extended data to this channel.</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.ssh.channel.SSHChannel.html#writeSequence" class="summary-sig-name"><code>writeSequence</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Part of the Transport interface.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.conch.ssh.channel.SSHChannel.html#name"><code>name</code></a></b> = <span title="None">None </span></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="addWindowBytes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addWindowBytes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>bytes</span>)</span>
</h3>
Called when bytes are added to the remote window. By default it
clears the data buffers.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>bytes</b></code>
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="channelOpen"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">channelOpen</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>specificData</span>)</span>
</h3>
Called when the channel is opened. specificData is any data that the
other side sent us when opening the channel.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>specificData</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="closed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">closed</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the channel is closed.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="dataReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dataReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Called when we receive data.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="eofReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">eofReceived</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the other side will send no more data.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="extReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">extReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>dataType</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Called when we receive extended data (usually standard error).
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>dataType</b></code>
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getHost"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getHost</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return a tuple describing our side of the connection.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>tuple</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getPeer"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getPeer</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return a tuple describing the other side of the connection.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>tuple</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="loseConnection"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">loseConnection</span>(<span class=sig-arg>self</span>)</span>
</h3>
Close the channel.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="openFailed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">openFailed</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reason</span>)</span>
</h3>
Called when the the open failed for some reason. reason.desc is a
string descrption, reason.code the the SSH error code.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>reason</b></code>
<br /><i>
(type=<code>error.ConchError</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="requestReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">requestReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>requestType</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Called when a request is sent to this channel. By default it
delegates to self.request_<requestType>. If this functio returns
true, the request succeeded, otherwise it failed.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>requestType</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>bool</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="startWriting"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">startWriting</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the remote buffer has more room, as a hint to continue
writing.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="stopWriting"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">stopWriting</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the remote buffer is full, as a hint to stop writing.
This can be ignored, but it can be helpful.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="write"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Write some data to the channel. If there is not enough remote window
available, buffer until it is.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="writeExtended"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">writeExtended</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>dataType</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Send extended data to this channel. If there is not enough remote
window available, buffer until there is.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>dataType</b></code>
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="writeSequence"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">writeSequence</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Part of the Transport interface. Write a list of strings to the
channel.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>data</b></code>
<br /><i>
(type=<code>list</code> of <code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="name"></a>
<h3>name</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </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="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:06 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>