| <!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.Encoders.ProtonEncoderState Class 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="namespaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders.html">Encoders</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState.html">ProtonEncoderState</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="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState.png" usemap="#Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState_map" name="Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState_map"> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html" title="Defines a state object that is used with the AMQP Encoder type to hold intermediate state and provide..." alt="Apache.Qpid.Proton.Codec.IEncoderState" shape="rect" coords="0,0,344,24"/> |
| </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:aa12972eff6884d8b29cbc8e837d8d36a"><td class="memItemLeft" align="right" valign="top"><a id="aa12972eff6884d8b29cbc8e837d8d36a"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>ProtonEncoderState</b> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoder.html">ProtonEncoder</a> encoder)</td></tr> |
| <tr class="separator:aa12972eff6884d8b29cbc8e837d8d36a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0fa6d999ff5711d8415d232920e89d25"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState.html#a0fa6d999ff5711d8415d232920e89d25">Reset</a> ()</td></tr> |
| <tr class="memdesc:a0fa6d999ff5711d8415d232920e89d25"><td class="mdescLeft"> </td><td class="mdescRight">Resets the encoder after a complete encode operation freeing any held resources and preparing for a new encode operation. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState.html#a0fa6d999ff5711d8415d232920e89d25">More...</a><br /></td></tr> |
| <tr class="separator:a0fa6d999ff5711d8415d232920e89d25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a55d9aef0c2ad82c41251def9bfea20ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState.html#a55d9aef0c2ad82c41251def9bfea20ea">EncodeUtf8</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, string value)</td></tr> |
| <tr class="memdesc:a55d9aef0c2ad82c41251def9bfea20ea"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the given string into UTF-8 bytes that are written into the provided buffer. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1ProtonEncoderState.html#a55d9aef0c2ad82c41251def9bfea20ea">More...</a><br /></td></tr> |
| <tr class="separator:a55d9aef0c2ad82c41251def9bfea20ea"><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:a374b76d6720a7d5ff137d874f41445de"><td class="memItemLeft" align="right" valign="top"><a id="a374b76d6720a7d5ff137d874f41445de"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoder.html">IEncoder</a> </td><td class="memItemRight" valign="bottom"><b>Encoder</b><code> [get]</code></td></tr> |
| <tr class="separator:a374b76d6720a7d5ff137d874f41445de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e828da033b15898e36f71be1c8acfea"><td class="memItemLeft" align="right" valign="top"><a id="a4e828da033b15898e36f71be1c8acfea"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1IUtf8Encoder.html">IUtf8Encoder</a> </td><td class="memItemRight" valign="bottom"><b>Utf8Encoder</b><code> [get, set]</code></td></tr> |
| <tr class="separator:a4e828da033b15898e36f71be1c8acfea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">Apache.Qpid.Proton.Codec.IEncoderState</a></td></tr> |
| <tr class="memitem:a20579d4c7150034f07ad3e967e6854ab inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoder.html">IEncoder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html#a20579d4c7150034f07ad3e967e6854ab">Encoder</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a20579d4c7150034f07ad3e967e6854ab inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoder.html" title="Defines an Encoder type that translates AMQP performatives into their encoded byte representations.">IEncoder</a> instance that was used when creating this encoder state object. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html#a20579d4c7150034f07ad3e967e6854ab">More...</a><br /></td></tr> |
| <tr class="separator:a20579d4c7150034f07ad3e967e6854ab inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a55d9aef0c2ad82c41251def9bfea20ea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a55d9aef0c2ad82c41251def9bfea20ea">◆ </a></span>EncodeUtf8()</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_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState.EncodeUtf8 </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">string </td> |
| <td class="paramname"><em>value</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Encodes the given string into UTF-8 bytes that are written into the provided buffer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td></td></tr> |
| <tr><td class="paramname">value</td><td>the string that is to be encoded as a UTF-8 byte sequence</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A reference to the passed buffer where the encoding was done.</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html#aa75e3f48f6f85f70573b3c36c29f0e2a">Apache.Qpid.Proton.Codec.IEncoderState</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0fa6d999ff5711d8415d232920e89d25"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0fa6d999ff5711d8415d232920e89d25">◆ </a></span>Reset()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Codec.Encoders.ProtonEncoderState.Reset </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Resets the encoder after a complete encode operation freeing any held resources and preparing for a new encode operation. </p> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html#acc65029fa596e457bd4649f6ef52bfdc">Apache.Qpid.Proton.Codec.IEncoderState</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Codec/Encoders/ProtonEncoderState.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> |