Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
360core
Repository URL to install this package:
|
Version:
0.3.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>xmlsec.Buffer</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="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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="xmlsec-module.html">Module xmlsec</a> ::
Class Buffer
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="xmlsec.Buffer-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Buffer</h2>
<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="xmlsec.Buffer-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>size</span>,
<span class=summary-sig-arg>_obj</span>)</span></code>
<br />
Creates and initalizes new memory buffer with given size.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getattr__"></a><span class="summary-sig"><span class="summary-sig-name">__getattr__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__setattr__"></a><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>value</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="xmlsec.Buffer-class.html#append" class="summary-sig-name"><code>append</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Appends the data after the current data stored in the buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#base64NodeContentRead" class="summary-sig-name"><code>base64NodeContentRead</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>)</span></code>
<br />
Reads the content of the node, base64 decodes it and stores the result
in the buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#base64NodeContentWrite" class="summary-sig-name"><code>base64NodeContentWrite</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>,
<span class=summary-sig-arg>columns</span>)</span></code>
<br />
Sets the content of the node to the base64 encoded buffer data.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#createOutputBuffer" class="summary-sig-name"><code>createOutputBuffer</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Creates new LibXML output buffer to store data in the buf.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#destroy" class="summary-sig-name"><code>destroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Destroys buffer object.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#empty" class="summary-sig-name"><code>empty</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Empties the buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#finalize" class="summary-sig-name"><code>finalize</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Frees allocated resource for a buffer intialized with initialize method.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#getData" class="summary-sig-name"><code>getData</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets buffer's data.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#getMaxSize" class="summary-sig-name"><code>getMaxSize</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets the maximum (allocated) buffer size.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#getSize" class="summary-sig-name"><code>getSize</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gets the current buffer data size.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#initialize" class="summary-sig-name"><code>initialize</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Initializes buffer object buf.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#prepend" class="summary-sig-name"><code>prepend</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Prepends the data before the current data stored in the buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#readFile" class="summary-sig-name"><code>readFile</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>filename</span>)</span></code>
<br />
Reads the content of the file filename in the buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#removeHead" class="summary-sig-name"><code>removeHead</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Removes size bytes from the beginning of the current buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#removeTail" class="summary-sig-name"><code>removeTail</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Removes size bytes from the end of current buffer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#setData" class="summary-sig-name"><code>setData</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Sets the value of the buffer to data.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#setMaxSize" class="summary-sig-name"><code>setMaxSize</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Sets new buffer maximum size.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.Buffer-class.html#setSize" class="summary-sig-name"><code>setSize</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>size</span>)</span></code>
<br />
Sets new buffer data size.</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>size</span>=<span class=sig-default>None</span>,
<span class=sig-arg>_obj</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<pre class="literalblock">
Creates and initalizes new memory buffer with given size. Caller is
responsible for calling destroy method to free the buffer.
size : the initial buffer size.
Returns : the buffer or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="append"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">append</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Appends the data after the current data stored in the buffer.
data : the data.
size : the data size.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="base64NodeContentRead"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">base64NodeContentRead</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>node</span>)</span>
</h3>
<pre class="literalblock">
Reads the content of the node, base64 decodes it and stores the result
in the buffer.
node : the node.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="base64NodeContentWrite"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">base64NodeContentWrite</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>node</span>,
<span class=sig-arg>columns</span>)</span>
</h3>
<pre class="literalblock">
Sets the content of the node to the base64 encoded buffer data.
node : the node.
columns : the max line size for base64 encoded data.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="createOutputBuffer"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">createOutputBuffer</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Creates new LibXML output buffer to store data in the buf. Caller is
responsible for destroying buf when processing is done.
Returns : newly allocated output buffer or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="destroy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">destroy</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Destroys buffer object.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="empty"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">empty</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Empties the buffer.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="finalize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">finalize</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Frees allocated resource for a buffer intialized with initialize method.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getData</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Gets buffer's data.
Returns : buffer's data.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getMaxSize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getMaxSize</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Gets the maximum (allocated) buffer size.
Returns : the maximum (allocated) buffer size.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getSize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSize</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Gets the current buffer data size.
Returns : the current data size.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="initialize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">initialize</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Initializes buffer object buf. Caller is responsible for calling
finalize method to free allocated resources.
size : the initial buffer size.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="prepend"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">prepend</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Prepends the data before the current data stored in the buffer.
data : the data.
size : the data size.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="readFile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">readFile</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>filename</span>)</span>
</h3>
<pre class="literalblock">
Reads the content of the file filename in the buffer.
filename : the filename.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeHead"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeHead</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Removes size bytes from the beginning of the current buffer.
size : the number of bytes to be removed.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeTail"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeTail</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Removes size bytes from the end of current buffer.
size : the number of bytes to be removed.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setData"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setData</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Sets the value of the buffer to data.
data : the data.
size : the data size.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setMaxSize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setMaxSize</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Sets new buffer maximum size. If necessary, buffer grows to have at
least size bytes.
size : the new maximum size.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setSize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setSize</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>size</span>)</span>
</h3>
<pre class="literalblock">
Sets new buffer data size. If necessary, buffer grows to have at least
size bytes.
size : the new data size.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<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="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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
</p></th></tr></table>
</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 Jan 1 18:42:41 2006</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>