| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.20"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Qpid Proton C++ API: error_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="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Qpid Proton C++ API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classproton_1_1error__condition.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classproton_1_1error__condition-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">error_condition</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Describes an endpoint error state. |
| <a href="classproton_1_1error__condition.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="error__condition_8hpp_source.html">error_condition.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a66ce60ce079e6a9446d8dad21b9a63bb"><td class="memItemLeft" align="right" valign="top"><a id="a66ce60ce079e6a9446d8dad21b9a63bb"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a66ce60ce079e6a9446d8dad21b9a63bb">error_condition</a> ()</td></tr> |
| <tr class="memdesc:a66ce60ce079e6a9446d8dad21b9a63bb"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty error condition. <br /></td></tr> |
| <tr class="separator:a66ce60ce079e6a9446d8dad21b9a63bb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f32954b9494f55fa28e99c3402f254b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a4f32954b9494f55fa28e99c3402f254b">error_condition</a> (std::string <a class="el" href="classproton_1_1error__condition.html#a07ffe70037e0a16554c868bcdd8f83b5">description</a>)</td></tr> |
| <tr class="memdesc:a4f32954b9494f55fa28e99c3402f254b"><td class="mdescLeft"> </td><td class="mdescRight">Create an error condition with only a description. <a href="classproton_1_1error__condition.html#a4f32954b9494f55fa28e99c3402f254b">More...</a><br /></td></tr> |
| <tr class="separator:a4f32954b9494f55fa28e99c3402f254b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab882b2726f7171112feba9d03ff9a588"><td class="memItemLeft" align="right" valign="top"><a id="ab882b2726f7171112feba9d03ff9a588"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#ab882b2726f7171112feba9d03ff9a588">error_condition</a> (std::string <a class="el" href="classproton_1_1error__condition.html#a1d89c28bd42ba9a52da008bb69367171">name</a>, std::string <a class="el" href="classproton_1_1error__condition.html#a07ffe70037e0a16554c868bcdd8f83b5">description</a>)</td></tr> |
| <tr class="memdesc:ab882b2726f7171112feba9d03ff9a588"><td class="mdescLeft"> </td><td class="mdescRight">Create an error condition with a name and description. <br /></td></tr> |
| <tr class="separator:ab882b2726f7171112feba9d03ff9a588"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7f06478c5510128d7cf62b394161b9b3"><td class="memItemLeft" align="right" valign="top"><a id="a7f06478c5510128d7cf62b394161b9b3"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a7f06478c5510128d7cf62b394161b9b3">error_condition</a> (std::string <a class="el" href="classproton_1_1error__condition.html#a1d89c28bd42ba9a52da008bb69367171">name</a>, std::string <a class="el" href="classproton_1_1error__condition.html#a07ffe70037e0a16554c868bcdd8f83b5">description</a>, <a class="el" href="classproton_1_1value.html">proton::value</a> <a class="el" href="classproton_1_1error__condition.html#ac692ae9e7014e2ef47673c9201a98cf6">properties</a>)</td></tr> |
| <tr class="memdesc:a7f06478c5510128d7cf62b394161b9b3"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettled API</b> - Create an error condition with name, description, and informational properties. <br /></td></tr> |
| <tr class="separator:a7f06478c5510128d7cf62b394161b9b3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67b76affb3b5d35fa419ac234144038b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a67b76affb3b5d35fa419ac234144038b">operator bool</a> () const</td></tr> |
| <tr class="memdesc:a67b76affb3b5d35fa419ac234144038b"><td class="mdescLeft"> </td><td class="mdescRight">If you are using a C++11 compiler, you may use an <a class="el" href="classproton_1_1error__condition.html" title="Describes an endpoint error state.">error_condition</a> in boolean contexts. <a href="classproton_1_1error__condition.html#a67b76affb3b5d35fa419ac234144038b">More...</a><br /></td></tr> |
| <tr class="separator:a67b76affb3b5d35fa419ac234144038b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61efd4196a96540ee018fee8791f3f10"><td class="memItemLeft" align="right" valign="top"><a id="a61efd4196a96540ee018fee8791f3f10"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a61efd4196a96540ee018fee8791f3f10">operator!</a> () const</td></tr> |
| <tr class="memdesc:a61efd4196a96540ee018fee8791f3f10"><td class="mdescLeft"> </td><td class="mdescRight">No condition set. <br /></td></tr> |
| <tr class="separator:a61efd4196a96540ee018fee8791f3f10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr> |
| <tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="mdescLeft"> </td><td class="mdescRight">No condition has been set. <br /></td></tr> |
| <tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d89c28bd42ba9a52da008bb69367171"><td class="memItemLeft" align="right" valign="top"><a id="a1d89c28bd42ba9a52da008bb69367171"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr> |
| <tr class="memdesc:a1d89c28bd42ba9a52da008bb69367171"><td class="mdescLeft"> </td><td class="mdescRight">Condition name. <br /></td></tr> |
| <tr class="separator:a1d89c28bd42ba9a52da008bb69367171"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a07ffe70037e0a16554c868bcdd8f83b5"><td class="memItemLeft" align="right" valign="top"><a id="a07ffe70037e0a16554c868bcdd8f83b5"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#a07ffe70037e0a16554c868bcdd8f83b5">description</a> () const</td></tr> |
| <tr class="memdesc:a07ffe70037e0a16554c868bcdd8f83b5"><td class="mdescLeft"> </td><td class="mdescRight">Descriptive string for condition. <br /></td></tr> |
| <tr class="separator:a07ffe70037e0a16554c868bcdd8f83b5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac692ae9e7014e2ef47673c9201a98cf6"><td class="memItemLeft" align="right" valign="top"><a id="ac692ae9e7014e2ef47673c9201a98cf6"></a> |
| <a class="el" href="classproton_1_1value.html">value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#ac692ae9e7014e2ef47673c9201a98cf6">properties</a> () const</td></tr> |
| <tr class="memdesc:ac692ae9e7014e2ef47673c9201a98cf6"><td class="mdescLeft"> </td><td class="mdescRight">Extra information for condition. <br /></td></tr> |
| <tr class="separator:ac692ae9e7014e2ef47673c9201a98cf6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad2e53bd52dbb1d59081ee7f9f1efc2ac"><td class="memItemLeft" align="right" valign="top"><a id="ad2e53bd52dbb1d59081ee7f9f1efc2ac"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1error__condition.html#ad2e53bd52dbb1d59081ee7f9f1efc2ac">what</a> () const</td></tr> |
| <tr class="memdesc:ad2e53bd52dbb1d59081ee7f9f1efc2ac"><td class="mdescLeft"> </td><td class="mdescRight">Simple printable string for condition. <br /></td></tr> |
| <tr class="separator:ad2e53bd52dbb1d59081ee7f9f1efc2ac"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Describes an endpoint error state. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8cpp-example.html#_a28">broker.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a19">multithreaded_client.cpp</a>, and <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a15">multithreaded_client_flow_control.cpp</a>.</dd> |
| </dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a4f32954b9494f55fa28e99c3402f254b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4f32954b9494f55fa28e99c3402f254b">◆ </a></span>error_condition()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classproton_1_1error__condition.html">error_condition</a> </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>description</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an error condition with only a description. </p> |
| <p>A default name will be used ("proton:io:error"). </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a67b76affb3b5d35fa419ac234144038b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a67b76affb3b5d35fa419ac234144038b">◆ </a></span>operator bool()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">operator bool </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>If you are using a C++11 compiler, you may use an <a class="el" href="classproton_1_1error__condition.html" title="Describes an endpoint error state.">error_condition</a> in boolean contexts. </p> |
| <p>The expression will be true if the <a class="el" href="classproton_1_1error__condition.html" title="Describes an endpoint error state.">error_condition</a> is set. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="error__condition_8hpp_source.html">error_condition.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1error__condition.html">error_condition</a></li> |
| <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
