📄 class_store.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Crypto++: Store class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.2 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div><h1>Store Class Reference</h1><code>#include <<a class="el" href="simple_8h-source.html">simple.h</a>></code><p><p>Inheritance diagram for Store:<p><center><img src="class_store.png" usemap="#Store_map" border="0" alt=""></center><map name="Store_map"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="900,112,1250,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="720,56,1070,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="1080,56,1430,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="720,0,1070,24"><area href="class_b_e_r_general_decoder.html" alt="BERGeneralDecoder" shape="rect" coords="180,336,530,360"><area href="class_file_store.html" alt="FileStore" shape="rect" coords="540,336,890,360"><area href="class_null_store.html" alt="NullStore" shape="rect" coords="900,336,1250,360"><area href="class_random_number_store.html" alt="RandomNumberStore" shape="rect" coords="1260,336,1610,360"><area href="class_string_store.html" alt="StringStore" shape="rect" coords="1620,336,1970,360"><area href="class_b_e_r_sequence_decoder.html" alt="BERSequenceDecoder" shape="rect" coords="0,392,350,416"><area href="class_b_e_r_set_decoder.html" alt="BERSetDecoder" shape="rect" coords="360,392,710,416"></map><a href="class_store-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>A <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> that only contains pre-existing data as "output". <p><p>Definition at line <a class="el" href="simple_8h-source.html#l00176">176</a> of file <a class="el" href="simple_8h-source.html">simple.h</a>.<table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>NON-BLOCKING TRANSFER OF OUTPUT</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_storez11_0" doxytag="Store::TransferTo2"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_storez11_0">TransferTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned long &byteCount, const std::string &channel=NULL_CHANNEL, bool blocking=true)=0</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight"><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_storez11_1" doxytag="Store::CopyRangeTo2"></a>virtual unsigned int </td><td class="memItemRight" valign=bottom><b>CopyRangeTo2</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned long &begin, unsigned long end=ULONG_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const=0</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz11_0" doxytag="Store::TransferMessagesTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>TransferMessagesTo2</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned int &messageCount, const std::string &channel=NULL_CHANNEL, bool blocking=true)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz11_1" doxytag="Store::TransferAllTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>TransferAllTo2</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel=NULL_CHANNEL, bool blocking=true)</td></tr><tr><td colspan=2><br><h2>ATTACHMENT</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_windows_pipe_sinkz15_0">Attachable</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether this object allows attachment </em> <a href="#_windows_pipe_sinkz15_0"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sinkz15_1" doxytag="Store::AttachedTransformation"></a>virtual <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_windows_pipe_sinkz15_1">AttachedTransformation</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the object immediately attached to this object or NULL for no attachment <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sinkz15_2" doxytag="Store::AttachedTransformation"></a>virtual const <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><b>AttachedTransformation</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_windows_pipe_sinkz15_3" doxytag="Store::Detach"></a>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_windows_pipe_sinkz15_3">Detach</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *newAttachment=0)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">delete the current attachment chain and replace it with newAttachment <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorz15_0" doxytag="Store::Attach"></a>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_zlib_decompressorz15_0">Attach</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> *newAttachment)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">add newAttachment to the end of attachment chain <br><br></td></tr><tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_string_storea5" doxytag="Store::IsolatedInitialize"></a>void </td><td class="memItemRight" valign=bottom><b>IsolatedInitialize</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_string_storea6" doxytag="Store::NumberOfMessages"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_string_storea6">NumberOfMessages</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">number of times MessageEnd() has been received minus messages retrieved or skipped <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_string_storea7">GetNextMessage</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">start retrieving the next message </em> <a href="#_string_storea7"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_string_storea8" doxytag="Store::CopyMessagesTo"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>CopyMessagesTo</b> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL) const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_auto_signalinga2" doxytag="Store::SetAutoSignalPropagation"></a>void </td><td class="memItemRight" valign=bottom><b>SetAutoSignalPropagation</b> (int propagation)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_auto_signalinga3" doxytag="Store::GetAutoSignalPropagation"></a>int </td><td class="memItemRight" valign=bottom><b>GetAutoSignalPropagation</b> () const</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_zlib_decompressora16">Ref</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to this object </em> <a href="#_zlib_decompressora16"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora17" doxytag="Store::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_zlib_decompressora17">AlgorithmName</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressora18" doxytag="Store::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_zlib_decompressora18">Clone</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="class_store.html#_zlib_decompressora19">Wait</a> (unsigned long milliseconds)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">wait on this object </em> <a href="#_zlib_decompressora19"></a><em><br><br></td></tr><tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressors0" doxytag="Store::NULL_CHANNEL"></a>const std::string </td><td class="memItemRight" valign=bottom><b>NULL_CHANNEL</b></td></tr><tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_storeb0" doxytag="Store::StoreInitialize"></a>virtual void </td><td class="memItemRight" valign=bottom><b>StoreInitialize</b> (const <a class="el" href="class_name_value_pairs.html">NameValuePairs</a> &parameters)=0</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb0" doxytag="Store::Put2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>Put2</b> (const byte *begin, unsigned int length, int messageEnd, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb1" doxytag="Store::IsolatedFlush"></a>bool </td><td class="memItemRight" valign=bottom><b>IsolatedFlush</b> (bool, bool)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb2" doxytag="Store::IsolatedMessageSeriesEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>IsolatedMessageSeriesEnd</b> (bool)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb3" doxytag="Store::ChannelPut2"></a>unsigned int </td><td class="memItemRight" valign=bottom><b>ChannelPut2</b> (const std::string &channel, const byte *begin, unsigned int length, int messageEnd, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_input_rejectingb4" doxytag="Store::ChannelMessageSeriesEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>ChannelMessageSeriesEnd</b> (const std::string &, int, bool)</td></tr><tr><td colspan=2><br><h2>Static Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_zlib_decompressorf0" doxytag="Store::DecrementPropagation"></a>int </td><td class="memItemRight" valign=bottom><b>DecrementPropagation</b> (int propagation)</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_string_storep0" doxytag="Store::m_messageEnd"></a>bool </td><td class="memItemRight" valign=bottom><b>m_messageEnd</b></td></tr></table><hr><h2>Member Function Documentation</h2><a name="_string_storea7" doxytag="Store::GetNextMessage"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Store::GetNextMessage </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>start retrieving the next message <p>Returns false if no more messages exist or this message is not completely retrieved.<p>Reimplemented from <a class="el" href="class_buffered_transformation.html#_zlib_decompressorz9_3">BufferedTransformation</a>.<p>Definition at line <a class="el" href="filters_8cpp-source.html#l00814">814</a> of file <a class="el" href="filters_8cpp-source.html">filters.cpp</a>.<p>References <a class="el" href="cryptlib_8cpp-source.html#l00237">BufferedTransformation::AnyRetrievable()</a>. </td> </tr></table><a name="_zlib_decompressora16" doxytag="Store::Ref"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a>& BufferedTransformation::Ref </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline, inherited]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>return a reference to this object <p>This function is useful for passing a temporary <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> object to a function that takes a non-const reference. <p>Definition at line <a class="el" href="cryptlib_8h-source.html#l00702">702</a> of file <a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>. </td> </tr></table><a name="_zlib_decompressorz1_4" doxytag="Store::CreatePutSpace"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual byte* BufferedTransformation::CreatePutSpace </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">unsigned int & </td> <td class="mdname1" valign="top" nowrap> <em>size</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline, virtual, inherited]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>request space to write bytes into for processing <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>size</em> </td><td>is requested size (as a hint) for input, and size of the returned space for output </td></tr> </table></dl><p>Reimplemented in <a class="el" href="class_hash_filter.html#_hash_filtera3">HashFilter</a>, <a class="el" href="class_array_sink.html#_array_sinka5">ArraySink</a>, <a class="el" href="class_array_xor_sink.html#_array_xor_sinka2">ArrayXorSink</a>, and <a class="el" href="class_byte_queue.html#_d_e_r_set_encodera6">ByteQueue</a>.<p>Definition at line <a class="el" href="cryptlib_8h-source.html#l00720">720</a> of file <a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>.<p>Referenced by <a class="el" href="filters_8h-source.html#l00537">ArrayXorSink::CreatePutSpace()</a>. </td> </tr></table><a name="_zlib_decompressorz1_9" doxytag="Store::PutModifiable2"></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual unsigned int BufferedTransformation::PutModifiable2 </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">byte * </td> <td class="mdname" nowrap> <em>inString</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>unsigned int </td> <td class="mdname" nowrap> <em>length</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> <td class="mdname" nowrap> <em>messageEnd</em>, </td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -