File: //usr/share/doc/python27-paramiko-1.15.1/docs/api/message.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Message — Paramiko documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Paramiko documentation" href="../index.html" />
<link rel="next" title="Packetizer" href="packet.html" />
<link rel="prev" title="Client" href="client.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="packet.html" title="Packetizer"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="client.html" title="Client"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Paramiko documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-paramiko.message">
<span id="message"></span><h1>Message<a class="headerlink" href="#module-paramiko.message" title="Permalink to this headline">¶</a></h1>
<p>Implementation of an SSH2 “message”.</p>
<dl class="class">
<dt id="paramiko.message.Message">
<em class="property">class </em><tt class="descclassname">paramiko.message.</tt><tt class="descname">Message</tt><big>(</big><em>content=None</em><big>)</big><a class="headerlink" href="#paramiko.message.Message" title="Permalink to this definition">¶</a></dt>
<dd><p>An SSH2 message is a stream of bytes that encodes some combination of
strings, integers, bools, and infinite-precision integers (known in Python
as longs). 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>
<dl class="method">
<dt id="paramiko.message.Message.__init__">
<tt class="descname">__init__</tt><big>(</big><em>content=None</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new SSH2 message.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>content</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><em>str</em></a>) – the byte stream to use as the message content (passed in only when
decomposing a message).</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.__repr__">
<tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.__repr__" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a string representation of this object, for debugging.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.__str__">
<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.__str__" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the byte stream content of this message, as a string/bytes obj.</p>
</dd></dl>
<dl class="attribute">
<dt id="paramiko.message.Message.__weakref__">
<tt class="descname">__weakref__</tt><a class="headerlink" href="#paramiko.message.Message.__weakref__" title="Permalink to this definition">¶</a></dt>
<dd><p>list of weak references to the object (if defined)</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add">
<tt class="descname">add</tt><big>(</big><em>*seq</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a sequence of items to the stream. The values are encoded based
on their type: str, int, bool, list, or long.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Longs are encoded non-deterministically. Don’t use this method.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>seq</strong> – the sequence of items</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_boolean">
<tt class="descname">add_boolean</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_boolean" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a boolean value to the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>b</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#bool" title="(in Python v2.6)"><em>bool</em></a>) – boolean value to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_byte">
<tt class="descname">add_byte</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_byte" title="Permalink to this definition">¶</a></dt>
<dd><p>Write a single byte to the stream, without any formatting.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>b</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><em>str</em></a>) – byte to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_bytes">
<tt class="descname">add_bytes</tt><big>(</big><em>b</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_bytes" title="Permalink to this definition">¶</a></dt>
<dd><p>Write bytes to the stream, without any formatting.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>b</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><em>str</em></a>) – bytes to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_int">
<tt class="descname">add_int</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_int" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an integer to the stream.</p>
<p>@param n: integer to add
@type n: int</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_int64">
<tt class="descname">add_int64</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_int64" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a 64-bit int to the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#long" title="(in Python v2.6)"><em>long</em></a>) – long int to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_list">
<tt class="descname">add_list</tt><big>(</big><em>l</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_list" title="Permalink to this definition">¶</a></dt>
<dd><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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>l</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#list" title="(in Python v2.6)"><em>list</em></a>) – list of strings to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_mpint">
<tt class="descname">add_mpint</tt><big>(</big><em>z</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_mpint" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a long int to the stream, encoded as an infinite-precision
integer. This method only works on positive numbers.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>z</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#long" title="(in Python v2.6)"><em>long</em></a>) – long int to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_size">
<tt class="descname">add_size</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an integer to the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>n</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#int" title="(in Python v2.6)"><em>int</em></a>) – integer to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.add_string">
<tt class="descname">add_string</tt><big>(</big><em>s</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.add_string" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a string to the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>s</strong> (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><em>str</em></a>) – string to add</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.asbytes">
<tt class="descname">asbytes</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.asbytes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the byte stream content of this Message, as bytes.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_binary">
<tt class="descname">get_binary</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_binary" title="Permalink to this definition">¶</a></dt>
<dd><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>
<p>@return: a string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_boolean">
<tt class="descname">get_boolean</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_boolean" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch a boolean from the stream.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_byte">
<tt class="descname">get_byte</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_byte" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the next byte of the message, without decomposing it. This
is equivalent to <a class="reference internal" href="#paramiko.message.Message.get_bytes" title="paramiko.message.Message.get_bytes"><tt class="xref py py-obj docutils literal"><span class="pre">get_bytes(1)</span></tt></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the next (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt></a>) byte of the message, or <tt class="docutils literal"><span class="pre">'\'</span></tt> if there aren’t
any bytes remaining.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_bytes">
<tt class="descname">get_bytes</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_bytes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the next <tt class="docutils literal"><span class="pre">n</span></tt> bytes of the message (as a <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt></a>), without
decomposing into an int, decoded string, etc. Just the raw bytes are
returned. Returns a string of <tt class="docutils literal"><span class="pre">n</span></tt> zero bytes if there weren’t <tt class="docutils literal"><span class="pre">n</span></tt>
bytes remaining in the message.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_int">
<tt class="descname">get_int</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_int" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch an int from the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a 32-bit unsigned <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#int" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">int</span></tt></a>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_int64">
<tt class="descname">get_int64</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_int64" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch a 64-bit int from the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a 64-bit unsigned integer (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#long" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">long</span></tt></a>).</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_list">
<tt class="descname">get_list</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch a <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#list" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">list</span></tt></a> of <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">strings</span></tt></a> from the stream.</p>
<p>These are trivially encoded as comma-separated values in a string.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_mpint">
<tt class="descname">get_mpint</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_mpint" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch a long int (mpint) from the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">an arbitrary-length integer (<a class="reference external" href="http://docs.python.org/2.6/library/functions.html#long" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">long</span></tt></a>).</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_remainder">
<tt class="descname">get_remainder</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_remainder" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bytes (as a <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt></a>) of this message that haven’t already been
parsed and returned.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_size">
<tt class="descname">get_size</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch an int from the stream.</p>
<p>@return: a 32-bit unsigned integer.
@rtype: int</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_so_far">
<tt class="descname">get_so_far</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_so_far" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt></a> bytes of this message that have been parsed and
returned. The string passed into a message’s constructor can be
regenerated by concatenating <tt class="docutils literal"><span class="pre">get_so_far</span></tt> and <a class="reference internal" href="#paramiko.message.Message.get_remainder" title="paramiko.message.Message.get_remainder"><tt class="xref py py-obj docutils literal"><span class="pre">get_remainder</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_string">
<tt class="descname">get_string</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_string" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetch a <a class="reference external" href="http://docs.python.org/2.6/library/functions.html#str" title="(in Python v2.6)"><tt class="xref py py-obj docutils literal"><span class="pre">str</span></tt></a> 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>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.get_text">
<tt class="descname">get_text</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.get_text" title="Permalink to this definition">¶</a></dt>
<dd><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>
<p>@return: a string.
@rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="paramiko.message.Message.rewind">
<tt class="descname">rewind</tt><big>(</big><big>)</big><a class="headerlink" href="#paramiko.message.Message.rewind" title="Permalink to this definition">¶</a></dt>
<dd><p>Rewind the message to the beginning as if no items had been parsed
out of it yet.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Paramiko</a></h1>
<p class="blurb">A Python implementation of SSHv2.</p>
<p>
<iframe src="http://ghbtns.com/github-btn.html?user=paramiko&repo=paramiko&type=watch&count=true&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>
<p>
<a href="https://travis-ci.org/paramiko/paramiko">
<img
alt="https://secure.travis-ci.org/paramiko/paramiko.png?branch=master"
src="https://secure.travis-ci.org/paramiko/paramiko.png?branch=master"
>
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="channel.html">Channel</a></li>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Message</a></li>
<li class="toctree-l1"><a class="reference internal" href="packet.html">Packetizer</a></li>
<li class="toctree-l1"><a class="reference internal" href="transport.html">Transport</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="agent.html">SSH agents</a></li>
<li class="toctree-l1"><a class="reference internal" href="hostkeys.html">Host keys / <tt class="docutils literal"><span class="pre">known_hosts</span></tt> files</a></li>
<li class="toctree-l1"><a class="reference internal" href="keys.html">Key handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_gss.html">GSS-API authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="kex_gss.html">GSS-API key exchange</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.html"><tt class="docutils literal"><span class="pre">ProxyCommand</span></tt> support</a></li>
<li class="toctree-l1"><a class="reference internal" href="server.html">Server implementation</a></li>
<li class="toctree-l1"><a class="reference internal" href="sftp.html">SFTP</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="buffered_pipe.html">Buffered pipes</a></li>
<li class="toctree-l1"><a class="reference internal" href="file.html">Buffered files</a></li>
<li class="toctree-l1"><a class="reference internal" href="pipe.html">Cross-platform pipe implementations</a></li>
<li class="toctree-l1"><a class="reference internal" href="ssh_exception.html">Exceptions</a></li>
</ul>
<hr />
<ul>
<li class="toctree-l1"><a href="http://www.paramiko.org">Main website</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3>Donate</h3>
<p>
Consider supporting the authors on <a href="https://www.gratipay.com/">Gratipay</a>:
<script data-gratipay-username="bitprophet"
data-gratipay-widget="button"
src="//gttp.co/v1.js"></script>
</p>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2014 Jeff Forcier.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.2.2</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.6.1</a>
|
<a href="../_sources/api/message.txt"
rel="nofollow">Page source</a></li>
</div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18486793-2']);
_gaq.push(['_setDomainName', 'none']);
_gaq.push(['_setAllowLinker', true]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>