/usr/share/doc/python-x2go/html/x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html is in python-x2go 0.1.1.8-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | <?xml version="1.0" encoding="ascii"?>
<!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>x2go.sftpserver.X2goRevFwTunnelToSFTP</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="x2go-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.x2go.org">Python X2go</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="x2go-module.html">Package x2go</a> ::
<a href="x2go.sftpserver-module.html">Module sftpserver</a> ::
Class X2goRevFwTunnelToSFTP
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class X2goRevFwTunnelToSFTP</h1><p class="nomargin-top"><span class="codelink"><a href="x2go.sftpserver-pysrc.html#X2goRevFwTunnelToSFTP">source code</a></span></p>
<pre class="base-tree">
object --+
|
threading._Verbose --+
|
threading.Thread --+
|
<a href="x2go.rforward.X2goRevFwTunnel-class.html">rforward.X2goRevFwTunnel</a> --+
|
<strong class="uidshort">X2goRevFwTunnelToSFTP</strong>
</pre>
<hr />
<p>A reverse fowarding tunnel with an sFTP server at its endpoint. This
blend of a Paramiko/SSH reverse forwarding tunnel is used to provide
access to local X2go client folders from within the the remote X2go
server session.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">server_port</span>,
<span class="summary-sig-arg">ssh_transport</span>,
<span class="summary-sig-arg">auth_key</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">session_instance</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">logger</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">loglevel</span>=<span class="summary-sig-default">56</span>)</span><br />
Start a Paramiko/SSH reverse forwarding tunnel, that has an sFTP
server listening at the endpoint of the tunnel.</td>
<td align="right" valign="top">
<span class="codelink"><a href="x2go.sftpserver-pysrc.html#X2goRevFwTunnelToSFTP.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
This method gets run once an <a
href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html"
class="link">X2goRevFwTunnelToSFTP</a> has been started with its
start() method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="x2go.sftpserver-pysrc.html#X2goRevFwTunnelToSFTP.run">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="x2go.rforward.X2goRevFwTunnel-class.html">rforward.X2goRevFwTunnel</a></code></b>:
<code><a href="x2go.rforward.X2goRevFwTunnel-class.html#__del__">__del__</a></code>,
<code><a href="x2go.rforward.X2goRevFwTunnel-class.html#cancel_port_forward">cancel_port_forward</a></code>,
<code><a href="x2go.rforward.X2goRevFwTunnel-class.html#notify">notify</a></code>,
<code><a href="x2go.rforward.X2goRevFwTunnel-class.html#pause">pause</a></code>,
<code><a href="x2go.rforward.X2goRevFwTunnel-class.html#resume">resume</a></code>,
<code><a href="x2go.rforward.X2goRevFwTunnel-class.html#stop_thread">stop_thread</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
<code>__repr__</code>,
<code>getName</code>,
<code>isAlive</code>,
<code>isDaemon</code>,
<code>is_alive</code>,
<code>join</code>,
<code>setDaemon</code>,
<code>setName</code>,
<code>start</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
<code>daemon</code>,
<code>ident</code>,
<code>name</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">server_port</span>,
<span class="sig-arg">ssh_transport</span>,
<span class="sig-arg">auth_key</span>=<span class="sig-default">None</span>,
<span class="sig-arg">session_instance</span>=<span class="sig-default">None</span>,
<span class="sig-arg">logger</span>=<span class="sig-default">None</span>,
<span class="sig-arg">loglevel</span>=<span class="sig-default">56</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="x2go.sftpserver-pysrc.html#X2goRevFwTunnelToSFTP.__init__">source code</a></span>
</td>
</tr></table>
<p>Start a Paramiko/SSH reverse forwarding tunnel, that has an sFTP
server listening at the endpoint of the tunnel.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>server_port</code></strong> (int) - the TCP/IP port on the X2go server (starting point of the
tunnel), normally some number above 30000</li>
<li><strong class="pname"><code>ssh_transport</code></strong> (<code>paramiko.Transport</code> instance) - the <a href="x2go.session.X2goSession-class.html"
class="link">X2goSession</a>'s Paramiko/SSH transport instance</li>
<li><strong class="pname"><code>auth_key</code></strong> (<code>paramiko.RSAKey</code> instance) - Paramiko/SSH RSAkey object that has to be authenticated against
by the remote sFTP client</li>
<li><strong class="pname"><code>logger</code></strong> (<a href="x2go.log.X2goLogger-class.html"
class="link">X2goLogger</a> instance) - you can pass an <a href="x2go.log.X2goLogger-class.html"
class="link">X2goLogger</a> object to the <a
href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html"
class="link">X2goRevFwTunnelToSFTP</a> constructor</li>
<li><strong class="pname"><code>loglevel</code></strong> (int) - if no <a href="x2go.log.X2goLogger-class.html"
class="link">X2goLogger</a> object has been supplied a new one
will be constructed with the given loglevel</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="run"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="x2go.sftpserver-pysrc.html#X2goRevFwTunnelToSFTP.run">source code</a></span>
</td>
</tr></table>
<p>This method gets run once an <a
href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html"
class="link">X2goRevFwTunnelToSFTP</a> has been started with its start()
method. Use <a href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html"
class="link">X2goRevFwTunnelToSFTP</a>.stop_thread() to stop the reverse
forwarding tunnel again (refer also to its pause() and resume()
method).</p>
<p><a href="x2go.sftpserver.X2goRevFwTunnelToSFTP-class.html#run"
class="link">X2goRevFwTunnelToSFTP.run()</a> waits for notifications of
an appropriate incoming Paramiko/SSH channel (issued by <a
href="x2go.rforward.X2goRevFwTunnel-class.html#notify"
class="link">X2goRevFwTunnelToSFTP.notify()</a>). Appropriate in this
context means, that its starting point on the X2go server matches the
class's property <code>server_port</code>.</p>
<p>Once a new incoming channel gets announced by the <a
href="x2go.rforward.X2goRevFwTunnel-class.html#notify"
class="link">notify()</a> method, a new <a
href="x2go.sftpserver.X2goRevFwSFTPChannelThread-class.html"
class="link">X2goRevFwSFTPChannelThread</a> instance will be initialized.
As a data stream handler, the function <a
href="x2go.sftpserver-module.html#x2go_rev_forward_sftpchannel_handler"
class="link">x2go_rev_forward_sftpchannel_handler()</a> will be used.</p>
<p>The channel will last till the connection gets dropped on the X2go
server side or until the tunnel gets paused by an <a
href="x2go.rforward.X2goRevFwTunnel-class.html#pause"
class="link">X2goRevFwTunnelToSFTP.pause()</a> call or stopped via the
<code>X2goRevFwTunnelToSFTP.stop_thread()</code> method.</p>
<dl class="fields">
<dt>Overrides:
threading.Thread.run
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="x2go-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.x2go.org">Python X2go</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Dec 12 09:31:13 2011
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|