twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel.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.forwarding.SSHListenClientForwardingChannel</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="twisted.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" 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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.conch.html">Package&nbsp;conch</a> ::
        <a href="twisted.conch.ssh.html">Package&nbsp;ssh</a> ::
        <a href="twisted.conch.ssh.forwarding.html">Module&nbsp;forwarding</a> ::
        Class&nbsp;SSHListenClientForwardingChannel
      </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>&nbsp;|&nbsp;<a href="twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class SSHListenClientForwardingChannel</h2>

<pre class="base-tree">
            <a href="twisted.conch.ssh.channel.SSHChannel.html"><code>SSHChannel</code></a> --+    
                         |    
<a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.html"><code>SSHListenForwardingChannel</code></a> --+
                             |
                            <b>SSHListenClientForwardingChannel</b>
</pre><br />

<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 bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from SSHListenForwardingChannel</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.forwarding.SSHListenForwardingChannel.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 bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from SSHChannel</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.channel.SSHChannel.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.conch.ssh.channel.SSHChannel.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</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="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">&nbsp;</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">&nbsp;</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">        <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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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">&nbsp;</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>str</code></font></td>
<td><b><a href="twisted.conch.ssh.forwarding.SSHListenClientForwardingChannel.html#name"><code>name</code></a></b> = <span title="'direct-tcpip'"><code><span class="variable-quote">'</span>direct-tcpip<span class="variable-quote">'</span>                                    </code>
</span></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>str</code>

      </dd>
<span title="'direct-tcpip'">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>direct-tcpip<span class="variable-quote">'</span>                                                         </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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.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" 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&nbsp;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:13 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>