/usr/share/proton-0.14.0/docs/api-c/group__condition.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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 | <!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: Condition</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>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Condition<div class="ingroups"><a class="el" href="group__engine.html">Engine</a> » <a class="el" href="group__connection.html">Connection</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga11eb7db7d2c205169fe3d47c996a95a5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a></td></tr>
<tr class="memdesc:ga11eb7db7d2c205169fe3d47c996a95a5"><td class="mdescLeft"> </td><td class="mdescRight">An AMQP Condition object. <a href="#ga11eb7db7d2c205169fe3d47c996a95a5">More...</a><br /></td></tr>
<tr class="separator:ga11eb7db7d2c205169fe3d47c996a95a5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga42e27e6830b6e29c1a3c769516cd706e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga42e27e6830b6e29c1a3c769516cd706e">pn_condition_is_set</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga42e27e6830b6e29c1a3c769516cd706e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the condition object is holding some information, i.e. <a href="#ga42e27e6830b6e29c1a3c769516cd706e">More...</a><br /></td></tr>
<tr class="separator:ga42e27e6830b6e29c1a3c769516cd706e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga038f092914fc0fd8ae3713a537e34a05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga038f092914fc0fd8ae3713a537e34a05">pn_condition_clear</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga038f092914fc0fd8ae3713a537e34a05"><td class="mdescLeft"> </td><td class="mdescRight">Clears the condition object of any exceptional information. <a href="#ga038f092914fc0fd8ae3713a537e34a05">More...</a><br /></td></tr>
<tr class="separator:ga038f092914fc0fd8ae3713a537e34a05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bb1e8261bb4c49b20e09d4015d3f8f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga8bb1e8261bb4c49b20e09d4015d3f8f1">pn_condition_get_name</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga8bb1e8261bb4c49b20e09d4015d3f8f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name associated with the exceptional condition, or NULL if there is no conditional information set. <a href="#ga8bb1e8261bb4c49b20e09d4015d3f8f1">More...</a><br /></td></tr>
<tr class="separator:ga8bb1e8261bb4c49b20e09d4015d3f8f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ae7b345d3dc1417766e23bf8435cf29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga2ae7b345d3dc1417766e23bf8435cf29">pn_condition_set_name</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition, const char *name)</td></tr>
<tr class="memdesc:ga2ae7b345d3dc1417766e23bf8435cf29"><td class="mdescLeft"> </td><td class="mdescRight">Sets the name associated with the exceptional condition. <a href="#ga2ae7b345d3dc1417766e23bf8435cf29">More...</a><br /></td></tr>
<tr class="separator:ga2ae7b345d3dc1417766e23bf8435cf29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4cb8ef00e5050a0dfa022a89e44724e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga4cb8ef00e5050a0dfa022a89e44724e1">pn_condition_get_description</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga4cb8ef00e5050a0dfa022a89e44724e1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the description associated with the exceptional condition. <a href="#ga4cb8ef00e5050a0dfa022a89e44724e1">More...</a><br /></td></tr>
<tr class="separator:ga4cb8ef00e5050a0dfa022a89e44724e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac20f81e06aa0efb5f5a23b141b36be7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#gac20f81e06aa0efb5f5a23b141b36be7b">pn_condition_set_description</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition, const char *description)</td></tr>
<tr class="memdesc:gac20f81e06aa0efb5f5a23b141b36be7b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the description associated with the exceptional condition. <a href="#gac20f81e06aa0efb5f5a23b141b36be7b">More...</a><br /></td></tr>
<tr class="separator:gac20f81e06aa0efb5f5a23b141b36be7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ce699cd410d7cef3de1ee97e975720a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga6ce699cd410d7cef3de1ee97e975720a">pn_condition_info</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga6ce699cd410d7cef3de1ee97e975720a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a data object that holds the additional information associated with the condition. <a href="#ga6ce699cd410d7cef3de1ee97e975720a">More...</a><br /></td></tr>
<tr class="separator:ga6ce699cd410d7cef3de1ee97e975720a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaab127d4d71648f675858e9a250f73b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#gaaab127d4d71648f675858e9a250f73b3">pn_condition_is_redirect</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:gaaab127d4d71648f675858e9a250f73b3"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the condition is a redirect. <a href="#gaaab127d4d71648f675858e9a250f73b3">More...</a><br /></td></tr>
<tr class="separator:gaaab127d4d71648f675858e9a250f73b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a226262df61311f33a6d5075b15ce41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga6a226262df61311f33a6d5075b15ce41">pn_condition_redirect_host</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga6a226262df61311f33a6d5075b15ce41"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the redirect host from the additional information associated with the condition. <a href="#ga6a226262df61311f33a6d5075b15ce41">More...</a><br /></td></tr>
<tr class="separator:ga6a226262df61311f33a6d5075b15ce41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga09cf10e3bb03d63a12b8d7bb91bc810f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga09cf10e3bb03d63a12b8d7bb91bc810f">pn_condition_redirect_port</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *condition)</td></tr>
<tr class="memdesc:ga09cf10e3bb03d63a12b8d7bb91bc810f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the redirect port from the additional information associated with the condition. <a href="#ga09cf10e3bb03d63a12b8d7bb91bc810f">More...</a><br /></td></tr>
<tr class="separator:ga09cf10e3bb03d63a12b8d7bb91bc810f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga11eb7db7d2c205169fe3d47c996a95a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11eb7db7d2c205169fe3d47c996a95a5">◆ </a></span>pn_condition_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An AMQP Condition object. </p>
<p>Conditions hold exceptional information pertaining to the closing of an AMQP endpoint such as a Connection, Session, or Link. Conditions also hold similar information pertaining to deliveries that have reached terminal states. Connections, Sessions, Links, and Deliveries may all have local and remote conditions associated with them.</p>
<p>The local condition may be modified by the local endpoint to signal a particular condition to the remote peer. The remote condition may be examined by the local endpoint to detect whatever condition the remote peer may be signaling. Although often conditions are used to indicate errors, not all conditions are errors per/se, e.g. conditions may be used to redirect a connection from one host to another.</p>
<p>Every condition has a short symbolic name, a longer description, and an additional info map associated with it. The name identifies the formally defined condition, and the map contains additional information relevant to the identified condition. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga038f092914fc0fd8ae3713a537e34a05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga038f092914fc0fd8ae3713a537e34a05">◆ </a></span>pn_condition_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> void pn_condition_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the condition object of any exceptional information. </p>
<p>After calling <a class="el" href="group__condition.html#ga038f092914fc0fd8ae3713a537e34a05" title="Clears the condition object of any exceptional information. ">pn_condition_clear()</a>, <a class="el" href="group__condition.html#ga42e27e6830b6e29c1a3c769516cd706e" title="Returns true if the condition object is holding some information, i.e. ">pn_condition_is_set()</a> is guaranteed to return false and <a class="el" href="group__condition.html#ga8bb1e8261bb4c49b20e09d4015d3f8f1" title="Returns the name associated with the exceptional condition, or NULL if there is no conditional inform...">pn_condition_get_name()</a> as well as <a class="el" href="group__condition.html#ga4cb8ef00e5050a0dfa022a89e44724e1" title="Gets the description associated with the exceptional condition. ">pn_condition_get_description()</a> will return NULL. The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf" title="An AMQP Data object. ">pn_data_t</a> returned by <a class="el" href="group__condition.html#ga6ce699cd410d7cef3de1ee97e975720a" title="Returns a data object that holds the additional information associated with the condition. ">pn_condition_info()</a> will still be valid, but will have been cleared as well (See <a class="el" href="group__data.html#gadcd2302af4138df54c4746a63d5d1126" title="Clears a pn_data_t object. ">pn_data_clear()</a>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object to clear </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga4cb8ef00e5050a0dfa022a89e44724e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4cb8ef00e5050a0dfa022a89e44724e1">◆ </a></span>pn_condition_get_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_condition_get_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the description associated with the exceptional condition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the description, or NULL </dd></dl>
</div>
</div>
<a id="ga8bb1e8261bb4c49b20e09d4015d3f8f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8bb1e8261bb4c49b20e09d4015d3f8f1">◆ </a></span>pn_condition_get_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_condition_get_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name associated with the exceptional condition, or NULL if there is no conditional information set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the name, or NULL </dd></dl>
</div>
</div>
<a id="ga6ce699cd410d7cef3de1ee97e975720a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ce699cd410d7cef3de1ee97e975720a">◆ </a></span>pn_condition_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a>* pn_condition_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a data object that holds the additional information associated with the condition. </p>
<p>The data object may be used both to access and to modify the additional information associated with the condition.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a data object holding the additional information for the condition </dd></dl>
</div>
</div>
<a id="gaaab127d4d71648f675858e9a250f73b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaab127d4d71648f675858e9a250f73b3">◆ </a></span>pn_condition_is_redirect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_condition_is_redirect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the condition is a redirect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the condition is a redirect, false otherwise </dd></dl>
</div>
</div>
<a id="ga42e27e6830b6e29c1a3c769516cd706e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42e27e6830b6e29c1a3c769516cd706e">◆ </a></span>pn_condition_is_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> bool pn_condition_is_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the condition object is holding some information, i.e. </p>
<p>if the name is set to some non NULL value. Returns false otherwise.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object to test </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff some condition information is set </dd></dl>
</div>
</div>
<a id="ga6a226262df61311f33a6d5075b15ce41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6a226262df61311f33a6d5075b15ce41">◆ </a></span>pn_condition_redirect_host()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> const char* pn_condition_redirect_host </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the redirect host from the additional information associated with the condition. </p>
<p>If the condition is not a redirect, this will return NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the redirect host or NULL </dd></dl>
</div>
</div>
<a id="ga09cf10e3bb03d63a12b8d7bb91bc810f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga09cf10e3bb03d63a12b8d7bb91bc810f">◆ </a></span>pn_condition_redirect_port()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_condition_redirect_port </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the redirect port from the additional information associated with the condition. </p>
<p>If the condition is not a redirect, this will return an error code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the redirect port or an error code </dd></dl>
</div>
</div>
<a id="gac20f81e06aa0efb5f5a23b141b36be7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac20f81e06aa0efb5f5a23b141b36be7b">◆ </a></span>pn_condition_set_description()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_condition_set_description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>description</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the description associated with the exceptional condition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">description</td><td>the desired description </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an error code or 0 on success </dd></dl>
</div>
</div>
<a id="ga2ae7b345d3dc1417766e23bf8435cf29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ae7b345d3dc1417766e23bf8435cf29">◆ </a></span>pn_condition_set_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="import__export_8h.html#acfa9628d87130a64f95ee17c57a7c13b">PN_EXTERN</a> int pn_condition_set_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td>
<td class="paramname"><em>condition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the name associated with the exceptional condition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">condition</td><td>the condition object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the desired name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an error code or 0 on success </dd></dl>
</div>
</div>
</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>
|