diff options
Diffstat (limited to 'docs/paramiko.Message-class.html')
| -rw-r--r-- | docs/paramiko.Message-class.html | 1098 |
1 files changed, 1098 insertions, 0 deletions
diff --git a/docs/paramiko.Message-class.html b/docs/paramiko.Message-class.html new file mode 100644 index 0000000..7edfd13 --- /dev/null +++ b/docs/paramiko.Message-class.html @@ -0,0 +1,1098 @@ +<?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>paramiko.Message</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="paramiko-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> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Message + </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="paramiko.Message-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class Message</h1><p class="nomargin-top"><span class="codelink"><a href="paramiko-pysrc.html#Message">source code</a></span></p> +<pre class="base-tree"> +object --+ + | + <strong class="uidshort">Message</strong> +</pre> + +<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> + <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.</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="paramiko.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">content</span>=<span class="summary-sig-default">None</span>)</span><br /> + Create a new SSH2 Message.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns a string representation of this object, for debugging.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Return the byte stream content of this Message, as a string.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add" class="summary-sig-name">add</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">*seq</span>)</span><br /> + Add a sequence of items to the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_boolean" class="summary-sig-name">add_boolean</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">b</span>)</span><br /> + Add a boolean value to the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_byte" class="summary-sig-name">add_byte</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">b</span>)</span><br /> + Write a single byte to the stream, without any formatting.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_bytes" class="summary-sig-name">add_bytes</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">b</span>)</span><br /> + Write bytes to the stream, without any formatting.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_int" class="summary-sig-name">add_int</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">n</span>)</span><br /> + Add an integer to the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_int64" class="summary-sig-name">add_int64</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">n</span>)</span><br /> + Add a 64-bit int to the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_list" class="summary-sig-name">add_list</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">l</span>)</span><br /> + Add a list of strings to the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_mpint" class="summary-sig-name">add_mpint</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">z</span>)</span><br /> + Add a long int to the stream, encoded as an infinite-precision + integer.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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="paramiko.Message-class.html#add_string" class="summary-sig-name">add_string</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">s</span>)</span><br /> + Add a string to the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">bool</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_boolean" class="summary-sig-name">get_boolean</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Fetch a boolean from the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_byte" class="summary-sig-name">get_byte</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Return the next byte of the Message, without decomposing it.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_bytes" class="summary-sig-name">get_bytes</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">n</span>)</span><br /> + Return the next <code>n</code> bytes of the Message, without + decomposing into an int, string, etc.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">int</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_int" class="summary-sig-name">get_int</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Fetch an int from the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">long</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_int64" class="summary-sig-name">get_int64</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Fetch a 64-bit int from the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">list of strings</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_list" class="summary-sig-name">get_list</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Fetch a list of strings from the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">long</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_mpint" class="summary-sig-name">get_mpint</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Fetch a long int (mpint) from the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_remainder" class="summary-sig-name">get_remainder</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Return the bytes of this Message that haven't already been parsed and + returned.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_so_far" class="summary-sig-name">get_so_far</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns the bytes of this Message that have been parsed and returned.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type">string</span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="paramiko.Message-class.html#get_string" class="summary-sig-name">get_string</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Fetch a string from the stream.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">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 name="rewind"></a><span class="summary-sig-name">rewind</span>(<span class="summary-sig-arg">self</span>)</span><br /> + Rewind the message to the beginning as if no items had been parsed + out of it yet.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__setattr__</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>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">content</span>=<span class="sig-default">None</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Create a new SSH2 Message.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>content</code></strong> (string) - the byte stream to use as the Message content (passed in only + when decomposing a Message).</li> + </ul></dd> + <dt>Overrides: + object.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="__repr__"></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">__repr__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Returns a string representation of this object, for debugging.</p> + <dl class="fields"> + <dt>Returns: string</dt> + <dt>Overrides: + object.__repr__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span> + <br /><em class="fname">(Informal representation operator)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Return the byte stream content of this Message, as a string.</p> + <dl class="fields"> + <dt>Returns: string</dt> + <dd>the contents of this Message.</dd> + <dt>Overrides: + object.__str__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="add"></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">add</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">*seq</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Add a sequence of items to the stream. The values are encoded based + on their type: str, int, bool, list, or long.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>seq</code></strong> (sequence) - the sequence of items</li> + </ul></dd> + </dl> +<div class="fields"> <p><strong>Bug:</strong> + longs are encoded non-deterministically. Don't use this method. + </p> +</div></td></tr></table> +</div> +<a name="add_boolean"></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">add_boolean</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">b</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Add a boolean value to the stream.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>b</code></strong> (bool) - boolean value to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_byte"></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">add_byte</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">b</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Write a single byte to the stream, without any formatting.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>b</code></strong> (str) - byte to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_bytes"></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">add_bytes</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">b</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Write bytes to the stream, without any formatting.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>b</code></strong> (str) - bytes to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_int"></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">add_int</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">n</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Add an integer to the stream.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>n</code></strong> (int) - integer to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_int64"></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">add_int64</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">n</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Add a 64-bit int to the stream.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>n</code></strong> (long) - long int to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_list"></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">add_list</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">l</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>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.)</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>l</code></strong> (list(str)) - list of strings to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_mpint"></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">add_mpint</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">z</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Add a long int to the stream, encoded as an infinite-precision + integer. This method only works on positive numbers.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>z</code></strong> (long) - long int to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_string"></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">add_string</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">s</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Add a string to the stream.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>s</code></strong> (str) - string to add</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="get_boolean"></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">get_boolean</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Fetch a boolean from the stream.</p> + <dl class="fields"> + <dt>Returns: bool</dt> + <dd><code>True</code> or <code>False</code> (from the Message).</dd> + </dl> +</td></tr></table> +</div> +<a name="get_byte"></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">get_byte</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Return the next byte of the Message, without decomposing it. This is + equivalent to <a href="paramiko.Message-class.html#get_bytes" + class="link">get_bytes(1)</a>.</p> + <dl class="fields"> + <dt>Returns: string</dt> + <dd>the next byte of the Message, or <code>' + any bytes remaining.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_bytes"></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">get_bytes</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">n</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Return the next <code>n</code> bytes of the Message, without + decomposing into an int, string, etc. Just the raw bytes are + returned.</p> + <dl class="fields"> + <dt>Returns: string</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.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_int"></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">get_int</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Fetch an int from the stream.</p> + <dl class="fields"> + <dt>Returns: int</dt> + <dd>a 32-bit unsigned integer.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_int64"></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">get_int64</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Fetch a 64-bit int from the stream.</p> + <dl class="fields"> + <dt>Returns: long</dt> + <dd>a 64-bit unsigned integer.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_list"></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">get_list</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Fetch a list of strings from the stream. These are trivially encoded + as comma-separated values in a string.</p> + <dl class="fields"> + <dt>Returns: list of strings</dt> + <dd>a list of strings.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_mpint"></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">get_mpint</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Fetch a long int (mpint) from the stream.</p> + <dl class="fields"> + <dt>Returns: long</dt> + <dd>an arbitrary-length integer.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_remainder"></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">get_remainder</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>Return the bytes of this Message that haven't already been parsed and + returned.</p> + <dl class="fields"> + <dt>Returns: string</dt> + <dd>a string of the bytes not parsed yet.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_so_far"></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">get_so_far</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>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">get_remainder</a>.</p> + <dl class="fields"> + <dt>Returns: string</dt> + <dd>a string of the bytes parsed so far.</dd> + </dl> +</td></tr></table> +</div> +<a name="get_string"></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">get_string</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="paramiko.message-pysrc.html">source code</a></span> + </td> + </tr></table> + + <p>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.)</p> + <dl class="fields"> + <dt>Returns: string</dt> + <dd>a string.</dd> + </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="paramiko-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> + + <th class="navbar" width="100%"></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 Sun Jul 6 18:30:28 2008 + </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> |