📄 class_byte_queue_1_1_walker.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++: ByteQueue::Walker 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><div class="nav"><a class="el" href="class_byte_queue.html">ByteQueue</a>::<a class="el" href="class_byte_queue_1_1_walker.html">Walker</a></div><h1>ByteQueue::Walker Class Reference</h1><!-- doxytag: class="ByteQueue::Walker" --><!-- doxytag: inherits="InputRejecting< BufferedTransformation >" --><p>Inheritance diagram for ByteQueue::Walker:<p><center><img src="class_byte_queue_1_1_walker.png" usemap="#ByteQueue::Walker_map" border="0" alt=""></center><map name="ByteQueue::Walker_map"><area href="class_input_rejecting.html" alt="InputRejecting< BufferedTransformation >" shape="rect" coords="129,168,377,192"><area href="class_buffered_transformation.html" alt="BufferedTransformation" shape="rect" coords="129,112,377,136"><area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,248,80"><area href="class_waitable.html" alt="Waitable" shape="rect" coords="258,56,506,80"><area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,248,24"></map><a href="class_byte_queue_1_1_walker-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="queue_8h-source.html#l00064">64</a> of file <a class="el" href="queue_8h-source.html">queue.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="6690a4529e61498d2abc68f4fe07b01c"></a><!-- doxytag: member="ByteQueue::Walker::Walker" ref="6690a4529e61498d2abc68f4fe07b01c" args="(const ByteQueue &queue)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#6690a4529e61498d2abc68f4fe07b01c">Walker</a> (const <a class="el" href="class_byte_queue.html">ByteQueue</a> &queue)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ea60c7d732acbf91e4fb2b3bc3abaad"></a><!-- doxytag: member="ByteQueue::Walker::GetCurrentPosition" ref="4ea60c7d732acbf91e4fb2b3bc3abaad" args="()" -->lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#4ea60c7d732acbf91e4fb2b3bc3abaad">GetCurrentPosition</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">lword </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#7e3e18155c288996a2243ced4c87c6b5">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="#7e3e18155c288996a2243ced4c87c6b5"></a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b74b6b33c01b0221a24e1ba17ac7a374"></a><!-- doxytag: member="ByteQueue::Walker::IsolatedInitialize" ref="b74b6b33c01b0221a24e1ba17ac7a374" args="(const NameValuePairs &parameters)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#b74b6b33c01b0221a24e1ba17ac7a374">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="1577996016d4fc5e644b86eb1a4f1660"></a><!-- doxytag: member="ByteQueue::Walker::Get" ref="1577996016d4fc5e644b86eb1a4f1660" args="(byte &outByte)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#1577996016d4fc5e644b86eb1a4f1660">Get</a> (byte &outByte)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">try to retrieve a single byte <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="940623c7bff90ab48f1534352675f92b"></a><!-- doxytag: member="ByteQueue::Walker::Get" ref="940623c7bff90ab48f1534352675f92b" args="(byte *outString, size_t getMax)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#940623c7bff90ab48f1534352675f92b">Get</a> (byte *outString, size_t getMax)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">try to retrieve multiple bytes <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2c8cbc9323d5844d3080fd29e7cf308"></a><!-- doxytag: member="ByteQueue::Walker::Peek" ref="f2c8cbc9323d5844d3080fd29e7cf308" args="(byte &outByte) const " -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#f2c8cbc9323d5844d3080fd29e7cf308">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></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f72a866515e0c7a155654d5bd1c427d"></a><!-- doxytag: member="ByteQueue::Walker::Peek" ref="9f72a866515e0c7a155654d5bd1c427d" args="(byte *outString, size_t peekMax) const " -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_byte_queue_1_1_walker.html#9f72a866515e0c7a155654d5bd1c427d">Peek</a> (byte *outString, size_t peekMax) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">peek at multiple bytes without removing them from the output buffer <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b5d6312affb66b46b7fbcd7f95e0ec4d"></a><!-- doxytag: member="ByteQueue::Walker::TransferTo2" ref="b5d6312affb66b46b7fbcd7f95e0ec4d" 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_byte_queue_1_1_walker.html#b5d6312affb66b46b7fbcd7f95e0ec4d">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="8992f04ee0f455eba03a56b3f2f11a80"></a><!-- doxytag: member="ByteQueue::Walker::CopyRangeTo2" ref="8992f04ee0f455eba03a56b3f2f11a80" 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_byte_queue_1_1_walker.html#8992f04ee0f455eba03a56b3f2f11a80">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">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="ByteQueue::Walker::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="ByteQueue::Walker::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="ByteQueue::Walker::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="ByteQueue::Walker::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="ByteQueue::Walker::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="ByteQueue::Walker::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="ByteQueue::Walker::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="ByteQueue::Walker::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><tr><td class="mdescLeft"> </td><td class="mdescRight">input multiple bytes <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92c60616792d7bce5cd41eaffbd1c3cc"></a><!-- doxytag: member="ByteQueue::Walker::PutWord16" ref="92c60616792d7bce5cd41eaffbd1c3cc" args="(word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)" -->size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffered_transformation.html#92c60616792d7bce5cd41eaffbd1c3cc">PutWord16</a> (word16 value, <a class="el" href="cryptlib_8h.html#aeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a> order=BIG_ENDIAN_ORDER, bool blocking=true)</td></tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -