| <!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>Qpid Proton C API: proton/object.h 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&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 |
|  <span id="projectnumber">0.38.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.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> |
| </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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('object_8h_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">object.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef PROTON_OBJECT_H</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_OBJECT_H 1</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"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <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> <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> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <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> <span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * under the License.</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <proton/cid.h></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="types_8h.html">proton/types.h</a>></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <proton/import_export.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">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> PN_EXTERN <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *pn_class_create(<span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> (*initialize)(<span class="keywordtype">void</span>*),</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> (*finalize)(<span class="keywordtype">void</span>*),</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> (*incref)(<span class="keywordtype">void</span>*),</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> (*decref)(<span class="keywordtype">void</span>*),</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">int</span> (*refcount)(<span class="keywordtype">void</span>*));</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> PN_EXTERN <span class="keywordtype">void</span> *pn_class_new(<span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *clazz, <span class="keywordtype">size_t</span> size);</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *pn_class_name(<span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *clazz);</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> PN_EXTERN pn_cid_t pn_class_id(<span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *clazz);</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> PN_EXTERN <span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *pn_class(<span class="keywordtype">void</span>* <span class="keywordtype">object</span>);</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> PN_EXTERN <span class="keywordtype">void</span> *pn_incref(<span class="keywordtype">void</span> *<span class="keywordtype">object</span>);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> PN_EXTERN <span class="keywordtype">int</span> pn_decref(<span class="keywordtype">void</span> *<span class="keywordtype">object</span>);</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> PN_EXTERN <span class="keywordtype">int</span> pn_refcount(<span class="keywordtype">void</span> *<span class="keywordtype">object</span>);</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> PN_EXTERN <span class="keywordtype">void</span> pn_free(<span class="keywordtype">void</span> *<span class="keywordtype">object</span>);</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> PN_EXTERN <span class="keywordtype">char</span> *pn_tostring(<span class="keywordtype">void</span> *<span class="keywordtype">object</span>);</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define PN_LEGCTX ((pn_handle_t) 0)</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#define PN_HANDLE(name) \</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">static const char _PN_HANDLE_ ## name = 0; \</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">static const pn_handle_t name = ((pn_handle_t) &_PN_HANDLE_ ## name);</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> PN_EXTERN <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *PN_OBJECT;</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> PN_EXTERN <span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *PN_VOID;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> PN_EXTERN <a class="code" href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> *pn_record(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> PN_EXTERN <span class="keywordtype">void</span> pn_record_def(<a class="code" href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> *record, <a class="code" href="types_8h.html#a668c28cd63e7bd092bc5fcd19b829205">pn_handle_t</a> key, <span class="keyword">const</span> <a class="code" href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a> *clazz);</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> PN_EXTERN <span class="keywordtype">bool</span> pn_record_has(<a class="code" href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> *record, <a class="code" href="types_8h.html#a668c28cd63e7bd092bc5fcd19b829205">pn_handle_t</a> key);</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> PN_EXTERN <span class="keywordtype">void</span> *pn_record_get(<a class="code" href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> *record, <a class="code" href="types_8h.html#a668c28cd63e7bd092bc5fcd19b829205">pn_handle_t</a> key);</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> PN_EXTERN <span class="keywordtype">void</span> pn_record_set(<a class="code" href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> *record, <a class="code" href="types_8h.html#a668c28cd63e7bd092bc5fcd19b829205">pn_handle_t</a> key, <span class="keywordtype">void</span> *value);</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> PN_EXTERN <span class="keywordtype">void</span> pn_record_clear(<a class="code" href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a> *record);</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> }</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#endif</span></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> <span class="preprocessor">#endif </span><span class="comment">/* object.h */</span><span class="preprocessor"></span></div> |
| <div class="ttc" id="atypes_8h_html"><div class="ttname"><a href="types_8h.html">types.h</a></div><div class="ttdoc">AMQP and API data types.</div></div> |
| <div class="ttc" id="atypes_8h_html_a668c28cd63e7bd092bc5fcd19b829205"><div class="ttname"><a href="types_8h.html#a668c28cd63e7bd092bc5fcd19b829205">pn_handle_t</a></div><div class="ttdeci">const void * pn_handle_t</div><div class="ttdoc">A type to represent the internal navigational state of a proton object.</div><div class="ttdef"><b>Definition:</b> types.h:467</div></div> |
| <div class="ttc" id="atypes_8h_html_a70655c422210ccf8f4616e4c28a8b1d4"><div class="ttname"><a href="types_8h.html#a70655c422210ccf8f4616e4c28a8b1d4">pn_record_t</a></div><div class="ttdeci">struct pn_record_t pn_record_t</div><div class="ttdoc">A type representing attached context information.</div><div class="ttdef"><b>Definition:</b> types.h:477</div></div> |
| <div class="ttc" id="atypes_8h_html_aa1a17a915d9d1bbd9b893ec7bd2d2b17"><div class="ttname"><a href="types_8h.html#aa1a17a915d9d1bbd9b893ec7bd2d2b17">pn_class_t</a></div><div class="ttdeci">struct pn_class_t pn_class_t</div><div class="ttdoc">A type representing the type of a proton internal object.</div><div class="ttdef"><b>Definition:</b> types.h:472</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_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><b>object.h</b></li> |
| <li class="footer">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 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
