twisted.conch.ssh.session.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.session</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> ::
Module session
</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.session.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.conch.ssh.session</h2>
<p>This module contains the implementation of SSHSession, which (by
default) allows access to a shell and a python interpreter over SSH.</p>
<p>This module is unstable.</p>
Maintainer: <a href="mailto:z3p@twistedmatrix.com">Paul
Swartz</a>
<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="twisted.conch.ssh.session._DummyTransport.html"><code>_DummyTransport</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.conch.ssh.session._ProtocolWrapper.html"><code>_ProtocolWrapper</code></a></b></td>
<td>This class wraps a Protocol instance in a ProcessProtocol
instance.</td></tr>
<tr><td width="15%">
<b><a href="twisted.conch.ssh.session.SSHSession.html"><code>SSHSession</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.conch.ssh.session.SSHSessionClient.html"><code>SSHSessionClient</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.conch.ssh.session.SSHSessionProcessProtocol.html"><code>SSHSessionProcessProtocol</code></a></b></td>
<td> </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><span class="summary-sig"><a href="twisted.conch.ssh.session.html#packRequest_pty_req" class="summary-sig-name"><code>packRequest_pty_req</code></a>(<span class=summary-sig-arg>term</span>,
(<span class=summary-sig-arg>rows</span>,
<span class=summary-sig-arg>cols</span>,
<span class=summary-sig-arg>xpixel</span>,
<span class=summary-sig-arg>ypixel</span>),
<span class=summary-sig-arg>modes</span>)</span></code>
<br />
Pack a pty-req request so that it is suitable for sending.</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.session.html#packRequest_window_change" class="summary-sig-name"><code>packRequest_window_change</code></a>((<span class=summary-sig-arg>rows</span>,
<span class=summary-sig-arg>cols</span>,
<span class=summary-sig-arg>xpixel</span>,
<span class=summary-sig-arg>ypixel</span>))</span></code>
<br />
Pack a window-change request so that it is suitable for sending.</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.session.html#parseRequest_pty_req" class="summary-sig-name"><code>parseRequest_pty_req</code></a>(<span class=summary-sig-arg>data</span>)</span></code>
<br />
Parse the data from a pty-req request into usable 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.session.html#parseRequest_window_change" class="summary-sig-name"><code>parseRequest_window_change</code></a>(<span class=summary-sig-arg>data</span>)</span></code>
<br />
Parse the data from a window-change request into usuable data.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="wrapProcessProtocol"></a><span class="summary-sig"><span class="summary-sig-name">wrapProcessProtocol</span>(<span class=summary-sig-arg>inst</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="wrapProtocol"></a><span class="summary-sig"><span class="summary-sig-name">wrapProtocol</span>(<span class=summary-sig-arg>proto</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="packRequest_pty_req"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">packRequest_pty_req</span>(<span class=sig-arg>term</span>,
(<span class=sig-arg>rows</span>,
<span class=sig-arg>cols</span>,
<span class=sig-arg>xpixel</span>,
<span class=sig-arg>ypixel</span>),
<span class=sig-arg>modes</span>)</span>
</h3>
<p>Pack a pty-req request so that it is suitable for sending.</p>
NOTE: modes must be packed before being sent here.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="packRequest_window_change"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">packRequest_window_change</span>((<span class=sig-arg>rows</span>,
<span class=sig-arg>cols</span>,
<span class=sig-arg>xpixel</span>,
<span class=sig-arg>ypixel</span>))</span>
</h3>
Pack a window-change request so that it is suitable for sending.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseRequest_pty_req"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseRequest_pty_req</span>(<span class=sig-arg>data</span>)</span>
</h3>
Parse the data from a pty-req request into usable data.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a tuple of (terminal type, (rows, cols, xpixel, ypixel),
modes)
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parseRequest_window_change"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseRequest_window_change</span>(<span class=sig-arg>data</span>)</span>
</h3>
Parse the data from a window-change request into usuable data.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
a tuple of (rows, cols, xpixel, ypixel)
</dd>
</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:56 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>