<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crypto++: Multichannel< T > Class Template 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.15 -->
<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="class_multichannel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Multichannel< T > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Multiple channels support for custom signal processing.
<a href="class_multichannel.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 Multichannel< T >:</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="class_multichannel.png" usemap="#Multichannel_3C_20T_20_3E_map" alt=""/>
<map id="Multichannel_3C_20T_20_3E_map" name="Multichannel_3C_20T_20_3E_map">
<area href="class_custom_flush_propagation.html" title="Interface for custom flush signals propagation." alt="CustomFlushPropagation< T >" shape="rect" coords="0,56,183,80"/>
</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:ae3e6176eb5f0de2857aa7066272c07ce"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_multichannel.html#ae3e6176eb5f0de2857aa7066272c07ce">Flush</a> (bool hardFlush, int propagation=-1, bool blocking=true)</td></tr>
<tr class="memdesc:ae3e6176eb5f0de2857aa7066272c07ce"><td class="mdescLeft"> </td><td class="mdescRight">Flush buffered input and/or output, with signal propagation. <a href="#ae3e6176eb5f0de2857aa7066272c07ce">More...</a><br /></td></tr>
<tr class="separator:ae3e6176eb5f0de2857aa7066272c07ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18b9b1cc4e6d2649214c62e447052db9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_multichannel.html#a18b9b1cc4e6d2649214c62e447052db9">MessageSeriesEnd</a> (int propagation=-1, bool blocking=true)</td></tr>
<tr class="memdesc:a18b9b1cc4e6d2649214c62e447052db9"><td class="mdescLeft"> </td><td class="mdescRight">Marks the end of a series of messages, with signal propagation. <a href="#a18b9b1cc4e6d2649214c62e447052db9">More...</a><br /></td></tr>
<tr class="separator:a18b9b1cc4e6d2649214c62e447052db9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0b0eb15ec27d19c93a1455d948c578e"><td class="memItemLeft" align="right" valign="top">byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_multichannel.html#af0b0eb15ec27d19c93a1455d948c578e">CreatePutSpace</a> (size_t &size)</td></tr>
<tr class="memdesc:af0b0eb15ec27d19c93a1455d948c578e"><td class="mdescLeft"> </td><td class="mdescRight">Request space which can be written into by the caller. <a href="#af0b0eb15ec27d19c93a1455d948c578e">More...</a><br /></td></tr>
<tr class="separator:af0b0eb15ec27d19c93a1455d948c578e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e8ff874d5703311a9947cf086170fa6"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_multichannel.html#a5e8ff874d5703311a9947cf086170fa6">Put2</a> (const byte *inString, size_t length, int messageEnd, bool blocking)</td></tr>
<tr class="memdesc:a5e8ff874d5703311a9947cf086170fa6"><td class="mdescLeft"> </td><td class="mdescRight">Input multiple bytes for processing. <a href="#a5e8ff874d5703311a9947cf086170fa6">More...</a><br /></td></tr>
<tr class="separator:a5e8ff874d5703311a9947cf086170fa6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5a9ac9bf82eb7f4eadc7c38fd604216"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_multichannel.html#ae5a9ac9bf82eb7f4eadc7c38fd604216">PutModifiable2</a> (byte *inString, size_t length, int messageEnd, bool blocking)</td></tr>
<tr class="memdesc:ae5a9ac9bf82eb7f4eadc7c38fd604216"><td class="mdescLeft"> </td><td class="mdescRight">Input multiple bytes that may be modified by callee. <a href="#ae5a9ac9bf82eb7f4eadc7c38fd604216">More...</a><br /></td></tr>
<tr class="separator:ae5a9ac9bf82eb7f4eadc7c38fd604216"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affb7c3b2dd7a2e35159e71baa9d05b62"><td class="memItemLeft" align="right" valign="top"><a id="affb7c3b2dd7a2e35159e71baa9d05b62"></a>
byte * </td><td class="memItemRight" valign="bottom"><b>ChannelCreatePutSpace</b> (const std::string &channel, size_t &size)</td></tr>
<tr class="separator:affb7c3b2dd7a2e35159e71baa9d05b62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4eca1a866eabc6edf8c28835dc11ff7"><td class="memItemLeft" align="right" valign="top"><a id="ae4eca1a866eabc6edf8c28835dc11ff7"></a>
bool </td><td class="memItemRight" valign="bottom"><b>ChannelPutModifiable</b> (const std::string &channel, byte *inString, size_t length)</td></tr>
<tr class="separator:ae4eca1a866eabc6edf8c28835dc11ff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9114c3d0c92af6a9045cd3a39ffb0640"><td class="memItemLeft" align="right" valign="top"><a id="a9114c3d0c92af6a9045cd3a39ffb0640"></a>
virtual size_t </td><td class="memItemRight" valign="bottom"><b>ChannelPut2</b> (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)=0</td></tr>
<tr class="separator:a9114c3d0c92af6a9045cd3a39ffb0640"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35049ced3a11aeb890f3f899d11e6daa"><td class="memItemLeft" align="right" valign="top"><a id="a35049ced3a11aeb890f3f899d11e6daa"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>ChannelPutModifiable2</b> (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)</td></tr>
<tr class="separator:a35049ced3a11aeb890f3f899d11e6daa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c53a21bbe65eacabdc627c8106701bb"><td class="memItemLeft" align="right" valign="top"><a id="a0c53a21bbe65eacabdc627c8106701bb"></a>
virtual bool </td><td class="memItemRight" valign="bottom"><b>ChannelFlush</b> (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)=0</td></tr>
<tr class="separator:a0c53a21bbe65eacabdc627c8106701bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">SIGNALS</div></td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class T><br />
class Multichannel< T ></h3>
<p>Multiple channels support for custom signal processing. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>the class or type</td></tr>
</table>
</dd>
</dl>
<p>T should be a <a class="el" href="class_buffered_transformation.html" title="Interface for buffered transformations.">BufferedTransformation</a> derived class </p>
<p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00225">225</a> of file <a class="el" href="simple_8h_source.html">simple.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae3e6176eb5f0de2857aa7066272c07ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3e6176eb5f0de2857aa7066272c07ce">◆ </a></span>Flush()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_multichannel.html">Multichannel</a>< T >::Flush </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hardFlush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>propagation</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>blocking</em> = <code>true</code> </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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush buffered input and/or output, with signal propagation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hardFlush</td><td>is used to indicate whether all data should be flushed </td></tr>
<tr><td class="paramname">propagation</td><td>the number of attached transformations the <a class="el" href="class_multichannel.html#ae3e6176eb5f0de2857aa7066272c07ce" title="Flush buffered input and/or output, with signal propagation.">Flush()</a> signal should be passed </td></tr>
<tr><td class="paramname">blocking</td><td>specifies whether the object should block when processing input</td></tr>
</table>
</dd>
</dl>
<p>propagation count includes this object. Setting propagation to <code>1</code> means this object only. Setting propagation to <code>-1</code> means unlimited propagation. </p><dl class="section note"><dt>Note</dt><dd>Hard flushes must be used with care. It means try to process and output everything, even if there may not be enough data to complete the action. For example, hard flushing a <a class="el" href="class_hex_decoder.html" title="Decode base 16 data back to bytes.">HexDecoder</a> would cause an error if you do it after inputing an odd number of hex encoded characters. </dd>
<dd>
For some types of filters, like <a class="el" href="class_zlib_decompressor.html" title="ZLIB Decompressor (RFC 1950)">ZlibDecompressor</a>, hard flushes can only be done at "synchronization points". These synchronization points are positions in the data stream that are created by hard flushes on the corresponding reverse filters, in this example <a class="el" href="class_zlib_compressor.html" title="ZLIB Compressor (RFC 1950)">ZlibCompressor</a>. This is useful when zlib compressed data is moved across a network in packets and compression state is preserved across packets, as in the SSH2 protocol. </dd></dl>
<p>Implements <a class="el" href="class_custom_flush_propagation.html#ac0faa3bd64279e9ad1912cdcdff446ef">CustomFlushPropagation< T ></a>.</p>
<p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00228">228</a> of file <a class="el" href="simple_8h_source.html">simple.h</a>.</p>
</div>
</div>
<a id="a18b9b1cc4e6d2649214c62e447052db9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18b9b1cc4e6d2649214c62e447052db9">◆ </a></span>MessageSeriesEnd()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_multichannel.html">Multichannel</a>< T >::MessageSeriesEnd </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>propagation</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>blocking</em> = <code>true</code> </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>Marks the end of a series of messages, with signal propagation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">propagation</td><td>the number of attached transformations the <a class="el" href="class_multichannel.html#a18b9b1cc4e6d2649214c62e447052db9" title="Marks the end of a series of messages, with signal propagation.">MessageSeriesEnd()</a> signal should be passed </td></tr>
<tr><td class="paramname">blocking</td><td>specifies whether the object should block when processing input</td></tr>
</table>
</dd>
</dl>
<p>Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.</p>
<p>propagation count includes this object. Setting propagation to <code>1</code> means this object only. Setting propagation to <code>-1</code> means unlimited propagation. </p><dl class="section note"><dt>Note</dt><dd>There should be a MessageEnd() immediately before <a class="el" href="class_multichannel.html#a18b9b1cc4e6d2649214c62e447052db9" title="Marks the end of a series of messages, with signal propagation.">MessageSeriesEnd()</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00239">239</a> of file <a class="el" href="simple_8h_source.html">simple.h</a>.</p>
</div>
</div>
<a id="af0b0eb15ec27d19c93a1455d948c578e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0b0eb15ec27d19c93a1455d948c578e">◆ </a></span>CreatePutSpace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte* <a class="el" href="class_multichannel.html">Multichannel</a>< T >::CreatePutSpace </td>
<td>(</td>
<td class="paramtype">size_t & </td>
<td class="paramname"><em>size</em></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>Request space which can be written into by the caller. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>the requested size of the buffer</td></tr>
</table>
</dd>
</dl>
<p>The purpose of this method is to help avoid extra memory allocations.</p>
<p>size is an <em>IN</em> and <em>OUT</em> parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.</p>
<p>The base class implementation sets size to 0 and returns NULL. </p><dl class="section note"><dt>Note</dt><dd>Some objects, like <a class="el" href="class_array_sink.html" title="Copy input to a memory buffer.">ArraySink</a>, cannot create a space because its fixed. In the case of an <a class="el" href="class_array_sink.html" title="Copy input to a memory buffer.">ArraySink</a>, the pointer to the array is returned and the size is remaining size. </dd></dl>
<p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00251">251</a> of file <a class="el" href="simple_8h_source.html">simple.h</a>.</p>
</div>
</div>
<a id="a5e8ff874d5703311a9947cf086170fa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e8ff874d5703311a9947cf086170fa6">◆ </a></span>Put2()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="class_multichannel.html">Multichannel</a>< T >::Put2 </td>
<td>(</td>
<td class="paramtype">const byte * </td>
<td class="paramname"><em>inString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>messageEnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>blocking</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>Input multiple bytes for processing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inString</td><td>the byte buffer to process </td></tr>
<tr><td class="paramname">length</td><td>the size of the string, in bytes </td></tr>
<tr><td class="paramname">messageEnd</td><td>means how many filters to signal MessageEnd() to, including this one </td></tr>
<tr><td class="paramname">blocking</td><td>specifies whether the object should block when processing input</td></tr>
</table>
</dd>
</dl>
<p>Derived classes must implement <a class="el" href="class_multichannel.html#a5e8ff874d5703311a9947cf086170fa6" title="Input multiple bytes for processing.">Put2()</a>. </p>
<p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00260">260</a> of file <a class="el" href="simple_8h_source.html">simple.h</a>.</p>
</div>
</div>
<a id="ae5a9ac9bf82eb7f4eadc7c38fd604216"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5a9ac9bf82eb7f4eadc7c38fd604216">◆ </a></span>PutModifiable2()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="class_multichannel.html">Multichannel</a>< T >::PutModifiable2 </td>
<td>(</td>
<td class="paramtype">byte * </td>
<td class="paramname"><em>inString</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>messageEnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>blocking</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>Input multiple bytes that may be modified by callee. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inString</td><td>the byte buffer to process. </td></tr>
<tr><td class="paramname">length</td><td>the size of the string, in bytes. </td></tr>
<tr><td class="paramname">messageEnd</td><td>means how many filters to signal MessageEnd() to, including this one. </td></tr>
<tr><td class="paramname">blocking</td><td>specifies whether the object should block when processing input.</td></tr>
</table>
</dd>
</dl>
<p>Internally, <a class="el" href="class_multichannel.html#ae5a9ac9bf82eb7f4eadc7c38fd604216" title="Input multiple bytes that may be modified by callee.">PutModifiable2()</a> calls <a class="el" href="class_multichannel.html#a5e8ff874d5703311a9947cf086170fa6" title="Input multiple bytes for processing.">Put2()</a>. </p>
<p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00269">269</a> of file <a class="el" href="simple_8h_source.html">simple.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="simple_8h_source.html">simple.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 27 2019 15:04:25 for Crypto++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
17f48c047155a7d4c992d6a672acd57f
>
files
>
1265
