http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.html b/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.html new file mode 100755 index 0000000..b438a43 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.html @@ -0,0 +1,498 @@ +<!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.3.1"/> +<title>Qpid Proton C API: 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">Qpid Proton C API +  <span id="projectnumber">0.15.0</span> + </div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('group__condition.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:vo id(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></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__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="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">PN_EXTERN 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="separator:ga42e27e6830b6e29c1a3c769516cd706e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga038f092914fc0fd8ae3713a537e34a05"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga038f092914fc0fd8ae3713a537e34a05"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8bb1e8261bb4c49b20e09d4015d3f8f1"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga8bb1e8261bb4c49b20e09d4015d3f8f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2ae7b345d3dc1417766e23bf8435cf29"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga2ae7b345d3dc1417766e23bf8435cf29"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4cb8ef00e5050a0dfa022a89e44724e1"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga4cb8ef00e5050a0dfa022a89e44724e1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac20f81e06aa0efb5f5a23b141b36be7b"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:gac20f81e06aa0efb5f5a23b141b36be7b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6ce699cd410d7cef3de1ee97e975720a"><td class="memItemLeft" align="right" valign="top">PN_EXTERN <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="separator:ga6ce699cd410d7cef3de1ee97e975720a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7512764aec8ea62dec4749aae44478a4"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga7512764aec8ea62dec4749aae44478a4">pn_condition_vformat</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *, const char *name, const char *fmt, va_list ap)</td></tr> +<tr class="separator:ga7512764aec8ea62dec4749aae44478a4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga1fcf90bc3cbf8463351a50d8aaf6f8b3"><td class="memItemLeft" align="right" valign="top">PN_EXTERN int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__condition.html#ga1fcf90bc3cbf8463351a50d8aaf6f8b3">pn_condition_format</a> (<a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *, const char *name, const char *fmt,...)</td></tr> +<tr class="separator:ga1fcf90bc3cbf8463351a50d8aaf6f8b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaaab127d4d71648f675858e9a250f73b3"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:gaaab127d4d71648f675858e9a250f73b3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6a226262df61311f33a6d5075b15ce41"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="separator:ga6a226262df61311f33a6d5075b15ce41"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga09cf10e3bb03d63a12b8d7bb91bc810f"><td class="memItemLeft" align="right" valign="top">PN_EXTERN 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="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 class="anchor" id="ga11eb7db7d2c205169fe3d47c996a95a5"></a> +<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. 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 class="anchor" id="ga038f092914fc0fd8ae3713a537e34a05"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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. After calling <a class="el" href="group__condition.html#ga038f092914fc0fd8ae3713a537e34a05">pn_condition_clear()</a>, <a class="el" href="group__condition.html#ga42e27e6830b6e29c1a3c769516cd706e">pn_condition_is_set()</a> is guaranteed to return false and <a class="el" href="group__condition.html#ga8bb1e8261bb4c49b20e09d4015d3f8f1">pn_condition_get_name()</a> as well as <a class="el" href="group__condition.html#ga4cb8ef00e5050a0dfa022a89e44724e1">pn_condition_get_description()</a> will return NULL. The <a class="el" href="group__data.html#ga5d6cf528776e8b6ad6d67caf095986bf">pn_data_t</a> returned by <a class="el" href="group__condition.html#ga6ce699cd410d7cef3de1ee97e975720a">pn_condition_info()</a> will still be valid, but will have been cleared as well (See <a class="el" href="group__data.html#gadcd2302af4138df54c4746a63d5d1126">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 class="anchor" id="ga1fcf90bc3cbf8463351a50d8aaf6f8b3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_condition_format </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td> + <td class="paramname">, </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 class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>fmt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"><em>...</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the name and printf-style formatted description. </p> + +</div> +</div> +<a class="anchor" id="ga4cb8ef00e5050a0dfa022a89e44724e1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga8bb1e8261bb4c49b20e09d4015d3f8f1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga6ce699cd410d7cef3de1ee97e975720a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN <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. 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 class="anchor" id="gaaab127d4d71648f675858e9a250f73b3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga42e27e6830b6e29c1a3c769516cd706e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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. 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 class="anchor" id="ga6a226262df61311f33a6d5075b15ce41"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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. 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 class="anchor" id="ga09cf10e3bb03d63a12b8d7bb91bc810f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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. 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 class="anchor" id="gac20f81e06aa0efb5f5a23b141b36be7b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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 class="anchor" id="ga2ae7b345d3dc1417766e23bf8435cf29"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN 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> +<a class="anchor" id="ga7512764aec8ea62dec4749aae44478a4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PN_EXTERN int pn_condition_vformat </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td> + <td class="paramname">, </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 class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>fmt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">va_list </td> + <td class="paramname"><em>ap</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the name and printf-style formatted description. </p> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html";> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li> + </ul> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/de3c3488/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.js b/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.js new file mode 100755 index 0000000..e665243 --- /dev/null +++ b/content/releases/qpid-proton-0.15.0/proton/c/api/group__condition.js @@ -0,0 +1,16 @@ +var group__condition = +[ + [ "pn_condition_t", "group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5", null ], + [ "pn_condition_clear", "group__condition.html#ga038f092914fc0fd8ae3713a537e34a05", null ], + [ "pn_condition_format", "group__condition.html#ga1fcf90bc3cbf8463351a50d8aaf6f8b3", null ], + [ "pn_condition_get_description", "group__condition.html#ga4cb8ef00e5050a0dfa022a89e44724e1", null ], + [ "pn_condition_get_name", "group__condition.html#ga8bb1e8261bb4c49b20e09d4015d3f8f1", null ], + [ "pn_condition_info", "group__condition.html#ga6ce699cd410d7cef3de1ee97e975720a", null ], + [ "pn_condition_is_redirect", "group__condition.html#gaaab127d4d71648f675858e9a250f73b3", null ], + [ "pn_condition_is_set", "group__condition.html#ga42e27e6830b6e29c1a3c769516cd706e", null ], + [ "pn_condition_redirect_host", "group__condition.html#ga6a226262df61311f33a6d5075b15ce41", null ], + [ "pn_condition_redirect_port", "group__condition.html#ga09cf10e3bb03d63a12b8d7bb91bc810f", null ], + [ "pn_condition_set_description", "group__condition.html#gac20f81e06aa0efb5f5a23b141b36be7b", null ], + [ "pn_condition_set_name", "group__condition.html#ga2ae7b345d3dc1417766e23bf8435cf29", null ], + [ "pn_condition_vformat", "group__condition.html#ga7512764aec8ea62dec4749aae44478a4", null ] +]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
