| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Codec.IStreamDecoderState Interface Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html">Codec</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Codec.IStreamDecoderState Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Defines a state object that is used with the AMQP Decoder type to hold intermediate state and provide additional functionality that can be used during the decode process. |
| <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Codec.IStreamDecoderState:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.png" usemap="#Apache.Qpid.Proton.Codec.IStreamDecoderState_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Codec.IStreamDecoderState_map" name="Apache.Qpid.Proton.Codec.IStreamDecoderState_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1ProtonStreamDecoderState.html" alt="Apache.Qpid.Proton.Codec.Decoders.ProtonStreamDecoderState" shape="rect" coords="0,56,385,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0f747366ca148a78d9168a4f5e54c8f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#a0f747366ca148a78d9168a4f5e54c8f7">Reset</a> ()</td></tr> |
| <tr class="memdesc:a0f747366ca148a78d9168a4f5e54c8f7"><td class="mdescLeft"> </td><td class="mdescRight">Resets the decoder after a complete decode operation freeing any held resources and preparing for a new decode operation. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#a0f747366ca148a78d9168a4f5e54c8f7">More...</a><br /></td></tr> |
| <tr class="separator:a0f747366ca148a78d9168a4f5e54c8f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc4d7997c740810006aaa24091a0fc12"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#acc4d7997c740810006aaa24091a0fc12">DecodeUtf8</a> (Stream stream, int length)</td></tr> |
| <tr class="memdesc:acc4d7997c740810006aaa24091a0fc12"><td class="mdescLeft"> </td><td class="mdescRight">Decodes an encoded UTF-8 string value from the given buffer. The number of bytes that comprise the encoding is provided by the caller, the decoder should not read more than that number of bytes from the provided buffer. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#acc4d7997c740810006aaa24091a0fc12">More...</a><br /></td></tr> |
| <tr class="separator:acc4d7997c740810006aaa24091a0fc12"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a7e96c2049e1389a7c2bdbe46d2916660"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoder.html">IStreamDecoder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#a7e96c2049e1389a7c2bdbe46d2916660">Decoder</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a7e96c2049e1389a7c2bdbe46d2916660"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDecoder.html" title="Defines a Decoder that handles translating the encoded AMQP performative bytes into the appropriate P...">IDecoder</a> instance that was used when creating this decoder state object. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html#a7e96c2049e1389a7c2bdbe46d2916660">More...</a><br /></td></tr> |
| <tr class="separator:a7e96c2049e1389a7c2bdbe46d2916660"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Defines a state object that is used with the AMQP Decoder type to hold intermediate state and provide additional functionality that can be used during the decode process. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="acc4d7997c740810006aaa24091a0fc12"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acc4d7997c740810006aaa24091a0fc12">◆ </a></span>DecodeUtf8()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Apache.Qpid.Proton.Codec.IStreamDecoderState.DecodeUtf8 </td> |
| <td>(</td> |
| <td class="paramtype">Stream </td> |
| <td class="paramname"><em>stream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Decodes an encoded UTF-8 string value from the given buffer. The number of bytes that comprise the encoding is provided by the caller, the decoder should not read more than that number of bytes from the provided buffer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer where the bytes are to be read from.</td></tr> |
| <tr><td class="paramname">length</td><td>The encoded size of the UTF-8 string.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A string value decoded from the UTF-8 bytes</dd></dl> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1ProtonStreamDecoderState.html#ab88769ae19e736564873409c88909e9f">Apache.Qpid.Proton.Codec.Decoders.ProtonStreamDecoderState</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0f747366ca148a78d9168a4f5e54c8f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0f747366ca148a78d9168a4f5e54c8f7">◆ </a></span>Reset()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Codec.IStreamDecoderState.Reset </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Resets the decoder after a complete decode operation freeing any held resources and preparing for a new decode operation. </p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1ProtonStreamDecoderState.html#aaabd26c378007f82f4bd6dc785dd2f7c">Apache.Qpid.Proton.Codec.Decoders.ProtonStreamDecoderState</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a7e96c2049e1389a7c2bdbe46d2916660"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7e96c2049e1389a7c2bdbe46d2916660">◆ </a></span>Decoder</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoder.html">IStreamDecoder</a> Apache.Qpid.Proton.Codec.IStreamDecoderState.Decoder</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDecoder.html" title="Defines a Decoder that handles translating the encoded AMQP performative bytes into the appropriate P...">IDecoder</a> instance that was used when creating this decoder state object. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>src/Proton/Codec/IStreamDecoderState.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
