📄 class_message_queue.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++: MessageQueue 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>MessageQueue Class Reference</h1><!-- doxytag: class="MessageQueue" --><!-- doxytag: inherits="AutoSignaling< BufferedTransformation >" --><code>#include <<a class="el" href="mqueue_8h-source.html">mqueue.h</a>></code><p><p>Inheritance diagram for MessageQueue:<p><center><img src="class_message_queue.png" usemap="#MessageQueue_map" border="0" alt=""></center><map name="MessageQueue_map"><area href="class_auto_signaling.html" alt="AutoSignaling< BufferedTransformation >" shape="rect" coords="128,168,375,192"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="128,112,375,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,247,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="257,56,504,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,247,24"></map><a href="class_message_queue-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>Message Queue. <p><p>Definition at line <a class="el" href="mqueue_8h-source.html#l00011">11</a> of file <a class="el" href="mqueue_8h-source.html">mqueue.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="99e63c7e22a03a87374a74880f75a586"></a><!-- doxytag: member="MessageQueue::MessageQueue" ref="99e63c7e22a03a87374a74880f75a586" args="(unsigned int nodeSize=256)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#99e63c7e22a03a87374a74880f75a586">MessageQueue</a> (unsigned int nodeSize=256)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="26b8baf32ac98064caf0696fc37dcacf"></a><!-- doxytag: member="MessageQueue::IsolatedInitialize" ref="26b8baf32ac98064caf0696fc37dcacf" args="(const NameValuePairs &parameters)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#26b8baf32ac98064caf0696fc37dcacf">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">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#3ca42e60e7de1cfada145609cb3eb5e9">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="#3ca42e60e7de1cfada145609cb3eb5e9"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df7c0e8cc64279572e4bfc282bcdba78"></a><!-- doxytag: member="MessageQueue::IsolatedFlush" ref="df7c0e8cc64279572e4bfc282bcdba78" args="(bool hardFlush, bool blocking)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#df7c0e8cc64279572e4bfc282bcdba78">IsolatedFlush</a> (bool hardFlush, bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="574f29031f2d8ae02e7ff4a03e5db8bf"></a><!-- doxytag: member="MessageQueue::IsolatedMessageSeriesEnd" ref="574f29031f2d8ae02e7ff4a03e5db8bf" args="(bool blocking)" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#574f29031f2d8ae02e7ff4a03e5db8bf">IsolatedMessageSeriesEnd</a> (bool blocking)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#fc8f0d4551de7b0a19d7747420015d1c">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="#fc8f0d4551de7b0a19d7747420015d1c"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f9ba84c015a1ca041ae7765c423e711"></a><!-- doxytag: member="MessageQueue::AnyRetrievable" ref="1f9ba84c015a1ca041ae7765c423e711" args="() const" -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#1f9ba84c015a1ca041ae7765c423e711">AnyRetrievable</a> () const</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns whether any bytes are currently ready for retrieval <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65c71bd159403e0a569ecb1eb8b4a2ed"></a><!-- doxytag: member="MessageQueue::TransferTo2" ref="65c71bd159403e0a569ecb1eb8b4a2ed" 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_message_queue.html#65c71bd159403e0a569ecb1eb8b4a2ed">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="d5db7457b26710e5485b177148bc32a2"></a><!-- doxytag: member="MessageQueue::CopyRangeTo2" ref="d5db7457b26710e5485b177148bc32a2" 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_message_queue.html#d5db7457b26710e5485b177148bc32a2">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="d42da27546fd65f68cecb4b6bab7fb5c"></a><!-- doxytag: member="MessageQueue::TotalBytesRetrievable" ref="d42da27546fd65f68cecb4b6bab7fb5c" args="() const" -->lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#d42da27546fd65f68cecb4b6bab7fb5c">TotalBytesRetrievable</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4b2a11a888efea5f9ca388d8a730bba"></a><!-- doxytag: member="MessageQueue::NumberOfMessages" ref="a4b2a11a888efea5f9ca388d8a730bba" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#a4b2a11a888efea5f9ca388d8a730bba">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_message_queue.html#540da279953a13541a65c271888e27b7">GetNextMessage</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">start retrieving the next message <a href="#540da279953a13541a65c271888e27b7"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bc4b9d535126eff81e67ef29074a3887"></a><!-- doxytag: member="MessageQueue::NumberOfMessagesInThisSeries" ref="bc4b9d535126eff81e67ef29074a3887" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#bc4b9d535126eff81e67ef29074a3887">NumberOfMessagesInThisSeries</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2366404f56eeb93ac97d44e5abb7e940"></a><!-- doxytag: member="MessageQueue::NumberOfMessageSeries" ref="2366404f56eeb93ac97d44e5abb7e940" args="() const" -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#2366404f56eeb93ac97d44e5abb7e940">NumberOfMessageSeries</a> () const</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67143ef5e88c34f3af8547a9a400af26"></a><!-- doxytag: member="MessageQueue::CopyMessagesTo" ref="67143ef5e88c34f3af8547a9a400af26" 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_message_queue.html#67143ef5e88c34f3af8547a9a400af26">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"><a class="anchor" name="1ac8683683155bd2d04bb489e1106449"></a><!-- doxytag: member="MessageQueue::Spy" ref="1ac8683683155bd2d04bb489e1106449" args="(size_t &contiguousSize) const " -->const byte * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#1ac8683683155bd2d04bb489e1106449">Spy</a> (size_t &contiguousSize) const </td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0cf7618db89d28cb81aa7ddfc29b3d85"></a><!-- doxytag: member="MessageQueue::swap" ref="0cf7618db89d28cb81aa7ddfc29b3d85" args="(MessageQueue &rhs)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_message_queue.html#0cf7618db89d28cb81aa7ddfc29b3d85">swap</a> (<a class="el" href="class_message_queue.html">MessageQueue</a> &rhs)</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="MessageQueue::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"><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="MessageQueue::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="MessageQueue::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><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e70658b0d271f8e114ac6c3cc9774ede"></a><!-- doxytag: member="MessageQueue::Put" ref="e70658b0d271f8e114ac6c3cc9774ede" args="(byte inByte, bool blocking=true)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_transformation.html#e70658b0d271f8e114ac6c3cc9774ede">Put</a> (byte inByte, bool blocking=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">input a byte for processing <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44e935e60d3877975a7c82c6353d65c9"></a><!-- doxytag: member="MessageQueue::Put" ref="44e935e60d3877975a7c82c6353d65c9" args="(const byte *inString, size_t length, bool blocking=true)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_transformation.html#44e935e60d3877975a7c82c6353d65c9">Put</a> (const byte *inString, size_t length, bool blocking=true)</td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -