📄 class_file_store.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>Crypto++: FileStore Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><h1>FileStore Class Reference</h1><!-- doxytag: class="FileStore" --><!-- doxytag: inherits="Store,FilterPutSpaceHelper,NotCopyable" --><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="struct_filter_put_space_helper.html" alt="FilterPutSpaceHelper" shape="rect" coords="540,280,890,304"><area href="class_not_copyable.html" alt="NotCopyable" shape="rect" coords="900,280,1250,304"><area href="class_auto_signaling.html" alt="AutoSignaling< InputRejecting< BufferedTransformation > >" shape="rect" coords="180,224,530,248"><area href="class_input_rejecting.html" alt="InputRejecting< BufferedTransformation >" shape="rect" coords="180,168,530,192"><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>file-based implementation of <a class="el" href="class_store.html" title="A BufferedTransformation that only contains pre-existing data as "output".">Store</a> interface <p><p>Definition at line <a class="el" href="files_8h-source.html#l00014">14</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>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adb823030f45a6a9690185f0279b6908"></a><!-- doxytag: member="FileStore::FileStore" ref="adb823030f45a6a9690185f0279b6908" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#adb823030f45a6a9690185f0279b6908">FileStore</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a3ea09952e93c4db7fedf277c6d217e"></a><!-- doxytag: member="FileStore::FileStore" ref="4a3ea09952e93c4db7fedf277c6d217e" args="(std::istream &in)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#4a3ea09952e93c4db7fedf277c6d217e">FileStore</a> (std::istream &in)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="27d2d16927f16301fb178b676794a1fc"></a><!-- doxytag: member="FileStore::FileStore" ref="27d2d16927f16301fb178b676794a1fc" args="(const char *filename)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#27d2d16927f16301fb178b676794a1fc">FileStore</a> (const char *filename)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="52271ff9a07861683eb41b9df0be7081"></a><!-- doxytag: member="FileStore::GetStream" ref="52271ff9a07861683eb41b9df0be7081" args="()" -->std::istream * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#52271ff9a07861683eb41b9df0be7081">GetStream</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#27e29d3d04ddf2888d968327b26d9c88">MaxRetrievable</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns number of bytes that is currently ready for retrieval <a href="#27e29d3d04ddf2888d968327b26d9c88"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="792ca84496eb6fc13fb9f5d14244a42c"></a><!-- doxytag: member="FileStore::TransferTo2" ref="792ca84496eb6fc13fb9f5d14244a42c" args="(BufferedTransformation &target, lword &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#792ca84496eb6fc13fb9f5d14244a42c">TransferTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &transferBytes, const std::string &channel=<a class="el" href="class_buffered_transformation.html#5e938c68f2a5e32a03440b1dc2bdc74a">NULL_CHANNEL</a>, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">upon return, byteCount contains number of bytes that have finished being transfered, and returns the number of bytes left in the current transfer block <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62603d2f8ffa342e9be7b7a2ee5dfaf4"></a><!-- doxytag: member="FileStore::CopyRangeTo2" ref="62603d2f8ffa342e9be7b7a2ee5dfaf4" args="(BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const " -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#62603d2f8ffa342e9be7b7a2ee5dfaf4">CopyRangeTo2</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=<a class="el" href="class_buffered_transformation.html#5e938c68f2a5e32a03440b1dc2bdc74a">NULL_CHANNEL</a>, bool blocking=true) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">upon return, begin contains the start position of data yet to be finished copying, and returns the number of bytes left in the current transfer block <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="224d31ea858a3c890fec604a030db7cf"></a><!-- doxytag: member="FileStore::Skip" ref="224d31ea858a3c890fec604a030db7cf" args="(lword skipMax=ULONG_MAX)" -->lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_file_store.html#224d31ea858a3c890fec604a030db7cf">Skip</a> (lword skipMax=ULONG_MAX)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">discard skipMax bytes from the output buffer <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="47bfecef2abe22b090935cfab6f19f89"></a><!-- doxytag: member="FileStore::IsolatedInitialize" ref="47bfecef2abe22b090935cfab6f19f89" args="(const NameValuePairs &parameters)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_store.html#47bfecef2abe22b090935cfab6f19f89">IsolatedInitialize</a> (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 class="anchor" name="671fcd19428a776aa08d767a97ed116a"></a><!-- doxytag: member="FileStore::NumberOfMessages" ref="671fcd19428a776aa08d767a97ed116a" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_store.html#671fcd19428a776aa08d767a97ed116a">NumberOfMessages</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">number of times <a class="el" href="class_buffered_transformation.html#20ae0ef2e4ff338b43849e541e9b940f">MessageEnd()</a> has been received minus messages retrieved or skipped <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#5f578b4a2da5371a8a4b80a038a2d5ea">GetNextMessage</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">start retrieving the next message <a href="#5f578b4a2da5371a8a4b80a038a2d5ea"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5d85b56b9a70e4b2da147fa74cc5557"></a><!-- doxytag: member="FileStore::CopyMessagesTo" ref="e5d85b56b9a70e4b2da147fa74cc5557" args="(BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL) const " -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_store.html#e5d85b56b9a70e4b2da147fa74cc5557">CopyMessagesTo</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, unsigned int count=UINT_MAX, const std::string &channel=<a class="el" href="class_buffered_transformation.html#5e938c68f2a5e32a03440b1dc2bdc74a">NULL_CHANNEL</a>) const </td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_signaling.html#e63c0428295aeec8ffd9557ef1d86db9">SetAutoSignalPropagation</a> (int propagation)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">set propagation of automatically generated and transferred signals <a href="#e63c0428295aeec8ffd9557ef1d86db9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="011dc89743a4790bdd2ddefd9f176766"></a><!-- doxytag: member="FileStore::GetAutoSignalPropagation" ref="011dc89743a4790bdd2ddefd9f176766" args="() const" -->int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_auto_signaling.html#011dc89743a4790bdd2ddefd9f176766">GetAutoSignalPropagation</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_input_rejecting.html#0ff99108aa0d11f44a0ca49d056bc7cb">Put2</a> (const byte *begin, size_t length, int messageEnd, bool blocking)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes for blocking or non-blocking processing <a href="#0ff99108aa0d11f44a0ca49d056bc7cb"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08379573273dfdcd11cee9197aa4145d"></a><!-- doxytag: member="FileStore::IsolatedFlush" ref="08379573273dfdcd11cee9197aa4145d" args="(bool, bool)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_input_rejecting.html#08379573273dfdcd11cee9197aa4145d">IsolatedFlush</a> (bool, bool)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="280c87e06b662437b0f0a8ccd38cacfb"></a><!-- doxytag: member="FileStore::IsolatedMessageSeriesEnd" ref="280c87e06b662437b0f0a8ccd38cacfb" args="(bool)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_input_rejecting.html#280c87e06b662437b0f0a8ccd38cacfb">IsolatedMessageSeriesEnd</a> (bool)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2445d67fed0e8f26e1615562e1af12e7"></a><!-- doxytag: member="FileStore::ChannelPut2" ref="2445d67fed0e8f26e1615562e1af12e7" args="(const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_input_rejecting.html#2445d67fed0e8f26e1615562e1af12e7">ChannelPut2</a> (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2db8ebe3e67f20b3fc92252de9e96cf6"></a><!-- doxytag: member="FileStore::ChannelMessageSeriesEnd" ref="2db8ebe3e67f20b3fc92252de9e96cf6" args="(const std::string &, int, bool)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_input_rejecting.html#2db8ebe3e67f20b3fc92252de9e96cf6">ChannelMessageSeriesEnd</a> (const std::string &, int, bool)</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_buffered_transformation.html#25686ebe4c3ba26e7eeaae1dcd4d4215">Ref</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">return a reference to this object <a href="#25686ebe4c3ba26e7eeaae1dcd4d4215"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31510a192d1121856efe8ad0a9b844"></a><!-- doxytag: member="FileStore::AlgorithmName" ref="4f31510a192d1121856efe8ad0a9b844" args="() const" -->virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#4f31510a192d1121856efe8ad0a9b844">AlgorithmName</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d0016ba2d505c23aa85aad49e6c19bb7"></a><!-- doxytag: member="FileStore::Clone" ref="d0016ba2d505c23aa85aad49e6c19bb7" args="() const" -->virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#d0016ba2d505c23aa85aad49e6c19bb7">Clone</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_waitable.html#ded81bbe562f61932306a64e6122a6ca">Wait</a> (unsigned long milliseconds, <a class="el" href="class_call_stack.html">CallStack</a> const &callStack)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">wait on this object <a href="#ded81bbe562f61932306a64e6122a6ca"></a><br></td></tr><tr><td colspan="2"><div class="groupHeader">INPUT</div></td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -