class_file_store.html
来自「Crypto++是一个非常强大的密码学库,主要是功能全」· HTML 代码 · 共 526 行 · 第 1/2 页
HTML
526 行
<!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++: FileStore 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>FileStore Class Reference</h1><code>#include <<a class="el" href="files_8h-source.html">files.h</a>></code><p><p>Inheritance diagram for FileStore:<p><center><img src="class_file_store.png" usemap="#FileStore_map" border="0" alt=""></center><map name="FileStore_map"><area href="class_store.html" alt="Store" shape="rect" coords="180,280,530,304"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="180,112,530,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,350,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="360,56,710,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,350,24"></map><a href="class_file_store-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><p><p>Definition at line <a class="el" href="files_8h-source.html#l00013">13</a> of file <a class="el" href="files_8h-source.html">files.h</a>.<table border=0 cellpadding=0 cellspacing=0><tr><td></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_file_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="FileStore::AttachedTransformation"></a>virtual <a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_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="FileStore::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="FileStore::Detach"></a>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_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="FileStore::Attach"></a>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_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="_file_storea1" doxytag="FileStore::FileStore"></a> </td><td class="memItemRight" valign=bottom><b>FileStore</b> (std::istream &in)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_file_storea2" doxytag="FileStore::FileStore"></a> </td><td class="memItemRight" valign=bottom><b>FileStore</b> (const char *filename)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_file_storea3" doxytag="FileStore::GetStream"></a>std::istream * </td><td class="memItemRight" valign=bottom><b>GetStream</b> ()</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_store.html#_file_storea4">MaxRetrievable</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns number of bytes that is currently ready for retrieval </em> <a href="#_file_storea4"></a><em><br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_file_storea5" doxytag="FileStore::Peek"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_store.html#_file_storea5">Peek</a> (byte &outByte) const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">peek at the next byte without removing it from the output buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_file_storea6" doxytag="FileStore::TransferTo2"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_store.html#_file_storea6">TransferTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned long &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)</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="_file_storea7" doxytag="FileStore::CopyRangeTo2"></a>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</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_file_storea8" doxytag="FileStore::Skip"></a>unsigned long </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_store.html#_file_storea8">Skip</a> (unsigned long skipMax)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">discard skipMax bytes from the output buffer <br><br></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top><a name="_string_storea5" doxytag="FileStore::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="FileStore::NumberOfMessages"></a>unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_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_file_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="FileStore::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="FileStore::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="FileStore::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_file_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="FileStore::AlgorithmName"></a>virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_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="FileStore::Clone"></a>virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_file_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_file_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="FileStore::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="_input_rejectingb0" doxytag="FileStore::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="FileStore::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="FileStore::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="FileStore::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="FileStore::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="FileStore::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="FileStore::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="_file_storea4" doxytag="FileStore::MaxRetrievable"></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"> unsigned long FileStore::MaxRetrievable </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>returns number of bytes that is currently ready for retrieval <p>All retrieval functions return the actual number of bytes retrieved, which is the lesser of the request number and <a class="el" href="class_file_store.html#_file_storea4">MaxRetrievable()</a>. <p>Reimplemented from <a class="el" href="class_buffered_transformation.html#_zlib_decompressorz7_0">BufferedTransformation</a>.<p>Definition at line <a class="el" href="files_8cpp-source.html#l00040">40</a> of file <a class="el" href="files_8cpp-source.html">files.cpp</a>. </td> </tr></table><a name="_string_storea7" doxytag="FileStore::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, inherited]</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="FileStore::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="FileStore::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>⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?