blob: 701cdc39e3f276b65ba5f56dc1baf59e2a19f179 [file] [log] [blame]
<!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.IDescribedTypeEncoder Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Codec.html">Codec</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.html">IDescribedTypeEncoder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Codec.IDescribedTypeEncoder Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Codec.IDescribedTypeEncoder:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1IDescribedTypeEncoder.png" usemap="#Apache.Qpid.Proton.Codec.IDescribedTypeEncoder_map" alt=""/>
<map id="Apache.Qpid.Proton.Codec.IDescribedTypeEncoder_map" name="Apache.Qpid.Proton.Codec.IDescribedTypeEncoder_map">
<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="1034,0,1541,24"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedTypeEncoder" shape="rect" coords="1034,112,1541,136"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedListTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedListTypeEncoder&lt; T &gt;" shape="rect" coords="0,168,507,192"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1AbstractDescribedMapTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.AbstractDescribedMapTypeEncoder&lt; K, V, M &gt;" shape="rect" coords="517,168,1024,192"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1Messaging_1_1AmqpSequenceTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.Messaging.AmqpSequenceTypeEncoder" shape="rect" coords="1034,168,1541,192"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1Messaging_1_1AmqpValueTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.Messaging.AmqpValueTypeEncoder" shape="rect" coords="1551,168,2058,192"/>
<area href="classApache_1_1Qpid_1_1Proton_1_1Codec_1_1Encoders_1_1Messaging_1_1DataTypeEncoder.html" alt="Apache.Qpid.Proton.Codec.Encoders.Messaging.DataTypeEncoder" shape="rect" coords="2068,168,2575,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:abf691f3f2f15ac89ea15e1b846d145ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6aab0a3a51a6343e476f7c62cd7fbaf8"><td class="memItemLeft" align="right" valign="top">ulong&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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&#160;</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">&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder')"><img src="closed.png" alt="-"/>&#160;Public Member Functions 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:af7378827e3a7b609f93641cfcf5f2392 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#af7378827e3a7b609f93641cfcf5f2392">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:af7378827e3a7b609f93641cfcf5f2392 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes the given value into the provided buffer. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#af7378827e3a7b609f93641cfcf5f2392">More...</a><br /></td></tr>
<tr class="separator:af7378827e3a7b609f93641cfcf5f2392 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb55fccbca6bf2f53a5c5458ca98eafc inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#aeb55fccbca6bf2f53a5c5458ca98eafc">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 value)</td></tr>
<tr class="memdesc:aeb55fccbca6bf2f53a5c5458ca98eafc inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes a full array encoding of the given array elements into the provided buffer. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#aeb55fccbca6bf2f53a5c5458ca98eafc">More...</a><br /></td></tr>
<tr class="separator:aeb55fccbca6bf2f53a5c5458ca98eafc inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93a73c8de26e0e95defd007610ba7f67 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#a93a73c8de26e0e95defd007610ba7f67">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:a93a73c8de26e0e95defd007610ba7f67 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes only the individual elements of the given array into the provided buffer <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder.html#a93a73c8de26e0e95defd007610ba7f67">More...</a><br /></td></tr>
<tr class="separator:a93a73c8de26e0e95defd007610ba7f67 inherit pub_methods_interfaceApache_1_1Qpid_1_1Proton_1_1Codec_1_1ITypeEncoder"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Property Documentation</h2>
<a id="a6aab0a3a51a6343e476f7c62cd7fbaf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aab0a3a51a6343e476f7c62cd7fbaf8">&#9670;&nbsp;</a></span>DescriptorCode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ulong Apache.Qpid.Proton.Codec.IDescribedTypeEncoder.DescriptorCode</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an AMQP unsigned int numeric code that describes the type to be encoded </p>
</div>
</div>
<a id="abf691f3f2f15ac89ea15e1b846d145ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf691f3f2f15ac89ea15e1b846d145ab">&#9670;&nbsp;</a></span>DescriptorSymbol</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="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> Apache.Qpid.Proton.Codec.IDescribedTypeEncoder.DescriptorSymbol</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an AMQP Symbol code that describes the type to be encoded </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Codec/IDescribedTypeEncoder.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>