| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C++ API: proton/byte_array.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> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </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"> |
| $(document).ready(function() { init_search(); }); |
| </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 |
|  <span id="projectnumber">0.21.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| 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.png" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </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"> |
| $(document).ready(function(){initNavTree('byte__array_8hpp_source.html','');}); |
| </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">byte_array.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="byte__array_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> <span class="preprocessor">#ifndef PROTON_BYTE_ARRAY_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_BYTE_ARRAY_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/*</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "./internal/export.hpp"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "./internal/comparable.hpp"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="types__fwd_8hpp.html">./types_fwd.hpp</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <proton/type_compat.h></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <algorithm></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <iterator></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span><a class="code" href="namespaceproton.html">proton</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> PN_CPP_EXTERN <span class="keywordtype">void</span> print_hex(std::ostream& o, <span class="keyword">const</span> uint8_t* p, <span class="keywordtype">size_t</span> n);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classproton_1_1byte__array.html"> 45</a></span> <span class="keyword">template</span> <<span class="keywordtype">size_t</span> N> <span class="keyword">class </span><a class="code" href="classproton_1_1byte__array.html">byte_array</a> : <span class="keyword">private</span> internal::comparable<byte_array<N> > {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">typedef</span> uint8_t value_type;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">typedef</span> value_type* pointer;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">typedef</span> <span class="keyword">const</span> value_type* const_pointer;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">typedef</span> value_type& reference;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">typedef</span> <span class="keyword">const</span> value_type& const_reference;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">typedef</span> value_type* iterator;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">typedef</span> <span class="keyword">const</span> value_type* const_iterator;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">typedef</span> std::size_t size_type;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">typedef</span> std::ptrdiff_t difference_type;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">typedef</span> std::reverse_iterator<iterator> reverse_iterator;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">typedef</span> std::reverse_iterator<const_iterator> const_reverse_iterator;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classproton_1_1byte__array.html#a03b598c27d7d68857a02259eca68ea7c"> 63</a></span>  <a class="code" href="classproton_1_1byte__array.html#a03b598c27d7d68857a02259eca68ea7c">byte_array</a>() { std::fill(bytes_, bytes_+N, <span class="charliteral">'\0'</span>); }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classproton_1_1byte__array.html#a0a22581a091167da9d9db49104dbf751"> 66</a></span>  <span class="keyword">static</span> <span class="keywordtype">size_t</span> <a class="code" href="classproton_1_1byte__array.html#a0a22581a091167da9d9db49104dbf751">size</a>() { <span class="keywordflow">return</span> N; }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  value_type* begin() { <span class="keywordflow">return</span> bytes_; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  value_type* end() { <span class="keywordflow">return</span> bytes_+N; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  value_type& operator[](<span class="keywordtype">size_t</span> i) { <span class="keywordflow">return</span> bytes_[i]; }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> value_type* begin()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> bytes_; }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> value_type* end()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> bytes_+N; }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> value_type& operator[](<span class="keywordtype">size_t</span> i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> bytes_[i]; }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classproton_1_1byte__array.html">byte_array</a>& x, <span class="keyword">const</span> <a class="code" href="classproton_1_1byte__array.html">byte_array</a>& y) {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> std::equal(x.begin(), x.end(), y.begin());</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator<(<span class="keyword">const</span> <a class="code" href="classproton_1_1byte__array.html">byte_array</a>& x, <span class="keyword">const</span> <a class="code" href="classproton_1_1byte__array.html">byte_array</a>& y) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> std::lexicographical_compare(x.begin(), x.end(), y.begin(), y.end());</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classproton_1_1byte__array.html#af73e25d01bd5857297741fe1e6ff986e"> 91</a></span>  <span class="keyword">friend</span> std::ostream& <a class="code" href="classproton_1_1byte__array.html#af73e25d01bd5857297741fe1e6ff986e">operator<<</a>(std::ostream& o, <span class="keyword">const</span> <a class="code" href="classproton_1_1byte__array.html">byte_array</a>& b) {</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  internal::print_hex(o, b.begin(), b.<a class="code" href="classproton_1_1byte__array.html#a0a22581a091167da9d9db49104dbf751">size</a>());</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">return</span> o;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  value_type bytes_[N];</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> };</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> } <span class="comment">// proton</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#endif // PROTON_BYTE_ARRAY_HPP</span></div><div class="ttc" id="classproton_1_1byte__array_html_a0a22581a091167da9d9db49104dbf751"><div class="ttname"><a href="classproton_1_1byte__array.html#a0a22581a091167da9d9db49104dbf751">proton::byte_array::size</a></div><div class="ttdeci">static size_t size()</div><div class="ttdoc">Size of the array. </div><div class="ttdef"><b>Definition:</b> byte_array.hpp:66</div></div> |
| <div class="ttc" id="classproton_1_1byte__array_html_a03b598c27d7d68857a02259eca68ea7c"><div class="ttname"><a href="classproton_1_1byte__array.html#a03b598c27d7d68857a02259eca68ea7c">proton::byte_array::byte_array</a></div><div class="ttdeci">byte_array()</div><div class="ttdoc">Zero-initialized byte array. </div><div class="ttdef"><b>Definition:</b> byte_array.hpp:63</div></div> |
| <div class="ttc" id="types__fwd_8hpp_html"><div class="ttname"><a href="types__fwd_8hpp.html">types_fwd.hpp</a></div><div class="ttdoc">Forward declarations for Proton types used to represent AMQP types. </div></div> |
| <div class="ttc" id="classproton_1_1byte__array_html_af73e25d01bd5857297741fe1e6ff986e"><div class="ttname"><a href="classproton_1_1byte__array.html#af73e25d01bd5857297741fe1e6ff986e">proton::byte_array::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &o, const byte_array &b)</div><div class="ttdoc">Print byte array in hex. </div><div class="ttdef"><b>Definition:</b> byte_array.hpp:91</div></div> |
| <div class="ttc" id="namespaceproton_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="classproton_1_1byte__array_html"><div class="ttname"><a href="classproton_1_1byte__array.html">proton::byte_array</a></div><div class="ttdoc">Arbitrary fixed-size data. </div><div class="ttdef"><b>Definition:</b> byte_array.hpp:45</div></div> |
| </div><!-- fragment --></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="dir_25143d27009f52d175c1d192441a738a.html">proton</a></li><li class="navelem"><a class="el" href="byte__array_8hpp.html">byte_array.hpp</a></li> |
| <li class="footer">Generated by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |