Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / input / releases / qpid-proton-0.32.0 / proton / cpp / api / common_8hpp_source.html
blob: 3dfa975c76742a6b86a50682b527af4724b4fbac [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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: proton/codec/common.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('common_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">common.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="common_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef PROTON_CODEC_COMMON_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define PROTON_CODEC_COMMON_HPP</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;../type_id.hpp&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="namespaceproton_1_1codec.html"> 31</a></span>&#160;<span class="keyword">namespace </span>codec {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespaceproton_1_1codec.html"> 34</a></span>&#160;<span class="keyword">struct </span><a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a>(<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> type_=<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a74cf8825b522b9721ea02973803d76b4">NULL_TYPE</a>, <a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> element_=<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a74cf8825b522b9721ea02973803d76b4">NULL_TYPE</a>,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordtype">bool</span> described_=<span class="keyword">false</span>, <span class="keywordtype">size_t</span> size_=0) :</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; type(type_), element(element_), is_described(described_), size(size_) {}</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> type; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> element; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">bool</span> is_described; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">size_t</span> size; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">static</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a> array(<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> element, <span class="keywordtype">bool</span> described=<span class="keyword">false</span>) { <span class="keywordflow">return</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a>(<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a1e029fbf0c881b85d80fc8e89b753688">ARRAY</a>, element, described); }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">static</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a> list() { <span class="keywordflow">return</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a>(<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a25688e799536738ea469158ef15fd1c0">LIST</a>); }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">static</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a> <a class="code" href="classproton_1_1map.html">map</a>() { <span class="keywordflow">return</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a>(<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a4cafa5feda04184537b4d7d346e1e89b">MAP</a>); }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a> described() { <span class="keywordflow">return</span> <a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">start</a>(<a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a69c9d854e6a5430635ad44693470612d">DESCRIBED</a>, <a class="code" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a74cf8825b522b9721ea02973803d76b4">NULL_TYPE</a>, <span class="keyword">true</span>); }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="namespaceproton_1_1codec.html"> 57</a></span>&#160;<span class="keyword">struct </span><a class="code" href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1finish">finish</a> {};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;} <span class="comment">// codec</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;} <span class="comment">// proton</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor">#endif // PROTON_CODEC_COMMON_HPP</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="anamespaceproton_html_a83c2656d467d69eb49725c18f5aa13a9a25688e799536738ea469158ef15fd1c0"><div class="ttname"><a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a25688e799536738ea469158ef15fd1c0">proton::LIST</a></div><div class="ttdeci">@ LIST</div><div class="ttdoc">A sequence of values of mixed types.</div><div class="ttdef"><b>Definition:</b> type_id.hpp:61</div></div>
<div class="ttc" id="anamespaceproton_html_a83c2656d467d69eb49725c18f5aa13a9a69c9d854e6a5430635ad44693470612d"><div class="ttname"><a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a69c9d854e6a5430635ad44693470612d">proton::DESCRIBED</a></div><div class="ttdeci">@ DESCRIBED</div><div class="ttdoc">A descriptor and a value.</div><div class="ttdef"><b>Definition:</b> type_id.hpp:59</div></div>
<div class="ttc" id="anamespaceproton_html_a83c2656d467d69eb49725c18f5aa13a9a4cafa5feda04184537b4d7d346e1e89b"><div class="ttname"><a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a4cafa5feda04184537b4d7d346e1e89b">proton::MAP</a></div><div class="ttdeci">@ MAP</div><div class="ttdoc">A sequence of key-value pairs.</div><div class="ttdef"><b>Definition:</b> type_id.hpp:62</div></div>
<div class="ttc" id="aclassproton_1_1map_html"><div class="ttname"><a href="classproton_1_1map.html">proton::map</a></div><div class="ttdoc">A collection of key-value pairs.</div><div class="ttdef"><b>Definition:</b> map.hpp:67</div></div>
<div class="ttc" id="anamespaceproton_html_a83c2656d467d69eb49725c18f5aa13a9a74cf8825b522b9721ea02973803d76b4"><div class="ttname"><a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a74cf8825b522b9721ea02973803d76b4">proton::NULL_TYPE</a></div><div class="ttdeci">@ NULL_TYPE</div><div class="ttdoc">The null type, contains no data.</div><div class="ttdef"><b>Definition:</b> type_id.hpp:38</div></div>
<div class="ttc" id="anamespaceproton_html_a83c2656d467d69eb49725c18f5aa13a9"><div class="ttname"><a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">proton::type_id</a></div><div class="ttdeci">type_id</div><div class="ttdoc">An identifier for AMQP types.</div><div class="ttdef"><b>Definition:</b> type_id.hpp:37</div></div>
<div class="ttc" id="anamespaceproton_1_1codec_html_structproton_1_1codec_1_1start"><div class="ttname"><a href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1start">proton::codec::start</a></div><div class="ttdoc">Unsettled API - Start encoding a complex type.</div><div class="ttdef"><b>Definition:</b> common.hpp:34</div></div>
<div class="ttc" id="anamespaceproton_html_a83c2656d467d69eb49725c18f5aa13a9a1e029fbf0c881b85d80fc8e89b753688"><div class="ttname"><a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a1e029fbf0c881b85d80fc8e89b753688">proton::ARRAY</a></div><div class="ttdeci">@ ARRAY</div><div class="ttdoc">A sequence of values of the same type.</div><div class="ttdef"><b>Definition:</b> type_id.hpp:60</div></div>
<div class="ttc" id="anamespaceproton_html"><div class="ttname"><a href="namespaceproton.html">proton</a></div><div class="ttdoc">The main Proton namespace.</div><div class="ttdef"><b>Definition:</b> annotation_key.hpp:33</div></div>
<div class="ttc" id="anamespaceproton_1_1codec_html_structproton_1_1codec_1_1finish"><div class="ttname"><a href="namespaceproton_1_1codec.html#structproton_1_1codec_1_1finish">proton::codec::finish</a></div><div class="ttdoc">Unsettled API - Finish inserting or extracting a complex type.</div><div class="ttdef"><b>Definition:</b> common.hpp:57</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="dir_b05f2487fc07b0eb4e1fbe4d7abfda97.html">codec</a></li><li class="navelem"><a class="el" href="common_8hpp.html">common.hpp</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>