<!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++: InputRejecting< 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.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="#nested-classes">Classes</a> | <a href="class_input_rejecting-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">InputRejecting< T > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <p>Base class for input rejecting filters. <a href="class_input_rejecting.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 InputRejecting< 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_input_rejecting.png" usemap="#InputRejecting_3C_20T_20_3E_map" alt=""/> <map id="InputRejecting_3C_20T_20_3E_map" name="InputRejecting_3C_20T_20_3E_map"> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_input_rejecting_1_1_input_rejected.html">InputRejected</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td colspan="2"><div class="groupHeader">INPUT</div></td></tr> <tr class="memitem:acfac9e0290dc999234df2e595c367926"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_input_rejecting.html#acfac9e0290dc999234df2e595c367926">Put2</a> (const byte *inString, size_t length, int messageEnd, bool blocking)</td></tr> <tr class="memdesc:acfac9e0290dc999234df2e595c367926"><td class="mdescLeft"> </td><td class="mdescRight">Input a byte array for processing. <a href="#acfac9e0290dc999234df2e595c367926">More...</a><br /></td></tr> <tr class="separator:acfac9e0290dc999234df2e595c367926"><td class="memSeparator" colspan="2"> </td></tr> <tr><td colspan="2"><div class="groupHeader">SIGNALS</div></td></tr> <tr class="memitem:add40cd4c4123f08f0e28f07bba9f95c0"><td class="memItemLeft" align="right" valign="top"><a id="add40cd4c4123f08f0e28f07bba9f95c0"></a> bool </td><td class="memItemRight" valign="bottom"><b>IsolatedFlush</b> (bool hardFlush, bool blocking)</td></tr> <tr class="separator:add40cd4c4123f08f0e28f07bba9f95c0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac600762e4d2ac76fcda7509761974132"><td class="memItemLeft" align="right" valign="top"><a id="ac600762e4d2ac76fcda7509761974132"></a> bool </td><td class="memItemRight" valign="bottom"><b>IsolatedMessageSeriesEnd</b> (bool blocking)</td></tr> <tr class="separator:ac600762e4d2ac76fcda7509761974132"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a525f715b10fb41023d26bd5fcccc309d"><td class="memItemLeft" align="right" valign="top"><a id="a525f715b10fb41023d26bd5fcccc309d"></a> size_t </td><td class="memItemRight" valign="bottom"><b>ChannelPut2</b> (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)</td></tr> <tr class="separator:a525f715b10fb41023d26bd5fcccc309d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1c81c9a1c156e685b52c3847ade409b6"><td class="memItemLeft" align="right" valign="top"><a id="a1c81c9a1c156e685b52c3847ade409b6"></a> bool </td><td class="memItemRight" valign="bottom"><b>ChannelMessageSeriesEnd</b> (const std::string &channel, int messageEnd, bool blocking)</td></tr> <tr class="separator:a1c81c9a1c156e685b52c3847ade409b6"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<class T><br /> class InputRejecting< T ></h3> <p>Base class for input rejecting filters. </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#l00134">134</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="acfac9e0290dc999234df2e595c367926"></a> <h2 class="memtitle"><span class="permalink"><a href="#acfac9e0290dc999234df2e595c367926">◆ </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_input_rejecting.html">InputRejecting</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 a byte array for processing. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">inString</td><td>the byte array 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> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="struct_input_rejecting_1_1_input_rejected.html">InputRejected</a></td><td></td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the number of bytes that remain in the block (i.e., bytes not processed)</dd></dl> <p>Internally, the default implementation throws <a class="el" href="struct_input_rejecting_1_1_input_rejected.html">InputRejected</a>. </p> <p class="definition">Definition at line <a class="el" href="simple_8h_source.html#l00151">151</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 Sun Sep 16 2018 07:58:38 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>