diff options
Diffstat (limited to 'docs/private/paramiko.Message-class.html')
| -rw-r--r-- | docs/private/paramiko.Message-class.html | 654 |
1 files changed, 0 insertions, 654 deletions
diff --git a/docs/private/paramiko.Message-class.html b/docs/private/paramiko.Message-class.html deleted file mode 100644 index d6934e3..0000000 --- a/docs/private/paramiko.Message-class.html +++ /dev/null @@ -1,654 +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.Message</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 Message - </b></font></br> - </td> - <td><table cellpadding="0" cellspacing="0"> - <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Message-class.html">hide private</a>]</font></td></tr> - <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Message-class.html" target="_top">no frames</a>]</font></td></tr> - </table></td> -</tr></table> - -<!-- =========== START OF CLASS DESCRIPTION =========== --> -<h2 class="class">Type Message</h2> - -<pre class="base-tree"> -<a href="__builtin__.object-class.html"><code>object</code></a> --+ - | - <b>Message</b> -</pre><br /> - -<hr/> - -<p>An SSH2 <i>Message</i> is a stream of bytes that encodes some -combination of strings, integers, bools, and infinite-precision integers -(known in python as <i>long</i>s). This class builds or breaks down such -a byte stream.</p> -Normally you don't need to deal with anything this low-level, but it's -exposed for people implementing custom extensions, or features that -paramiko doesn't support yet. -<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><span class="summary-sig"><a href="paramiko.Message-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>content</span>)</span></code> -<br /> -Create a new SSH2 Message.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-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"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Return the byte stream content of this Message, as a string.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>, - <span class="summary-sig-vararg">*seq</span>)</span></code> -<br /> -Add a sequence of items to 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="paramiko.Message-class.html#add_boolean" class="summary-sig-name"><code>add_boolean</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>b</span>)</span></code> -<br /> -Add a boolean value to 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="paramiko.Message-class.html#add_byte" class="summary-sig-name"><code>add_byte</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>b</span>)</span></code> -<br /> -Write a single byte to the stream, without any formatting.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_bytes" class="summary-sig-name"><code>add_bytes</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>b</span>)</span></code> -<br /> -Write bytes to the stream, without any formatting.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int" class="summary-sig-name"><code>add_int</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>n</span>)</span></code> -<br /> -Add an integer to 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="paramiko.Message-class.html#add_int64" class="summary-sig-name"><code>add_int64</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>n</span>)</span></code> -<br /> -Add a 64-bit int to 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="paramiko.Message-class.html#add_list" class="summary-sig-name"><code>add_list</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>l</span>)</span></code> -<br /> -Add a list of strings to 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="paramiko.Message-class.html#add_mpint" class="summary-sig-name"><code>add_mpint</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>z</span>)</span></code> -<br /> -Add a long int to the stream, encoded as an infinite-precision -integer.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_string" class="summary-sig-name"><code>add_string</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>s</span>)</span></code> -<br /> -Add a string to the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> bool -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_boolean" class="summary-sig-name"><code>get_boolean</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Fetch a boolean from the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_byte" class="summary-sig-name"><code>get_byte</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Return the next byte of the Message, without decomposing it.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_bytes" class="summary-sig-name"><code>get_bytes</code></a>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>n</span>)</span></code> -<br /> -Return the next <code>n</code> bytes of the Message, without -decomposing into an int, string, etc.</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.Message-class.html#get_int" class="summary-sig-name"><code>get_int</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Fetch an int from the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> long -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int64" class="summary-sig-name"><code>get_int64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Fetch a 64-bit int from the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> list of strings -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_list" class="summary-sig-name"><code>get_list</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Fetch a list of strings from the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> long -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_mpint" class="summary-sig-name"><code>get_mpint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Fetch a long int (mpint) from the stream.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_remainder" class="summary-sig-name"><code>get_remainder</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Return the bytes of this Message that haven't already been parsed and -returned.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_so_far" class="summary-sig-name"><code>get_so_far</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Returns the bytes of this Message that have been parsed and -returned.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> string -</font></td> - <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_string" class="summary-sig-name"><code>get_string</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Fetch a string 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="paramiko.Message-class.html#rewind" class="summary-sig-name"><code>rewind</code></a>(<span class=summary-sig-arg>self</span>)</span></code> -<br /> -Rewind the message to the beginning as if no items had been parsed out -of it yet.</td></tr> -<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> - <td><code><a name="_add"></a><span class="summary-sig"><span class="summary-sig-name">_add</span>(<span class=summary-sig-arg>self</span>, - <span class=summary-sig-arg>i</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> -</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="__init__"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>content</span>=<span class=sig-default>None</span>)</span> - <br /><i>(Constructor)</i> - </h3> - Create a new SSH2 Message. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>content</b></code> - - the byte stream to use as the Message content (passed in only - when decomposing a Message). - <br /><i> - (type=string)</i> - </dd> - </dl> - <dl><dt><b>Overrides:</b></dt> - <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> - </dl> - </dd></dl> -</td></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> - string - </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="__str__"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> - <br /><i>(Informal representation operator)</i> - </h3> - Return the byte stream content of this Message, as a string. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - the contents of this Message. - <br /><i> - (type=string)</i> - </dd> - </dl> - <dl><dt><b>Overrides:</b></dt> - <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>, - <span class="sig-vararg">*seq</span>)</span> - </h3> - Add a sequence of items to the stream. The values are encoded based - on their type: str, int, bool, list, or long. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>seq</b></code> - - the sequence of items - <br /><i> - (type=sequence)</i> - </dd> - </dl> -<p><b>Bug:</b> longs are encoded non-deterministically. Don't use this method. -</p> - - </dd></dl> -</td></tr></table> - -<a name="add_boolean"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_boolean</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>b</span>)</span> - </h3> - Add a boolean value to the stream. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>b</b></code> - - boolean value to add - <br /><i> - (type=bool)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_byte"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_byte</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>b</span>)</span> - </h3> - Write a single byte to the stream, without any formatting. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>b</b></code> - - byte to add - <br /><i> - (type=str)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_bytes"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_bytes</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>b</span>)</span> - </h3> - Write bytes to the stream, without any formatting. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>b</b></code> - - bytes to add - <br /><i> - (type=str)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_int"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_int</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>n</span>)</span> - </h3> - Add an integer to the stream. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>n</b></code> - - integer to add - <br /><i> - (type=int)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_int64"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_int64</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>n</span>)</span> - </h3> - Add a 64-bit int to the stream. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>n</b></code> - - long int to add - <br /><i> - (type=long)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_list"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_list</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>l</span>)</span> - </h3> - Add a list of strings to the stream. They are encoded identically to - a single string of values separated by commas. (Yes, really, that's how - SSH2 does it.) - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>l</b></code> - - list of strings to add - <br /><i> - (type=list(str))</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_mpint"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_mpint</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>z</span>)</span> - </h3> - Add a long int to the stream, encoded as an infinite-precision - integer. This method only works on positive numbers. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>z</b></code> - - long int to add - <br /><i> - (type=long)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="add_string"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">add_string</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>s</span>)</span> - </h3> - Add a string to the stream. - <dl><dt></dt><dd> - <dl><dt><b>Parameters:</b></dt> - <dd><code><b>s</b></code> - - string to add - <br /><i> - (type=str)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_boolean"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_boolean</span>(<span class=sig-arg>self</span>)</span> - </h3> - Fetch a boolean from the stream. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - <code>True</code> or <code>False</code> (from the - Message). - <br /><i> - (type=bool)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_byte"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_byte</span>(<span class=sig-arg>self</span>)</span> - </h3> - Return the next byte of the Message, without decomposing it. This is - equivalent to <a href="paramiko.Message-class.html#get_bytes" - class="link"><code>get_bytes(1)</code></a>. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - the next byte of the Message, or <code>' - aren't any bytes remaining. - <br /><i> - (type=string)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_bytes"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_bytes</span>(<span class=sig-arg>self</span>, - <span class=sig-arg>n</span>)</span> - </h3> - Return the next <code>n</code> bytes of the Message, without - decomposing into an int, string, etc. Just the raw bytes are - returned. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a string of the next <code>n</code> bytes of the Message, or a - string of <code>n</code> zero bytes, if there aren't - <code>n</code> bytes remaining. - <br /><i> - (type=string)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_int"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_int</span>(<span class=sig-arg>self</span>)</span> - </h3> - Fetch an int from the stream. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a 32-bit unsigned integer. - <br /><i> - (type=int)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_int64"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_int64</span>(<span class=sig-arg>self</span>)</span> - </h3> - Fetch a 64-bit int from the stream. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a 64-bit unsigned integer. - <br /><i> - (type=long)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_list"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_list</span>(<span class=sig-arg>self</span>)</span> - </h3> - Fetch a list of strings from the stream. These are trivially encoded - as comma-separated values in a string. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a list of strings. - <br /><i> - (type=list of strings)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_mpint"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_mpint</span>(<span class=sig-arg>self</span>)</span> - </h3> - Fetch a long int (mpint) from the stream. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - an arbitrary-length integer. - <br /><i> - (type=long)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_remainder"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_remainder</span>(<span class=sig-arg>self</span>)</span> - </h3> - Return the bytes of this Message that haven't already been parsed - and returned. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a string of the bytes not parsed yet. - <br /><i> - (type=string)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_so_far"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_so_far</span>(<span class=sig-arg>self</span>)</span> - </h3> - Returns the bytes of this Message that have been parsed and - returned. The string passed into a Message's constructor can be - regenerated by concatenating <code>get_so_far</code> and <a - href="paramiko.Message-class.html#get_remainder" - class="link"><code>get_remainder</code></a>. - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a string of the bytes parsed so far. - <br /><i> - (type=string)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="get_string"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">get_string</span>(<span class=sig-arg>self</span>)</span> - </h3> - Fetch a string from the stream. This could be a byte string and may - contain unprintable characters. (It's not unheard of for a string to - contain another byte-stream Message.) - <dl><dt></dt><dd> - <dl><dt><b>Returns:</b></dt> - <dd> - a string. - <br /><i> - (type=string)</i> - </dd> - </dl> - </dd></dl> -</td></tr></table> - -<a name="rewind"></a> -<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> - <h3><span class="sig"><span class="sig-name">rewind</span>(<span class=sig-arg>self</span>)</span> - </h3> - Rewind the message to the beginning as if no items had been parsed - out of it yet. - <dl><dt></dt><dd> - </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:46 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> |