blob: aec5a93897edf700cac1f2aefbf817a7b4d1ac8d [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: byte_array&lt; N &gt;</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('classproton_1_1byte__array.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classproton_1_1byte__array-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">byte_array&lt; N &gt;</div> </div>
</div><!--header-->
<div class="contents">
<p>Arbitrary fixed-size data.
<a href="classproton_1_1byte__array.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="byte__array_8hpp_source.html">byte_array.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for byte_array&lt; N &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classproton_1_1byte__array.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Sequence container typedefs</div></td></tr>
<tr class="memitem:a4bbdd41bfc847213cc17df2150f2d36f"><td class="memItemLeft" align="right" valign="top"><a id="a4bbdd41bfc847213cc17df2150f2d36f"></a>
typedef uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
<tr class="separator:a4bbdd41bfc847213cc17df2150f2d36f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad25b518036b886d8f35a3c059301d007"><td class="memItemLeft" align="right" valign="top"><a id="ad25b518036b886d8f35a3c059301d007"></a>
typedef value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>pointer</b></td></tr>
<tr class="separator:ad25b518036b886d8f35a3c059301d007"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13c57dab17e2c903cadfa5e35ba84064"><td class="memItemLeft" align="right" valign="top"><a id="a13c57dab17e2c903cadfa5e35ba84064"></a>
typedef const value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>const_pointer</b></td></tr>
<tr class="separator:a13c57dab17e2c903cadfa5e35ba84064"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe8933d436779a43cb5c1896ff5f2918"><td class="memItemLeft" align="right" valign="top"><a id="abe8933d436779a43cb5c1896ff5f2918"></a>
typedef value_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
<tr class="separator:abe8933d436779a43cb5c1896ff5f2918"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdb67657e63a66ed3fae7b0c9fd81b48"><td class="memItemLeft" align="right" valign="top"><a id="afdb67657e63a66ed3fae7b0c9fd81b48"></a>
typedef const value_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>const_reference</b></td></tr>
<tr class="separator:afdb67657e63a66ed3fae7b0c9fd81b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b0424da8c99197075d119ba0959bf1e"><td class="memItemLeft" align="right" valign="top"><a id="a4b0424da8c99197075d119ba0959bf1e"></a>
typedef value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>iterator</b></td></tr>
<tr class="separator:a4b0424da8c99197075d119ba0959bf1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad40b6f664e3f2f7ab960886c2f7e325"><td class="memItemLeft" align="right" valign="top"><a id="aad40b6f664e3f2f7ab960886c2f7e325"></a>
typedef const value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b></td></tr>
<tr class="separator:aad40b6f664e3f2f7ab960886c2f7e325"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a6dcafb6130e3e1bcd6d1285e0dd6f"><td class="memItemLeft" align="right" valign="top"><a id="a89a6dcafb6130e3e1bcd6d1285e0dd6f"></a>
typedef std::size_t&#160;</td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
<tr class="separator:a89a6dcafb6130e3e1bcd6d1285e0dd6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad319fc54a93a2c7058c70e40428ed2e2"><td class="memItemLeft" align="right" valign="top"><a id="ad319fc54a93a2c7058c70e40428ed2e2"></a>
typedef std::ptrdiff_t&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
<tr class="separator:ad319fc54a93a2c7058c70e40428ed2e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92b881db836646f4039adcbb73c8595f"><td class="memItemLeft" align="right" valign="top"><a id="a92b881db836646f4039adcbb73c8595f"></a>
typedef std::reverse_iterator&lt; iterator &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>reverse_iterator</b></td></tr>
<tr class="separator:a92b881db836646f4039adcbb73c8595f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a421ef78ccdc84f0f6b2b14e2732527ba"><td class="memItemLeft" align="right" valign="top"><a id="a421ef78ccdc84f0f6b2b14e2732527ba"></a>
typedef std::reverse_iterator&lt; const_iterator &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>const_reverse_iterator</b></td></tr>
<tr class="separator:a421ef78ccdc84f0f6b2b14e2732527ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a03b598c27d7d68857a02259eca68ea7c"><td class="memItemLeft" align="right" valign="top"><a id="a03b598c27d7d68857a02259eca68ea7c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1byte__array.html#a03b598c27d7d68857a02259eca68ea7c">byte_array</a> ()</td></tr>
<tr class="memdesc:a03b598c27d7d68857a02259eca68ea7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zero-initialized byte array. <br /></td></tr>
<tr class="separator:a03b598c27d7d68857a02259eca68ea7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Array operators</div></td></tr>
<tr class="memitem:a5cef60cb24e71a774ca7fd34a0299242"><td class="memItemLeft" align="right" valign="top"><a id="a5cef60cb24e71a774ca7fd34a0299242"></a>
value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr class="separator:a5cef60cb24e71a774ca7fd34a0299242"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e468c6efb6d8a6e23aa038e77e2683b"><td class="memItemLeft" align="right" valign="top"><a id="a9e468c6efb6d8a6e23aa038e77e2683b"></a>
value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
<tr class="separator:a9e468c6efb6d8a6e23aa038e77e2683b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bac4d75006235270f0c23744aa2517e"><td class="memItemLeft" align="right" valign="top"><a id="a8bac4d75006235270f0c23744aa2517e"></a>
value_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (size_t i)</td></tr>
<tr class="separator:a8bac4d75006235270f0c23744aa2517e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5310cf5d739236f30ce3625d375bceb4"><td class="memItemLeft" align="right" valign="top"><a id="a5310cf5d739236f30ce3625d375bceb4"></a>
const value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const</td></tr>
<tr class="separator:a5310cf5d739236f30ce3625d375bceb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cebd58fabf177f121fdf9f25033cafb"><td class="memItemLeft" align="right" valign="top"><a id="a9cebd58fabf177f121fdf9f25033cafb"></a>
const value_type *&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> () const</td></tr>
<tr class="separator:a9cebd58fabf177f121fdf9f25033cafb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a5b7e2edea93a2ceafe9dfa6bdc7c56"><td class="memItemLeft" align="right" valign="top"><a id="a5a5b7e2edea93a2ceafe9dfa6bdc7c56"></a>
const value_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (size_t i) const</td></tr>
<tr class="separator:a5a5b7e2edea93a2ceafe9dfa6bdc7c56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0a22581a091167da9d9db49104dbf751"><td class="memItemLeft" align="right" valign="top"><a id="a0a22581a091167da9d9db49104dbf751"></a>
static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1byte__array.html#a0a22581a091167da9d9db49104dbf751">size</a> ()</td></tr>
<tr class="memdesc:a0a22581a091167da9d9db49104dbf751"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the array. <br /></td></tr>
<tr class="separator:a0a22581a091167da9d9db49104dbf751"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:af73e25d01bd5857297741fe1e6ff986e"><td class="memItemLeft" align="right" valign="top"><a id="af73e25d01bd5857297741fe1e6ff986e"></a>
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1byte__array.html#af73e25d01bd5857297741fe1e6ff986e">operator&lt;&lt;</a> (std::ostream &amp;o, const <a class="el" href="classproton_1_1byte__array.html">byte_array</a> &amp;b)</td></tr>
<tr class="memdesc:af73e25d01bd5857297741fe1e6ff986e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print byte array in hex. <br /></td></tr>
<tr class="separator:af73e25d01bd5857297741fe1e6ff986e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Comparison operators</div></td></tr>
<tr class="memitem:a43b072c392b8ed7e8e2a9009491b5a87"><td class="memItemLeft" align="right" valign="top"><a id="a43b072c392b8ed7e8e2a9009491b5a87"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classproton_1_1byte__array.html">byte_array</a> &amp;x, const <a class="el" href="classproton_1_1byte__array.html">byte_array</a> &amp;y)</td></tr>
<tr class="separator:a43b072c392b8ed7e8e2a9009491b5a87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae826995827ec4abdb8e2212ebbc4e506"><td class="memItemLeft" align="right" valign="top"><a id="ae826995827ec4abdb8e2212ebbc4e506"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (const <a class="el" href="classproton_1_1byte__array.html">byte_array</a> &amp;x, const <a class="el" href="classproton_1_1byte__array.html">byte_array</a> &amp;y)</td></tr>
<tr class="separator:ae826995827ec4abdb8e2212ebbc4e506"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;size_t N&gt;<br />
class proton::byte_array&lt; N &gt;</h3>
<p>Arbitrary fixed-size data. </p>
<p>Used to represent fixed-sized data types that don't have a natural C++ representation as an array of bytes. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="byte__array_8hpp_source.html">byte_array.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1byte__array.html">byte_array</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>