diff options
Diffstat (limited to 'docs/private/paramiko.ChannelFile-class.html')
| -rw-r--r-- | docs/private/paramiko.ChannelFile-class.html | 347 |
1 files changed, 0 insertions, 347 deletions
diff --git a/docs/private/paramiko.ChannelFile-class.html b/docs/private/paramiko.ChannelFile-class.html deleted file mode 100644 index c3c4fea..0000000 --- a/docs/private/paramiko.ChannelFile-class.html +++ /dev/null @@ -1,347 +0,0 @@ -<?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>paramiko.ChannelFile</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="paramiko-module.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" width="100%"></th> - </tr> -</table> -<table width="100%" cellpadding="0" cellspacing="0"> - <tr valign="top"> - <td width="100%"> - <font size="-1"><b class="breadcrumbs"> - <a href="paramiko-module.html">Package paramiko</a> :: - Class ChannelFile - </b></font></br> - </td> - <td><table cellpadding="0" cellspacing="0"> - <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> - <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ChannelFile-class.html" target="_top">no frames</a>]</font></td></tr> - </table></td> -</tr></table> - -<!-- =========== START OF CLASS DESCRIPTION =========== --> -<h2 class="class">Type ChannelFile</h2> - -<pre class="base-tree"> - <a href="__builtin__.object-class.html"><code>object</code></a> --+ - | -<a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a> --+ - | - <b>ChannelFile</b> -</pre><br /> - -<dl><dt><b>Known Subclasses:</b></dt> -<dd> - <a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>ChannelStderrFile</code></a></dd></dl> - -<hr/> - -A file-like wrapper around <a href="paramiko.Channel-class.html" -class="link"><code>Channel</code></a>. A ChannelFile is created by -calling <a href="paramiko.Channel-class.html#makefile" -class="link"><code>Channel.makefile</code></a>. -<hr/> - -<p><b>Bug:</b> To correctly emulate the file object created from a socket's -<code>makefile</code> method, a <a href="paramiko.Channel-class.html" -class="link"><code>Channel</code></a> and its <code>ChannelFile</code> -should be able to be closed or garbage-collected independently. -Currently, closing the <code>ChannelFile</code> does nothing but flush -the buffer. -</p> - - -<!-- =========== 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>channel</span>, - <span class=summary-sig-arg>mode</span>, - <span class=summary-sig-arg>bufsize</span>)</span></code> -</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> str -</font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Returns a string representation of this object, for debugging.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#_read" class="summary-sig-name"><code>_read</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>size</span>)</span></code> -<br /> -<i>(subclass override)</i> Read data from the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.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 /> -<i>(subclass override)</i> Write data into the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>offset</span>, - <span class=summary-sig-arg>whence</span>)</span></code> -<br /> -Set the file's current position, like stdio's <code>fseek</code>.</td></tr> -<tr bgcolor="#e8f0f8" class="group"> - <th colspan="2"> Inherited from BufferedFile</th></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__del__" class="summary-sig-name"><code>__del__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Returns an iterator that can be used to iterate over the lines in this -file.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Close the file.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Write out any data in the write buffer.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> str -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Returns the next line from the input, or raises -<code>StopIteration</code> when EOF is hit.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> str -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>size</span>)</span></code> -<br /> -Read at most <code>size</code> bytes from the file (less if we hit the -end of the file first).</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> str -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>size</span>)</span></code> -<br /> -Read one entire line from the file.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> list -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>sizehint</span>)</span></code> -<br /> -Read all remaining lines using <a -href="paramiko.BufferedFile-class.html#readline" -class="link"><code>readline</code></a> and return them as a list.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> int -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Return the file's current position.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.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 data to the file.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>sequence</span>)</span></code> -<br /> -Write a sequence of strings to the file.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Identical to <code>iter(f)</code>.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_get_size" class="summary-sig-name"><code>_get_size</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -<i>(subclass override)</i> Return the size of the file.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_record_newline" class="summary-sig-name"><code>_record_newline</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>newline</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="../private/paramiko.BufferedFile-class.html#_set_mode" class="summary-sig-name"><code>_set_mode</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>mode</span>, - <span class=summary-sig-arg>bufsize</span>)</span></code> -<br /> -Subclasses call this method to initialize the BufferedFile.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>data</span>)</span></code> -</td></tr> -<tr bgcolor="#e8f0f8" class="group"> - <th colspan="2"> Inherited from object</th></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> -<br /> -x.__delattr__('name') <==> del x.name</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> -<br /> -x.__getattribute__('name') <==> x.name</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> -<br /> -x.__hash__() <==> hash(x)</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, - <span class=summary-sig-arg>S</span>, - <span class="summary-sig-vararg">...</span>)</span></code> -<br /> -T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> -<br /> -helper for pickle</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> -<br /> -helper for pickle</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> -<br /> -x.__setattr__('name', value) <==> x.name = value</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> -<br /> -x.__str__() <==> str(x)</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 bgcolor="#e8f0f8" class="group"> - <th colspan="2"> Inherited from BufferedFile</th></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> -<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> -<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> -<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></b> = <span title="0">0 </span></td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> -<td><b><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></b> = <span title="8192">8192 </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="__repr__"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> - <br /><i>(Representation operator)</i> - </h3> - Returns a string representation of this object, for debugging. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - str - </dd> - </dl> - <dl><dt><b>Overrides:</b></dt> - <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="_read"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">_read</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>size</span>)</span> - </h3> - <i>(subclass override)</i> Read data from the stream. Return - <code>None</code> or raise <code>EOFError</code> to indicate EOF. - <dl><dt></dt><dd> - <dl><dt><b>Overrides:</b></dt> - <dd><a href="../private/paramiko.BufferedFile-class.html#_read"><code>paramiko.BufferedFile._read</code></a> <i>(inherited documentation)</i> -</dd> - </dl> - </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> - <i>(subclass override)</i> Write data into the stream. - <dl><dt></dt><dd> - <dl><dt><b>Overrides:</b></dt> - <dd><a href="../private/paramiko.BufferedFile-class.html#_write"><code>paramiko.BufferedFile._write</code></a> <i>(inherited documentation)</i> -</dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="seek"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">seek</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>offset</span>, - <span class=sig-arg>whence</span>=<span class=sig-default>0</span>)</span> - </h3> - Set the file's current position, like stdio's <code>fseek</code>. - Not all file objects support seeking. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>offset</b></code> - - position to move to within the file, relative to - <code>whence</code>. - <br /><i> - (type=int)</i> - <dd><code><b>whence</b></code> - - type of movement: 0 = absolute; 1 = relative to the current - position; 2 = relative to the end of the file. - <br /><i> - (type=int)</i> - </dd> - </dl> - <dl><dt><b>Raises:</b></dt> - <dd><code><b>IOError</b></code> - - if the file doesn't support random access. - </dl> -<p><b>Note:</b> If a file is opened in append mode (<code>'a'</code> or -<code>'a+'</code>), any seek operations will be undone at the next write -(as the file position will move back to the end of the file). -</p> - - </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="paramiko-module.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" width="100%"></th> - </tr> -</table> - -<table border="0" cellpadding="0" cellspacing="0" width="100%"> - <tr> - <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> |