<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: FilterPutSpaceHelper Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crypto++
 <span id="projectnumber">7.0</span>
</div>
<div id="projectbrief">Free C++ class library of cryptographic schemes</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="struct_filter_put_space_helper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FilterPutSpaceHelper Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>.
<a href="struct_filter_put_space_helper.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for FilterPutSpaceHelper:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="struct_filter_put_space_helper.png" usemap="#FilterPutSpaceHelper_map" alt=""/>
<map id="FilterPutSpaceHelper_map" name="FilterPutSpaceHelper_map">
<area href="class_file_store.html" title="Implementation of Store interface. " alt="FileStore" shape="rect" coords="0,56,179,80"/>
<area href="class_hash_filter.html" title="Filter wrapper for HashTransformation. " alt="HashFilter" shape="rect" coords="189,56,368,80"/>
<area href="class_stream_transformation_filter.html" title="Filter wrapper for StreamTransformation. " alt="StreamTransformationFilter" shape="rect" coords="378,56,557,80"/>
<area href="class_authenticated_encryption_filter.html" title="Filter wrapper for encrypting with AuthenticatedSymmetricCipher. " alt="AuthenticatedEncryptionFilter" shape="rect" coords="378,112,557,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a85fea9f0455741e4b340a3e035df9a39"><td class="memItemLeft" align="right" valign="top">byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39">HelpCreatePutSpace</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)</td></tr>
<tr class="memdesc:a85fea9f0455741e4b340a3e035df9a39"><td class="mdescLeft"> </td><td class="mdescRight">Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. <a href="#a85fea9f0455741e4b340a3e035df9a39">More...</a><br /></td></tr>
<tr class="separator:a85fea9f0455741e4b340a3e035df9a39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01f7232d4f27bc0c0a20115aa5090924"><td class="memItemLeft" align="right" valign="top">byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_filter_put_space_helper.html#a01f7232d4f27bc0c0a20115aa5090924">HelpCreatePutSpace</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, size_t minSize)</td></tr>
<tr class="memdesc:a01f7232d4f27bc0c0a20115aa5090924"><td class="mdescLeft"> </td><td class="mdescRight">Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. <a href="#a01f7232d4f27bc0c0a20115aa5090924">More...</a><br /></td></tr>
<tr class="separator:a01f7232d4f27bc0c0a20115aa5090924"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6549687729073e4900e0867f59c0f4f"><td class="memItemLeft" align="right" valign="top">byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_filter_put_space_helper.html#aa6549687729073e4900e0867f59c0f4f">HelpCreatePutSpace</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, size_t minSize, size_t bufferSize)</td></tr>
<tr class="memdesc:aa6549687729073e4900e0867f59c0f4f"><td class="mdescLeft"> </td><td class="mdescRight">Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. <a href="#aa6549687729073e4900e0867f59c0f4f">More...</a><br /></td></tr>
<tr class="separator:aa6549687729073e4900e0867f59c0f4f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac50ca63d7b1a529a32e8596aa44df9c4"><td class="memItemLeft" align="right" valign="top"><a id="ac50ca63d7b1a529a32e8596aa44df9c4"></a>
<a class="el" href="class_sec_byte_block.html">SecByteBlock</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_filter_put_space_helper.html#ac50ca63d7b1a529a32e8596aa44df9c4">m_tempSpace</a></td></tr>
<tr class="memdesc:ac50ca63d7b1a529a32e8596aa44df9c4"><td class="mdescLeft"> </td><td class="mdescRight">Temporay working space. <br /></td></tr>
<tr class="separator:ac50ca63d7b1a529a32e8596aa44df9c4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. </p>
<p class="definition">Definition at line <a class="el" href="filters_8h_source.html#l00158">158</a> of file <a class="el" href="filters_8h_source.html">filters.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a85fea9f0455741e4b340a3e035df9a39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85fea9f0455741e4b340a3e035df9a39">◆ </a></span>HelpCreatePutSpace() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte* FilterPutSpaceHelper::HelpCreatePutSpace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>minSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>desiredSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"><em>bufferSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td><a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a> for the working space </td></tr>
<tr><td class="paramname">channel</td><td>channel for the working space </td></tr>
<tr><td class="paramname">minSize</td><td>minimum size of the allocation, in bytes </td></tr>
<tr><td class="paramname">desiredSize</td><td>preferred size of the allocation, in bytes </td></tr>
<tr><td class="paramname">bufferSize</td><td>actual size of the allocation, in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section pre"><dt>Precondition</dt><dd><code>desiredSize >= minSize</code> and <code>bufferSize >= minSize</code>.</dd></dl>
<p><code>bufferSize</code> is an IN and OUT parameter. If <a class="el" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39" title="Create a working space in a BufferedTransformation. ">HelpCreatePutSpace()</a> returns a non-NULL value, then bufferSize is valid and provides the size of the working space created for the caller.</p>
<p>Internally, <a class="el" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39" title="Create a working space in a BufferedTransformation. ">HelpCreatePutSpace()</a> calls <a class="el" href="class_buffered_transformation.html#a877494d8de597af935cb770034f7f170">ChannelCreatePutSpace()</a> using <code>desiredSize</code>. If the target returns <code>desiredSize</code> with a size less than <code>minSize</code> (i.e., the request could not be fulfilled), then an internal <a class="el" href="class_sec_byte_block.html" title="SecBlock<byte> typedef. ">SecByteBlock</a> called <code>m_tempSpace</code> is resized and used for the caller. </p>
<p class="definition">Definition at line <a class="el" href="filters_8h_source.html#l00175">175</a> of file <a class="el" href="filters_8h_source.html">filters.h</a>.</p>
</div>
</div>
<a id="a01f7232d4f27bc0c0a20115aa5090924"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01f7232d4f27bc0c0a20115aa5090924">◆ </a></span>HelpCreatePutSpace() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte* FilterPutSpaceHelper::HelpCreatePutSpace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>minSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>the <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a> for the working space </td></tr>
<tr><td class="paramname">channel</td><td>channel for the working space </td></tr>
<tr><td class="paramname">minSize</td><td>minimum size of the allocation, in bytes</td></tr>
</table>
</dd>
</dl>
<p>Internally, the overload calls <a class="el" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39" title="Create a working space in a BufferedTransformation. ">HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)</a> using <code>minSize</code> for missing arguments. </p>
<p class="definition">Definition at line <a class="el" href="filters_8h_source.html#l00198">198</a> of file <a class="el" href="filters_8h_source.html">filters.h</a>.</p>
</div>
</div>
<a id="aa6549687729073e4900e0867f59c0f4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6549687729073e4900e0867f59c0f4f">◆ </a></span>HelpCreatePutSpace() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte* FilterPutSpaceHelper::HelpCreatePutSpace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>minSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufferSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a working space in a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>the <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations. ">BufferedTransformation</a> for the working space </td></tr>
<tr><td class="paramname">channel</td><td>channel for the working space </td></tr>
<tr><td class="paramname">minSize</td><td>minimum size of the allocation, in bytes </td></tr>
<tr><td class="paramname">bufferSize</td><td>the actual size of the allocation, in bytes</td></tr>
</table>
</dd>
</dl>
<p>Internally, the overload calls <a class="el" href="struct_filter_put_space_helper.html#a85fea9f0455741e4b340a3e035df9a39" title="Create a working space in a BufferedTransformation. ">HelpCreatePutSpace(BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)</a> using <code>minSize</code> for missing arguments. </p>
<p class="definition">Definition at line <a class="el" href="filters_8h_source.html#l00207">207</a> of file <a class="el" href="filters_8h_source.html">filters.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="filters_8h_source.html">filters.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 16 2018 07:58:34 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0a67b807a02637f2cae68649d519a89d
>
files
>
2879
