/usr/share/proton-0.14.0/docs/api-c/condition_8h_source.html is in libqpid-proton8-dev-doc 0.14.0-5.1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | <!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>proton: /build/qpid-proton-4llz2H/qpid-proton-0.14.0/proton-c/include/proton/condition.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="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>
<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">proton
 <span id="projectnumber">0</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>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_3d7fee5163f29235853f3037db69c226.html">proton-c</a></li><li class="navelem"><a class="el" href="dir_ca4610195e991eb8124aba7312da0967.html">include</a></li><li class="navelem"><a class="el" href="dir_819e9c3ec552076ba9984156db77a62b.html">proton</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">condition.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="condition_8h.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_CONDITION_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define PROTON_CONDITION_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 <<a class="code" href="import__export_8h.html">proton/import_export.h</a>></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="codec_8h.html">proton/codec.h</a>></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="type__compat_8h.html">proton/type_compat.h</a>></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stddef.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/** @file</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * The Condition API for the proton Engine.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> *</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @defgroup condition Condition</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @ingroup connection</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/**</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * An AMQP Condition object. Conditions hold exceptional information</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * pertaining to the closing of an AMQP endpoint such as a Connection,</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * Session, or Link. Conditions also hold similar information</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * pertaining to deliveries that have reached terminal states.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Connections, Sessions, Links, and Deliveries may all have local and</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * remote conditions associated with them.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * The local condition may be modified by the local endpoint to signal</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * a particular condition to the remote peer. The remote condition may</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * be examined by the local endpoint to detect whatever condition the</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * remote peer may be signaling. Although often conditions are used to</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * indicate errors, not all conditions are errors per/se, e.g.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * conditions may be used to redirect a connection from one host to</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * another.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> *</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * Every condition has a short symbolic name, a longer description,</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * and an additional info map associated with it. The name identifies</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * the formally defined condition, and the map contains additional</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * information relevant to the identified condition.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> */</span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5"> 64</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> <a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/**</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * Returns true if the condition object is holding some information,</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * i.e. if the name is set to some non NULL value. Returns false</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * otherwise.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @param[in] condition the condition object to test</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @return true iff some condition information is set</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> */</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">bool</span> <a class="code" href="group__condition.html#ga42e27e6830b6e29c1a3c769516cd706e">pn_condition_is_set</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/**</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * Clears the condition object of any exceptional information. After</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * calling ::pn_condition_clear(), ::pn_condition_is_set() is</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * guaranteed to return false and ::pn_condition_get_name() as well as</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * ::pn_condition_get_description() will return NULL. The ::pn_data_t</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * returned by ::pn_condition_info() will still be valid, but will</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * have been cleared as well (See ::pn_data_clear()).</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> *</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * @param[in] condition the condition object to clear</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">void</span> <a class="code" href="group__condition.html#ga038f092914fc0fd8ae3713a537e34a05">pn_condition_clear</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">/**</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * Returns the name associated with the exceptional condition, or NULL</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * if there is no conditional information set.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> *</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @return a pointer to the name, or NULL</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> */</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__condition.html#ga8bb1e8261bb4c49b20e09d4015d3f8f1">pn_condition_get_name</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/**</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * Sets the name associated with the exceptional condition.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> *</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @param[in] name the desired name</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @return an error code or 0 on success</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> */</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">int</span> <a class="code" href="group__condition.html#ga2ae7b345d3dc1417766e23bf8435cf29">pn_condition_set_name</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/**</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * Gets the description associated with the exceptional condition.</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> *</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @return a pointer to the description, or NULL</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> */</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__condition.html#ga4cb8ef00e5050a0dfa022a89e44724e1">pn_condition_get_description</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/**</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * Sets the description associated with the exceptional condition.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> *</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param[in] description the desired description</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @return an error code or 0 on success</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> */</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">int</span> <a class="code" href="group__condition.html#gac20f81e06aa0efb5f5a23b141b36be7b">pn_condition_set_description</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition, <span class="keyword">const</span> <span class="keywordtype">char</span> *description);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">/**</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * Returns a data object that holds the additional information</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * associated with the condition. The data object may be used both to</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * access and to modify the additional information associated with the</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * condition.</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> *</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @return a data object holding the additional information for the condition</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="code" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> *<a class="code" href="group__condition.html#ga6ce699cd410d7cef3de1ee97e975720a">pn_condition_info</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">/**</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * Returns true if the condition is a redirect.</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> *</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * @return true if the condition is a redirect, false otherwise</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> */</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">bool</span> <a class="code" href="group__condition.html#gaaab127d4d71648f675858e9a250f73b3">pn_condition_is_redirect</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"></span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/**</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * Retrieves the redirect host from the additional information</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * associated with the condition. If the condition is not a redirect,</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * this will return NULL.</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> *</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @return the redirect host or NULL</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> */</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__condition.html#ga6a226262df61311f33a6d5075b15ce41">pn_condition_redirect_host</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"></span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/**</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * Retrieves the redirect port from the additional information</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * associated with the condition. If the condition is not a redirect,</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * this will return an error code.</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> *</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param[in] condition the condition object</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @return the redirect port or an error code</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> */</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <a class="code" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <span class="keywordtype">int</span> <a class="code" href="group__condition.html#ga09cf10e3bb03d63a12b8d7bb91bc810f">pn_condition_redirect_port</a>(<a class="code" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">/** @}</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> */</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> }</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#endif </span><span class="comment">/* condition.h */</span><span class="preprocessor"></span></div><div class="ttc" id="import__export_8h_html"><div class="ttname"><a href="import__export_8h.html">import_export.h</a></div></div>
<div class="ttc" id="group__condition_html_gaaab127d4d71648f675858e9a250f73b3"><div class="ttname"><a href="group__condition.html#gaaab127d4d71648f675858e9a250f73b3">pn_condition_is_redirect</a></div><div class="ttdeci">PN_EXTERN bool pn_condition_is_redirect(pn_condition_t *condition)</div><div class="ttdoc">Returns true if the condition is a redirect. </div></div>
<div class="ttc" id="group__condition_html_gac20f81e06aa0efb5f5a23b141b36be7b"><div class="ttname"><a href="group__condition.html#gac20f81e06aa0efb5f5a23b141b36be7b">pn_condition_set_description</a></div><div class="ttdeci">PN_EXTERN int pn_condition_set_description(pn_condition_t *condition, const char *description)</div><div class="ttdoc">Sets the description associated with the exceptional condition. </div></div>
<div class="ttc" id="codec_8h_html"><div class="ttname"><a href="codec_8h.html">codec.h</a></div><div class="ttdoc">Data API for proton. </div></div>
<div class="ttc" id="group__condition_html_ga09cf10e3bb03d63a12b8d7bb91bc810f"><div class="ttname"><a href="group__condition.html#ga09cf10e3bb03d63a12b8d7bb91bc810f">pn_condition_redirect_port</a></div><div class="ttdeci">PN_EXTERN int pn_condition_redirect_port(pn_condition_t *condition)</div><div class="ttdoc">Retrieves the redirect port from the additional information associated with the condition. </div></div>
<div class="ttc" id="group__condition_html_ga6a226262df61311f33a6d5075b15ce41"><div class="ttname"><a href="group__condition.html#ga6a226262df61311f33a6d5075b15ce41">pn_condition_redirect_host</a></div><div class="ttdeci">PN_EXTERN const char * pn_condition_redirect_host(pn_condition_t *condition)</div><div class="ttdoc">Retrieves the redirect host from the additional information associated with the condition. </div></div>
<div class="ttc" id="type__compat_8h_html"><div class="ttname"><a href="type__compat_8h.html">type_compat.h</a></div></div>
<div class="ttc" id="group__condition_html_ga42e27e6830b6e29c1a3c769516cd706e"><div class="ttname"><a href="group__condition.html#ga42e27e6830b6e29c1a3c769516cd706e">pn_condition_is_set</a></div><div class="ttdeci">PN_EXTERN bool pn_condition_is_set(pn_condition_t *condition)</div><div class="ttdoc">Returns true if the condition object is holding some information, i.e. </div></div>
<div class="ttc" id="import__export_8h_html_acfa9628d87130a64f95ee17c57a7c13b"><div class="ttname"><a href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a></div><div class="ttdeci">#define PN_EXTERN</div><div class="ttdef"><b>Definition:</b> import_export.h:53</div></div>
<div class="ttc" id="group__condition_html_ga6ce699cd410d7cef3de1ee97e975720a"><div class="ttname"><a href="group__condition.html#ga6ce699cd410d7cef3de1ee97e975720a">pn_condition_info</a></div><div class="ttdeci">PN_EXTERN pn_data_t * pn_condition_info(pn_condition_t *condition)</div><div class="ttdoc">Returns a data object that holds the additional information associated with the condition. </div></div>
<div class="ttc" id="group__condition_html_ga2ae7b345d3dc1417766e23bf8435cf29"><div class="ttname"><a href="group__condition.html#ga2ae7b345d3dc1417766e23bf8435cf29">pn_condition_set_name</a></div><div class="ttdeci">PN_EXTERN int pn_condition_set_name(pn_condition_t *condition, const char *name)</div><div class="ttdoc">Sets the name associated with the exceptional condition. </div></div>
<div class="ttc" id="group__condition_html_ga4cb8ef00e5050a0dfa022a89e44724e1"><div class="ttname"><a href="group__condition.html#ga4cb8ef00e5050a0dfa022a89e44724e1">pn_condition_get_description</a></div><div class="ttdeci">PN_EXTERN const char * pn_condition_get_description(pn_condition_t *condition)</div><div class="ttdoc">Gets the description associated with the exceptional condition. </div></div>
<div class="ttc" id="group__data_html_ga5d6cf528776e8b6ad6d67caf095986bf"><div class="ttname"><a href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a></div><div class="ttdeci">struct pn_data_t pn_data_t</div><div class="ttdoc">An AMQP Data object. </div><div class="ttdef"><b>Definition:</b> codec.h:358</div></div>
<div class="ttc" id="group__condition_html_ga11eb7db7d2c205169fe3d47c996a95a5"><div class="ttname"><a href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a></div><div class="ttdeci">struct pn_condition_t pn_condition_t</div><div class="ttdoc">An AMQP Condition object. </div><div class="ttdef"><b>Definition:</b> condition.h:64</div></div>
<div class="ttc" id="group__condition_html_ga8bb1e8261bb4c49b20e09d4015d3f8f1"><div class="ttname"><a href="group__condition.html#ga8bb1e8261bb4c49b20e09d4015d3f8f1">pn_condition_get_name</a></div><div class="ttdeci">PN_EXTERN const char * pn_condition_get_name(pn_condition_t *condition)</div><div class="ttdoc">Returns the name associated with the exceptional condition, or NULL if there is no conditional inform...</div></div>
<div class="ttc" id="group__condition_html_ga038f092914fc0fd8ae3713a537e34a05"><div class="ttname"><a href="group__condition.html#ga038f092914fc0fd8ae3713a537e34a05">pn_condition_clear</a></div><div class="ttdeci">PN_EXTERN void pn_condition_clear(pn_condition_t *condition)</div><div class="ttdoc">Clears the condition object of any exceptional information. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 4 2018 22:16:50 for proton by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|