| <!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.AbstractDescribedMapTypeEncoder< K, V, M > Class Template 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_1AbstractDescribedMapTypeEncoder.html">AbstractDescribedMapTypeEncoder</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder< K, V, M > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder< K, V, M >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.png" usemap="#Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder_3C_20K_2C_20V_2C_20M_20_3E_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder_3C_20K_2C_20V_2C_20M_20_3E_map" name="Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder_3C_20K_2C_20V_2C_20M_20_3E_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedTypeEncoder" shape="rect" coords="0,112,507,136"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.IDescribedTypeEncoder" shape="rect" coords="0,56,507,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html" title="Defines an interface for an encoder of a specific type." alt="Apache.Qpid.Proton.Codec.ITypeEncoder" shape="rect" coords="0,0,507,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:abac549629fce29ab1bdb3fcd53592704"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#abac549629fce29ab1bdb3fcd53592704">WriteType</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> state, object value)</td></tr> |
| <tr class="memdesc:abac549629fce29ab1bdb3fcd53592704"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the given value into the provided buffer. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#abac549629fce29ab1bdb3fcd53592704">More...</a><br /></td></tr> |
| <tr class="separator:abac549629fce29ab1bdb3fcd53592704"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8067601fa75f9cc31a09445ef159be34"><td class="memItemLeft" align="right" valign="top"><a id="a8067601fa75f9cc31a09445ef159be34"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><b>WriteType</b> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> state, M value)</td></tr> |
| <tr class="separator:a8067601fa75f9cc31a09445ef159be34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af4f9d8ab113334acc7342fd7a7e29ac0"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#af4f9d8ab113334acc7342fd7a7e29ac0">WriteArray</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> state, Array values)</td></tr> |
| <tr class="memdesc:af4f9d8ab113334acc7342fd7a7e29ac0"><td class="mdescLeft"> </td><td class="mdescRight">Encodes a full array encoding of the given array elements into the provided buffer. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#af4f9d8ab113334acc7342fd7a7e29ac0">More...</a><br /></td></tr> |
| <tr class="separator:af4f9d8ab113334acc7342fd7a7e29ac0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3587cb184536f289b70821b4ba14f543"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#a3587cb184536f289b70821b4ba14f543">WriteRawArray</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> state, Array values)</td></tr> |
| <tr class="memdesc:a3587cb184536f289b70821b4ba14f543"><td class="mdescLeft"> </td><td class="mdescRight">Encodes only the individual elements of the given array into the provided buffer <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#a3587cb184536f289b70821b4ba14f543">More...</a><br /></td></tr> |
| <tr class="separator:a3587cb184536f289b70821b4ba14f543"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a0dd26b0f6d23bdf81680fad321d4db4c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html#a3c20d2d05f5f52d8828e0d0ef1bea07a">EncodingCodes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#a0dd26b0f6d23bdf81680fad321d4db4c">GetMapEncoding</a> (M value)</td></tr> |
| <tr class="memdesc:a0dd26b0f6d23bdf81680fad321d4db4c"><td class="mdescLeft"> </td><td class="mdescRight">Determine the map type the given value can be encoded to based on the number of bytes that would be needed to hold the encoded form of the resulting map entries. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#a0dd26b0f6d23bdf81680fad321d4db4c">More...</a><br /></td></tr> |
| <tr class="separator:a0dd26b0f6d23bdf81680fad321d4db4c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aadb5f4be47e1c21639eb82c31d414e23"><td class="memItemLeft" align="right" valign="top">abstract bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#aadb5f4be47e1c21639eb82c31d414e23">HasMap</a> (M value)</td></tr> |
| <tr class="memdesc:aadb5f4be47e1c21639eb82c31d414e23"><td class="mdescLeft"> </td><td class="mdescRight">Returns false when the value to be encoded has no Map body and can be written as a Null body type instead of a Map type. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#aadb5f4be47e1c21639eb82c31d414e23">More...</a><br /></td></tr> |
| <tr class="separator:aadb5f4be47e1c21639eb82c31d414e23"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed5101ffa63d5e3bc98dd3f48b28c841"><td class="memItemLeft" align="right" valign="top">abstract int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#aed5101ffa63d5e3bc98dd3f48b28c841">GetMapEntries</a> (M value)</td></tr> |
| <tr class="memdesc:aed5101ffa63d5e3bc98dd3f48b28c841"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of elements that will result when this type is encoded into an AMQP Map type. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#aed5101ffa63d5e3bc98dd3f48b28c841">More...</a><br /></td></tr> |
| <tr class="separator:aed5101ffa63d5e3bc98dd3f48b28c841"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a115f3ce52b6618970a245cd154c2bdfa"><td class="memItemLeft" align="right" valign="top">abstract void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#a115f3ce52b6618970a245cd154c2bdfa">WriteMapEntries</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> buffer, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> state, M value)</td></tr> |
| <tr class="memdesc:a115f3ce52b6618970a245cd154c2bdfa"><td class="mdescLeft"> </td><td class="mdescRight">Performs the write of the Map entries to the given buffer, the caller takes care of writing the Map preamble and tracking the final size of the written elements of the Map. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html#a115f3ce52b6618970a245cd154c2bdfa">More...</a><br /></td></tr> |
| <tr class="separator:a115f3ce52b6618970a245cd154c2bdfa"><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:a262b2c6112b2e04691efb5fb1fce1183"><td class="memItemLeft" align="right" valign="top"><a id="a262b2c6112b2e04691efb5fb1fce1183"></a> |
| override Type </td><td class="memItemRight" valign="bottom"><b>EncodesType</b><code> [get]</code></td></tr> |
| <tr class="separator:a262b2c6112b2e04691efb5fb1fce1183"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td colspan="2" onclick="javascript:toggleInherit('properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedTypeEncoder</a></td></tr> |
| <tr class="memitem:acafe282700a32bc97eed78ccc8e22ae5 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td class="memItemLeft" align="right" valign="top"><a id="acafe282700a32bc97eed78ccc8e22ae5"></a> |
| abstract <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><b>DescriptorSymbol</b><code> [get]</code></td></tr> |
| <tr class="separator:acafe282700a32bc97eed78ccc8e22ae5 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9708fae6c2a210bc1b8feef46ccb2205 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td class="memItemLeft" align="right" valign="top"><a id="a9708fae6c2a210bc1b8feef46ccb2205"></a> |
| abstract ulong </td><td class="memItemRight" valign="bottom"><b>DescriptorCode</b><code> [get]</code></td></tr> |
| <tr class="separator:a9708fae6c2a210bc1b8feef46ccb2205 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4218127da1c0438b2926c39fca6e2f2 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td class="memItemLeft" align="right" valign="top"><a id="ab4218127da1c0438b2926c39fca6e2f2"></a> |
| abstract Type </td><td class="memItemRight" valign="bottom"><b>EncodesType</b><code> [get]</code></td></tr> |
| <tr class="separator:ab4218127da1c0438b2926c39fca6e2f2 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html">Apache.Qpid.Proton.Codec.IDescribedTypeEncoder</a></td></tr> |
| <tr class="memitem:abf691f3f2f15ac89ea15e1b846d145ab inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html#abf691f3f2f15ac89ea15e1b846d145ab">DescriptorSymbol</a><code> [get]</code></td></tr> |
| <tr class="memdesc:abf691f3f2f15ac89ea15e1b846d145ab inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td class="mdescLeft"> </td><td class="mdescRight">Returns an AMQP Symbol code that describes the type to be encoded <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html#abf691f3f2f15ac89ea15e1b846d145ab">More...</a><br /></td></tr> |
| <tr class="separator:abf691f3f2f15ac89ea15e1b846d145ab inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6aab0a3a51a6343e476f7c62cd7fbaf8 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td class="memItemLeft" align="right" valign="top">ulong </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html#a6aab0a3a51a6343e476f7c62cd7fbaf8">DescriptorCode</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6aab0a3a51a6343e476f7c62cd7fbaf8 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td class="mdescLeft"> </td><td class="mdescRight">Returns an AMQP unsigned int numeric code that describes the type to be encoded <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html#a6aab0a3a51a6343e476f7c62cd7fbaf8">More...</a><br /></td></tr> |
| <tr class="separator:a6aab0a3a51a6343e476f7c62cd7fbaf8 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html">Apache.Qpid.Proton.Codec.ITypeEncoder</a></td></tr> |
| <tr class="memitem:a2e7b977436dabac77fcbeaf44c040b20 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memItemLeft" align="right" valign="top">Type </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#a2e7b977436dabac77fcbeaf44c040b20">EncodesType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2e7b977436dabac77fcbeaf44c040b20 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="mdescLeft"> </td><td class="mdescRight">The Type that this decoder can write. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#a2e7b977436dabac77fcbeaf44c040b20">More...</a><br /></td></tr> |
| <tr class="separator:a2e7b977436dabac77fcbeaf44c040b20 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0dd26b0f6d23bdf81680fad321d4db4c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0dd26b0f6d23bdf81680fad321d4db4c">◆ </a></span>GetMapEncoding()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html#a3c20d2d05f5f52d8828e0d0ef1bea07a">EncodingCodes</a> <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.GetMapEncoding </td> |
| <td>(</td> |
| <td class="paramtype">M </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Determine the map type the given value can be encoded to based on the number of bytes that would be needed to hold the encoded form of the resulting map entries. </p> |
| <p>Most encoders will return MAP32 but for cases where the type is known to be be encoded to MAP8 the encoder can optimize the encode step and not compute sizes. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value</td><td>The value that is encoded as a map type</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The encoding code to use to write the map body</dd></dl> |
| |
| </div> |
| </div> |
| <a id="aed5101ffa63d5e3bc98dd3f48b28c841"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aed5101ffa63d5e3bc98dd3f48b28c841">◆ </a></span>GetMapEntries()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.GetMapEntries </td> |
| <td>(</td> |
| <td class="paramtype">M </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the number of elements that will result when this type is encoded into an AMQP Map type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value</td><td>The value that is encoded as a map type</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The number of elements to encode in the map body</dd></dl> |
| |
| </div> |
| </div> |
| <a id="aadb5f4be47e1c21639eb82c31d414e23"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aadb5f4be47e1c21639eb82c31d414e23">◆ </a></span>HasMap()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract bool <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.HasMap </td> |
| <td>(</td> |
| <td class="paramtype">M </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns false when the value to be encoded has no Map body and can be written as a Null body type instead of a Map type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value</td><td>The value that is encoded as a map type</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>if the map type needs a map body or can be null</dd></dl> |
| |
| </div> |
| </div> |
| <a id="af4f9d8ab113334acc7342fd7a7e29ac0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af4f9d8ab113334acc7342fd7a7e29ac0">◆ </a></span>WriteArray()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.WriteArray </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> </td> |
| <td class="paramname"><em>state</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Array </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 class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Encodes a full array encoding of the given array elements into 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 encoded bytes are to be written</td></tr> |
| <tr><td class="paramname">state</td><td>The encoder state to use when writing the bytes</td></tr> |
| <tr><td class="paramname">value</td><td>The array value to be encoded</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder.html#a30a7e4caf59f452f9a40da8d447dd11a">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedTypeEncoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a115f3ce52b6618970a245cd154c2bdfa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a115f3ce52b6618970a245cd154c2bdfa">◆ </a></span>WriteMapEntries()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.WriteMapEntries </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> </td> |
| <td class="paramname"><em>state</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">M </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">protected</span><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Performs the write of the Map entries to the given buffer, the caller takes care of writing the Map preamble and tracking the final size of the written elements of the Map. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer to write the map entries into</td></tr> |
| <tr><td class="paramname">state</td><td>The encoder state to use when writing</td></tr> |
| <tr><td class="paramname">value</td><td>The value to be encoded</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3587cb184536f289b70821b4ba14f543"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3587cb184536f289b70821b4ba14f543">◆ </a></span>WriteRawArray()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.WriteRawArray </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> </td> |
| <td class="paramname"><em>state</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Array </td> |
| <td class="paramname"><em>values</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 class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Encodes only the individual elements of the given array into 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 encoded bytes are to be written</td></tr> |
| <tr><td class="paramname">state</td><td>The encoder state to use when writing the bytes</td></tr> |
| <tr><td class="paramname">value</td><td>The array value to be encoded</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder.html#ae0a63bd3213cd4aa85b1f4cdc60646df">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedTypeEncoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="abac549629fce29ab1bdb3fcd53592704"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abac549629fce29ab1bdb3fcd53592704">◆ </a></span>WriteType()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder</a>< K, V, M >.WriteType </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IEncoderState.html">IEncoderState</a> </td> |
| <td class="paramname"><em>state</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">object </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 class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Encodes the given value into 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 encoded bytes are to be written</td></tr> |
| <tr><td class="paramname">state</td><td>The encoder state to use when writing the bytes</td></tr> |
| <tr><td class="paramname">value</td><td>The value to be encoded</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder.html#ac66a532caa987eb42138c512f0bcce4d">Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedTypeEncoder</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Codec/Encoders/AbstractDescribedMapTypeEncoder.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> |
