| <!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/error.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.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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('error_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">error.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="error_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52"> 1</a></span> <span class="preprocessor">#ifndef PROTON_ERROR_H</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_ERROR_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/import_export.h></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <stdarg.h></span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> <a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a>;</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__error.html#gac73fbd2363c5f562f85dde459e631394"> 46</a></span> <span class="preprocessor">#define PN_OK (0) </span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__error.html#ga9e0f51b097f94293cdbbdeb5422a27a3"> 47</a></span> <span class="preprocessor">#define PN_EOS (-1) </span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="group__error.html#ga664f7bdd616c30b72bd50bcc17839c81"> 48</a></span> <span class="preprocessor">#define PN_ERR (-2) </span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="group__error.html#gaaeef136648e1fd51c2b56c0265fa86f7"> 49</a></span> <span class="preprocessor">#define PN_OVERFLOW (-3) </span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="group__error.html#ga3317339fb405435df42fa93d62f0e14c"> 50</a></span> <span class="preprocessor">#define PN_UNDERFLOW (-4) </span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="group__error.html#ga5efbe6093556326613d2ccd3864a00aa"> 51</a></span> <span class="preprocessor">#define PN_STATE_ERR (-5) </span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group__error.html#ga5551b7172de89dc540bd7c2beedd325a"> 52</a></span> <span class="preprocessor">#define PN_ARG_ERR (-6) </span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__error.html#ga8bcf4aa6de1a6530713839bcae97d4a2"> 53</a></span> <span class="preprocessor">#define PN_TIMEOUT (-7) </span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="group__error.html#ga53284958be0c328f90ca3a4a0793d965"> 54</a></span> <span class="preprocessor">#define PN_INTR (-8) </span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__error.html#gafbb090366e9dbf9a5bb0735df1e23d33"> 55</a></span> <span class="preprocessor">#define PN_INPROGRESS (-9) </span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="group__error.html#gab1f773ca03b0953de6ce3caf4c795b8d"> 56</a></span> <span class="preprocessor">#define PN_OUT_OF_MEMORY (-10) </span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__error.html#ga82db456291c2627e31becc44b733a7f0"> 57</a></span> <span class="preprocessor">#define PN_ABORTED (-11) </span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="group__error.html#gac6b84f09fac8e82bd41a62212d4d8f64"> 63</a></span> <span class="preprocessor">PN_EXTERN const char *pn_code(int code);</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> |
| <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="group__error.html#ga0992aa0df5290a2ae639246b0c2f5481"> 68</a></span> PN_EXTERN <a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *<a class="code" href="group__error.html#ga0992aa0df5290a2ae639246b0c2f5481">pn_error</a>(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div> |
| <div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="group__error.html#ga5e57528759aedb00e68aafd0d025d06c"> 73</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__error.html#ga5e57528759aedb00e68aafd0d025d06c">pn_error_free</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error);</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__error.html#ga15440ed9515967950fa4504a53fc0b64"> 78</a></span> PN_EXTERN <span class="keywordtype">void</span> <a class="code" href="group__error.html#ga15440ed9515967950fa4504a53fc0b64">pn_error_clear</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="group__error.html#gac5b68c9e6a637810a55c0b0e6f66c90d"> 83</a></span> PN_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__error.html#gac5b68c9e6a637810a55c0b0e6f66c90d">pn_error_set</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, <span class="keywordtype">int</span> code, <span class="keyword">const</span> <span class="keywordtype">char</span> *text);</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="group__error.html#ga59db2b3acdca714819c6450d2d5440a1"> 89</a></span> PN_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__error.html#ga59db2b3acdca714819c6450d2d5440a1">pn_error_vformat</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, <span class="keywordtype">int</span> code, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, va_list ap);</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div> |
| <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="group__error.html#ga806d0788eeb97fd52d645cb8b75f8bf2"> 95</a></span> PN_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__error.html#ga806d0788eeb97fd52d645cb8b75f8bf2">pn_error_format</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, <span class="keywordtype">int</span> code, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div> |
| <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="group__error.html#ga00e179c24bc0954e1f01c64aa832ee2c"> 100</a></span> PN_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__error.html#ga00e179c24bc0954e1f01c64aa832ee2c">pn_error_code</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error);</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> |
| <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="group__error.html#ga67cbe6ebb143370e0604f5b84d716c56"> 106</a></span> PN_EXTERN <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__error.html#ga67cbe6ebb143370e0604f5b84d716c56">pn_error_text</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error);</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> |
| <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="group__error.html#ga96ccb65768c64ee0a1b71b83e08489d3"> 111</a></span> PN_EXTERN <span class="keywordtype">int</span> <a class="code" href="group__error.html#ga96ccb65768c64ee0a1b71b83e08489d3">pn_error_copy</a>(<a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *error, <a class="code" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> *src);</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#define PN_RETURN_IF_ERROR(x) \</span></div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">do {\</span></div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">int r = (x);\</span></div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">if (r < 0) return r; \</span></div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">} while (0)</span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  </div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> }</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif </span><span class="comment">/* error.h */</span><span class="preprocessor"></span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="agroup__error_html_ga24a289d5b32c9bd8a775600a5af83d52"><div class="ttname"><a href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a></div><div class="ttdeci">struct pn_error_t pn_error_t</div><div class="ttdoc">An int error code and some string text to describe the error.</div><div class="ttdef"><b>Definition:</b> error.h:44</div></div> |
| <div class="ttc" id="agroup__error_html_gac5b68c9e6a637810a55c0b0e6f66c90d"><div class="ttname"><a href="group__error.html#gac5b68c9e6a637810a55c0b0e6f66c90d">pn_error_set</a></div><div class="ttdeci">int pn_error_set(pn_error_t *error, int code, const char *text)</div><div class="ttdoc">Set the error code and text.</div></div> |
| <div class="ttc" id="agroup__error_html_ga00e179c24bc0954e1f01c64aa832ee2c"><div class="ttname"><a href="group__error.html#ga00e179c24bc0954e1f01c64aa832ee2c">pn_error_code</a></div><div class="ttdeci">int pn_error_code(pn_error_t *error)</div><div class="ttdoc">Get the the error code.</div></div> |
| <div class="ttc" id="agroup__error_html_ga15440ed9515967950fa4504a53fc0b64"><div class="ttname"><a href="group__error.html#ga15440ed9515967950fa4504a53fc0b64">pn_error_clear</a></div><div class="ttdeci">void pn_error_clear(pn_error_t *error)</div><div class="ttdoc">Reset the error to a "no error" state with code == 0.</div></div> |
| <div class="ttc" id="agroup__error_html_ga0992aa0df5290a2ae639246b0c2f5481"><div class="ttname"><a href="group__error.html#ga0992aa0df5290a2ae639246b0c2f5481">pn_error</a></div><div class="ttdeci">pn_error_t * pn_error(void)</div><div class="ttdoc">Create an error object.</div></div> |
| <div class="ttc" id="agroup__error_html_ga806d0788eeb97fd52d645cb8b75f8bf2"><div class="ttname"><a href="group__error.html#ga806d0788eeb97fd52d645cb8b75f8bf2">pn_error_format</a></div><div class="ttdeci">int pn_error_format(pn_error_t *error, int code, const char *fmt,...)</div><div class="ttdoc">Set the code and set the text using a printf-style formatted string.</div></div> |
| <div class="ttc" id="agroup__error_html_ga96ccb65768c64ee0a1b71b83e08489d3"><div class="ttname"><a href="group__error.html#ga96ccb65768c64ee0a1b71b83e08489d3">pn_error_copy</a></div><div class="ttdeci">int pn_error_copy(pn_error_t *error, pn_error_t *src)</div><div class="ttdoc">Copy the src error.</div></div> |
| <div class="ttc" id="agroup__error_html_ga5e57528759aedb00e68aafd0d025d06c"><div class="ttname"><a href="group__error.html#ga5e57528759aedb00e68aafd0d025d06c">pn_error_free</a></div><div class="ttdeci">void pn_error_free(pn_error_t *error)</div><div class="ttdoc">Free an error object.</div></div> |
| <div class="ttc" id="agroup__error_html_ga67cbe6ebb143370e0604f5b84d716c56"><div class="ttname"><a href="group__error.html#ga67cbe6ebb143370e0604f5b84d716c56">pn_error_text</a></div><div class="ttdeci">const char * pn_error_text(pn_error_t *error)</div><div class="ttdoc">Get the error text.</div></div> |
| <div class="ttc" id="agroup__error_html_ga59db2b3acdca714819c6450d2d5440a1"><div class="ttname"><a href="group__error.html#ga59db2b3acdca714819c6450d2d5440a1">pn_error_vformat</a></div><div class="ttdeci">int pn_error_vformat(pn_error_t *error, int code, const char *fmt, va_list ap)</div><div class="ttdoc">Set the code and set the text using a printf-style formatted string.</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="error_8h.html">error.h</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> |
