| <!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.Decoders.Primitives.AbstractMapTypeDecoder 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_1Decoders.html">Decoders</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives.html">Primitives</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html">AbstractMapTypeDecoder</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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Base map type decoder used by decoders of various AMQP types that represent map style serialized objects. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.png" usemap="#Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder_map" name="Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html" alt="Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder" shape="rect" coords="224,112,663,136"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html" title="Interface for type decoders that handle AMQP Map encodings." alt="Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder" shape="rect" coords="1122,112,1561,136"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder.html" title="Defines an interface for an decoder of a primitive types" alt="Apache.Qpid.Proton.Codec.IPrimitiveTypeDecoder" shape="rect" coords="224,56,663,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder.html" title="Defines an interface for an decoder of a primitive types" alt="Apache.Qpid.Proton.Codec.IPrimitiveTypeDecoder" shape="rect" coords="1122,56,1561,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder.html" title="Defines an interface for an decoder of a specific type." alt="Apache.Qpid.Proton.Codec.ITypeDecoder" shape="rect" coords="0,0,439,24"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder.html" title="Defines an interface for an decoder of a specific type." alt="Apache.Qpid.Proton.Codec.IStreamTypeDecoder" shape="rect" coords="449,0,888,24"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder.html" title="Defines an interface for an decoder of a specific type." alt="Apache.Qpid.Proton.Codec.ITypeDecoder" shape="rect" coords="898,0,1337,24"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder.html" title="Defines an interface for an decoder of a specific type." alt="Apache.Qpid.Proton.Codec.IStreamTypeDecoder" shape="rect" coords="1347,0,1786,24"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map32TypeDecoder.html" alt="Apache.Qpid.Proton.Codec.Decoders.Primitives.Map32TypeDecoder" shape="rect" coords="449,224,888,248"/> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map8TypeDecoder.html" alt="Apache.Qpid.Proton.Codec.Decoders.Primitives.Map8TypeDecoder" shape="rect" coords="898,224,1337,248"/> |
| </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:a913f394d10404e744e261051650590d9"><td class="memItemLeft" align="right" valign="top">IDictionary< K, V > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a913f394d10404e744e261051650590d9">ReadMap< K, V ></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_1IDecoderState.html">IDecoderState</a> state)</td></tr> |
| <tr class="memdesc:a913f394d10404e744e261051650590d9"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to read and decode an AMQP Map from the given incoming byte buffer. The decoder applies type restrictions to the incoming Map based on the types given in the methods generic parameters. The resulting IDictionary is created using the type parameters provided to this method. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a913f394d10404e744e261051650590d9">More...</a><br /></td></tr> |
| <tr class="separator:a913f394d10404e744e261051650590d9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4913b569138277631d732837378cf17f"><td class="memItemLeft" align="right" valign="top">IDictionary< K, V > </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a4913b569138277631d732837378cf17f">ReadMap< K, V ></a> (Stream stream, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> state)</td></tr> |
| <tr class="memdesc:a4913b569138277631d732837378cf17f"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to read and decode an AMQP Map from the given incoming byte stream. The decoder applies type restrictions to the incoming Map based on the types given in the methods generic parameters. The resulting IDictionary is created using the type parameters provided to this method. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a4913b569138277631d732837378cf17f">More...</a><br /></td></tr> |
| <tr class="separator:a4913b569138277631d732837378cf17f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae319cceb13463c5d9a6a5d454b03e836"><td class="memItemLeft" align="right" valign="top">override object </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#ae319cceb13463c5d9a6a5d454b03e836">ReadValue</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_1IDecoderState.html">IDecoderState</a> state)</td></tr> |
| <tr class="memdesc:ae319cceb13463c5d9a6a5d454b03e836"><td class="mdescLeft"> </td><td class="mdescRight">Reads this decoders managed type from the given buffer and returns it. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#ae319cceb13463c5d9a6a5d454b03e836">More...</a><br /></td></tr> |
| <tr class="separator:ae319cceb13463c5d9a6a5d454b03e836"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a03c427a55dbbae6ec3d4efd07da7033a"><td class="memItemLeft" align="right" valign="top">override object </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a03c427a55dbbae6ec3d4efd07da7033a">ReadValue</a> (Stream stream, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> state)</td></tr> |
| <tr class="memdesc:a03c427a55dbbae6ec3d4efd07da7033a"><td class="mdescLeft"> </td><td class="mdescRight">Reads this decoders managed type from the given buffer and returns it. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a03c427a55dbbae6ec3d4efd07da7033a">More...</a><br /></td></tr> |
| <tr class="separator:a03c427a55dbbae6ec3d4efd07da7033a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a673f5ba976765d0a894cca03df2aecc2"><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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a673f5ba976765d0a894cca03df2aecc2">SkipValue</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_1IDecoderState.html">IDecoderState</a> state)</td></tr> |
| <tr class="memdesc:a673f5ba976765d0a894cca03df2aecc2"><td class="mdescLeft"> </td><td class="mdescRight">Skips the value that this decoder is handling by skipping the encoded bytes in the provided buffer instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a673f5ba976765d0a894cca03df2aecc2">More...</a><br /></td></tr> |
| <tr class="separator:a673f5ba976765d0a894cca03df2aecc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7793ce10d8205cb39dbffd2cd8bcdc6"><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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#ae7793ce10d8205cb39dbffd2cd8bcdc6">SkipValue</a> (Stream stream, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> state)</td></tr> |
| <tr class="memdesc:ae7793ce10d8205cb39dbffd2cd8bcdc6"><td class="mdescLeft"> </td><td class="mdescRight">Skips the value that this decoder is handling by skipping the encoded bytes in the provided buffer instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#ae7793ce10d8205cb39dbffd2cd8bcdc6">More...</a><br /></td></tr> |
| <tr class="separator:ae7793ce10d8205cb39dbffd2cd8bcdc6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9b1a8b87bdf4ce8b1c0098f8ab1e3f54"><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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a9b1a8b87bdf4ce8b1c0098f8ab1e3f54">ReadCount</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_1IDecoderState.html">IDecoderState</a> state)</td></tr> |
| <tr class="memdesc:a9b1a8b87bdf4ce8b1c0098f8ab1e3f54"><td class="mdescLeft"> </td><td class="mdescRight">Reads the number of elements contained in the encoded map from the provided IProtonBuffer. The implementation must read the correct size encoding based on the type of map that this type decoder handles. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a9b1a8b87bdf4ce8b1c0098f8ab1e3f54">More...</a><br /></td></tr> |
| <tr class="separator:a9b1a8b87bdf4ce8b1c0098f8ab1e3f54"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a43fdb51400552824edb95bb2f7862955"><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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a43fdb51400552824edb95bb2f7862955">ReadCount</a> (Stream stream, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> state)</td></tr> |
| <tr class="memdesc:a43fdb51400552824edb95bb2f7862955"><td class="mdescLeft"> </td><td class="mdescRight">Reads the number of elements contained in the encoded map from the provided Stream. The implementation must read the correct size encoding based on the type of map that this type decoder handles. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#a43fdb51400552824edb95bb2f7862955">More...</a><br /></td></tr> |
| <tr class="separator:a43fdb51400552824edb95bb2f7862955"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa243df15f0aa26ff2763159cd7bdc38b"><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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#aa243df15f0aa26ff2763159cd7bdc38b">ReadSize</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_1IDecoderState.html">IDecoderState</a> state)</td></tr> |
| <tr class="memdesc:aa243df15f0aa26ff2763159cd7bdc38b"><td class="mdescLeft"> </td><td class="mdescRight">Reads the encoded size value for the encoded map payload and returns it. The read is destructive and the type decoder read methods cannot be called after this this unless the IProtonBuffer is reset via a position marker. This method can be useful when the caller intends to manually read the binary payload from the given IProtonBuffer. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#aa243df15f0aa26ff2763159cd7bdc38b">More...</a><br /></td></tr> |
| <tr class="separator:aa243df15f0aa26ff2763159cd7bdc38b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae73d9a5617ba2d8a1e8d8c91a196132d"><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_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#ae73d9a5617ba2d8a1e8d8c91a196132d">ReadSize</a> (Stream stream, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> state)</td></tr> |
| <tr class="memdesc:ae73d9a5617ba2d8a1e8d8c91a196132d"><td class="mdescLeft"> </td><td class="mdescRight">Reads the encoded size value for the encoded map payload and returns it. The read is destructive and the type decoder read methods cannot be called after this this unless the Stream is reset via a position marker. This method can be useful when the caller intends to manually read the binary payload from the given stream. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1AbstractMapTypeDecoder.html#ae73d9a5617ba2d8a1e8d8c91a196132d">More...</a><br /></td></tr> |
| <tr class="separator:ae73d9a5617ba2d8a1e8d8c91a196132d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html">Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder</a></td></tr> |
| <tr class="memitem:a8326da479c4a9bf29ac8f39835705392 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memItemLeft" align="right" valign="top">Array </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a8326da479c4a9bf29ac8f39835705392">ReadArrayElements</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_1IDecoderState.html">IDecoderState</a> state, int count)</td></tr> |
| <tr class="memdesc:a8326da479c4a9bf29ac8f39835705392 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">Reads a series of this type that have been encoded into the body of an Array type. When encoded into an array the values are encoded in series following the identifier for the type, this method is given a count of the number of instances that are encoded and should read each in succession and returning them in a new array. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a8326da479c4a9bf29ac8f39835705392">More...</a><br /></td></tr> |
| <tr class="separator:a8326da479c4a9bf29ac8f39835705392 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a17393bf075fc3a5de2b4d60d15c9ec23 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memItemLeft" align="right" valign="top">Array </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a17393bf075fc3a5de2b4d60d15c9ec23">ReadArrayElements</a> (Stream stream, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> state, int count)</td></tr> |
| <tr class="memdesc:a17393bf075fc3a5de2b4d60d15c9ec23 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">Reads a series of this type that have been encoded into the body of an Array type. When encoded into an array the values are encoded in series following the identifier for the type, this method is given a count of the number of instances that are encoded and should read each in succession and returning them in a new array. <a href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a17393bf075fc3a5de2b4d60d15c9ec23">More...</a><br /></td></tr> |
| <tr class="separator:a17393bf075fc3a5de2b4d60d15c9ec23 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><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:a780857fe8975ba05bf317fcfbb1b0678"><td class="memItemLeft" align="right" valign="top"><a id="a780857fe8975ba05bf317fcfbb1b0678"></a> |
| override Type </td><td class="memItemRight" valign="bottom"><b>DecodesType</b><code> [get]</code></td></tr> |
| <tr class="separator:a780857fe8975ba05bf317fcfbb1b0678"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td colspan="2" onclick="javascript:toggleInherit('properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html">Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder</a></td></tr> |
| <tr class="memitem:ab66a41d0ec7e8e72cb1eead4bed82601 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memItemLeft" align="right" valign="top"><a id="ab66a41d0ec7e8e72cb1eead4bed82601"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsArrayType</b><code> [get]</code></td></tr> |
| <tr class="separator:ab66a41d0ec7e8e72cb1eead4bed82601 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f24f44d2850d1cee6aa02fef53d98ae inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memItemLeft" align="right" valign="top"><a id="a0f24f44d2850d1cee6aa02fef53d98ae"></a> |
| abstract <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html#a3c20d2d05f5f52d8828e0d0ef1bea07a">EncodingCodes</a> </td><td class="memItemRight" valign="bottom"><b>EncodingCode</b><code> [get]</code></td></tr> |
| <tr class="separator:a0f24f44d2850d1cee6aa02fef53d98ae inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96c2730910a46276296f9a6e9f9098ce inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memItemLeft" align="right" valign="top"><a id="a96c2730910a46276296f9a6e9f9098ce"></a> |
| abstract Type </td><td class="memItemRight" valign="bottom"><b>DecodesType</b><code> [get]</code></td></tr> |
| <tr class="separator:a96c2730910a46276296f9a6e9f9098ce inherit properties_classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder.html">Apache.Qpid.Proton.Codec.IPrimitiveTypeDecoder</a></td></tr> |
| <tr class="memitem:a70ff2799daa608d758e2f3beeaa52d6f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder"><td class="memItemLeft" align="right" valign="top"><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="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder.html#a70ff2799daa608d758e2f3beeaa52d6f">EncodingCode</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a70ff2799daa608d758e2f3beeaa52d6f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">Get the AMQP encoding code byte for the type this decoder handles. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder.html#a70ff2799daa608d758e2f3beeaa52d6f">More...</a><br /></td></tr> |
| <tr class="separator:a70ff2799daa608d758e2f3beeaa52d6f inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IPrimitiveTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder.html">Apache.Qpid.Proton.Codec.ITypeDecoder</a></td></tr> |
| <tr class="memitem:a1e225b8345bc9013952baca1f1001ca2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><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_1ITypeDecoder.html#a1e225b8345bc9013952baca1f1001ca2">DecodesType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1e225b8345bc9013952baca1f1001ca2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">The Type that this decoder can read. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder.html#a1e225b8345bc9013952baca1f1001ca2">More...</a><br /></td></tr> |
| <tr class="separator:a1e225b8345bc9013952baca1f1001ca2 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afe5d5a6c937634d0908c1b22e320cfeb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder.html#afe5d5a6c937634d0908c1b22e320cfeb">IsArrayType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afe5d5a6c937634d0908c1b22e320cfeb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the value that this decoder is going to read is an array type. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder.html#afe5d5a6c937634d0908c1b22e320cfeb">More...</a><br /></td></tr> |
| <tr class="separator:afe5d5a6c937634d0908c1b22e320cfeb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder.html">Apache.Qpid.Proton.Codec.IStreamTypeDecoder</a></td></tr> |
| <tr class="memitem:ab16bfa3ea4ff85b25b66c33255ad42a1 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><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_1IStreamTypeDecoder.html#ab16bfa3ea4ff85b25b66c33255ad42a1">DecodesType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab16bfa3ea4ff85b25b66c33255ad42a1 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">The Type that this decoder can read. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder.html#ab16bfa3ea4ff85b25b66c33255ad42a1">More...</a><br /></td></tr> |
| <tr class="separator:ab16bfa3ea4ff85b25b66c33255ad42a1 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac9f93c7fbc6ad5e341979a26508c668b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder.html#ac9f93c7fbc6ad5e341979a26508c668b">IsArrayType</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac9f93c7fbc6ad5e341979a26508c668b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the value that this decoder is going to read is an array type. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder.html#ac9f93c7fbc6ad5e341979a26508c668b">More...</a><br /></td></tr> |
| <tr class="separator:ac9f93c7fbc6ad5e341979a26508c668b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamTypeDecoder"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Base map type decoder used by decoders of various AMQP types that represent map style serialized objects. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a9b1a8b87bdf4ce8b1c0098f8ab1e3f54"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9b1a8b87bdf4ce8b1c0098f8ab1e3f54">◆ </a></span>ReadCount() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadCount </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_1IDecoderState.html">IDecoderState</a> </td> |
| <td class="paramname"><em>state</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the number of elements contained in the encoded map from the provided IProtonBuffer. The implementation must read the correct size encoding based on the type of map that this type decoder handles. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer where the count should be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that provides support</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the count of the map elements that is encoded in the given buffer</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html#ab1ffc6b5ef909e530350350cf0f05222">Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder</a>.</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map8TypeDecoder.html#a4a44312cf7096fd84f62999fcaa33d29">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map8TypeDecoder</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map32TypeDecoder.html#a48aecf79b8533f3856a34cf737c11a9a">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map32TypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a43fdb51400552824edb95bb2f7862955"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a43fdb51400552824edb95bb2f7862955">◆ </a></span>ReadCount() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadCount </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> </td> |
| <td class="paramname"><em>state</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the number of elements contained in the encoded map from the provided Stream. The implementation must read the correct size encoding based on the type of map that this type decoder handles. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The stream where the element count should be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that provides support</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the count of the map elements that is encoded in the given buffer</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html#a182ef8642b55a1b3ab4a39f2cfa6b428">Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder</a>.</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map8TypeDecoder.html#ab844e4d8a7321cdba2122406544f6cb2">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map8TypeDecoder</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map32TypeDecoder.html#ad8353644702c79a52afb392076ac1e89">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map32TypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a913f394d10404e744e261051650590d9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a913f394d10404e744e261051650590d9">◆ </a></span>ReadMap< K, V >() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IDictionary<K, V> Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadMap< K, V > </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_1IDecoderState.html">IDecoderState</a> </td> |
| <td class="paramname"><em>state</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>Attempts to read and decode an AMQP Map from the given incoming byte buffer. The decoder applies type restrictions to the incoming Map based on the types given in the methods generic parameters. The resulting IDictionary is created using the type parameters provided to this method. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">K</td><td>The type restriction for the keys of the Map</td></tr> |
| <tr><td class="paramname">V</td><td>The type restriction for the values of the Map</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer where the Map should be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that provides support</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>An IDictionary that was created using the type parameters</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html#a98b4af5320d09924c4f118c6640b4b90">Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a4913b569138277631d732837378cf17f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4913b569138277631d732837378cf17f">◆ </a></span>ReadMap< K, V >() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IDictionary<K, V> Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadMap< K, V > </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> </td> |
| <td class="paramname"><em>state</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>Attempts to read and decode an AMQP Map from the given incoming byte stream. The decoder applies type restrictions to the incoming Map based on the types given in the methods generic parameters. The resulting IDictionary is created using the type parameters provided to this method. </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">K</td><td>The type restriction for the keys of the Map</td></tr> |
| <tr><td class="paramname">V</td><td>The type restriction for the values of the Map</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The stream where the Map should be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that provides support</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>An IDictionary that was created using the type parameters</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html#a82ed76ab7eb3e334b8cb21919212e686">Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa243df15f0aa26ff2763159cd7bdc38b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa243df15f0aa26ff2763159cd7bdc38b">◆ </a></span>ReadSize() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadSize </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_1IDecoderState.html">IDecoderState</a> </td> |
| <td class="paramname"><em>state</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the encoded size value for the encoded map payload and returns it. The read is destructive and the type decoder read methods cannot be called after this this unless the IProtonBuffer is reset via a position marker. This method can be useful when the caller intends to manually read the binary payload from the given IProtonBuffer. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer where the size should be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that provides support</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the size of the map payload that is encoded in the given buffer</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html#a4c8a87ee53afeb4ccc13285fa23eab39">Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder</a>.</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map8TypeDecoder.html#a8529ce473bd6485ef6e0e5db5c326e37">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map8TypeDecoder</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map32TypeDecoder.html#ad0f2b97fbaed9280017c78c55847bcf9">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map32TypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae73d9a5617ba2d8a1e8d8c91a196132d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae73d9a5617ba2d8a1e8d8c91a196132d">◆ </a></span>ReadSize() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadSize </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> </td> |
| <td class="paramname"><em>state</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the encoded size value for the encoded map payload and returns it. The read is destructive and the type decoder read methods cannot be called after this this unless the Stream is reset via a position marker. This method can be useful when the caller intends to manually read the binary payload from the given stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The stream where the size should be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that provides support</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the size of the map payload that is encoded in the given stream</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1IMapTypeDecoder.html#a2ba5477e080d0eeeae866b23a71098e6">Apache.Qpid.Proton.Codec.Decoders.Primitives.IMapTypeDecoder</a>.</p> |
| |
| <p>Implemented in <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map8TypeDecoder.html#a0468d80e60812f93ca3c6b9a823790d7">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map8TypeDecoder</a>, and <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1Primitives_1_1Map32TypeDecoder.html#a69b974f28e910e201f68194d0cfcf673">Apache.Qpid.Proton.Codec.Decoders.Primitives.Map32TypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae319cceb13463c5d9a6a5d454b03e836"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae319cceb13463c5d9a6a5d454b03e836">◆ </a></span>ReadValue() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override object Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadValue </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_1IDecoderState.html">IDecoderState</a> </td> |
| <td class="paramname"><em>state</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>Reads this decoders managed type from the given buffer and returns it. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer where the encoded bytes can be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that can be used during decode</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The decoded value from the byte stream</dd></dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a43c9cd6d676cb85212b588fb77b3784f">Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a03c427a55dbbae6ec3d4efd07da7033a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a03c427a55dbbae6ec3d4efd07da7033a">◆ </a></span>ReadValue() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override object Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.ReadValue </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> </td> |
| <td class="paramname"><em>state</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>Reads this decoders managed type from the given buffer and returns it. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The stream where the encoded bytes can be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that can be used during decode</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The decoded value from the byte stream</dd></dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#aaa539c94592da6cddde906ed20339f60">Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a673f5ba976765d0a894cca03df2aecc2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a673f5ba976765d0a894cca03df2aecc2">◆ </a></span>SkipValue() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.SkipValue </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_1IDecoderState.html">IDecoderState</a> </td> |
| <td class="paramname"><em>state</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>Skips the value that this decoder is handling by skipping the encoded bytes in the provided buffer instance. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>The buffer where the encoded bytes can be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that can be used during decode</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a5374dae99ab1666d1da5e44b8c941ea5">Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ae7793ce10d8205cb39dbffd2cd8bcdc6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7793ce10d8205cb39dbffd2cd8bcdc6">◆ </a></span>SkipValue() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Apache.Qpid.Proton.Codec.Decoders.Primitives.AbstractMapTypeDecoder.SkipValue </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"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IStreamDecoderState.html">IStreamDecoderState</a> </td> |
| <td class="paramname"><em>state</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>Skips the value that this decoder is handling by skipping the encoded bytes in the provided buffer instance. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">stream</td><td>The stream where the encoded bytes can be read from</td></tr> |
| <tr><td class="paramname">state</td><td>The decoder state that can be used during decode</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Decoders_1_1AbstractPrimitiveTypeDecoder.html#a6ce8685f5831da31e88025b4d7e8c235">Apache.Qpid.Proton.Codec.Decoders.AbstractPrimitiveTypeDecoder</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Codec/Decoders/Primitives/AbstractMapTypeDecoder.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> |
