Google Git
Sign in
eclipse / gerrit / www.eclipse.org / paho / b33673453ec91c9b6e1d0d3f9f68e7e14247e589 / . / files / cppdoc / classmqtt_1_1exception.html
blob: 7741709a53e16aa4fa7ff32718bfbb5bb19c3582 [file] [log] [blame]
<!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"/>
<title>mqttpp: mqtt::exception Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>mqtt</b>::<a class="el" href="classmqtt_1_1exception.html">exception</a>
</div>
</div>
<div class="contents">
<h1>mqtt::exception Class Reference</h1><!-- doxytag: class="mqtt::exception" -->
<p>Provides a mechanism for tracking the completion of an asynchronous action.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="exception_8h_source.html">exception.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mqtt::exception:</div>
<div class="dynsection">
<div class="center">
<img src="classmqtt_1_1exception.gif" usemap="#mqtt::exception_map" alt=""/>
<map id="mqtt::exception_map" name="mqtt::exception_map">
<area href="classmqtt_1_1persistence__exception.html" alt="mqtt::persistence_exception" shape="rect" coords="0,56,165,80"/>
<area href="classmqtt_1_1security__exception.html" alt="mqtt::security_exception" shape="rect" coords="175,56,340,80"/>
</map>
</div>
</div>
<p><a href="classmqtt_1_1exception-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89b7ecbe3c44449328d57e56b44fe40a"></a><!-- doxytag: member="mqtt::exception::exception" ref="a89b7ecbe3c44449328d57e56b44fe40a" args="(int reasonCode)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>exception</b> (int reasonCode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#a73a6898a5ebe4794c0bb04be6c88100e">get_message</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the underlying cause of this <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>, if available. <a href="#a73a6898a5ebe4794c0bb04be6c88100e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2480065a73ba2682e37246fdd1707d7"></a><!-- doxytag: member="mqtt::exception::get_reason_code" ref="ac2480065a73ba2682e37246fdd1707d7" args="() const " -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#ac2480065a73ba2682e37246fdd1707d7">get_reason_code</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the reason code for this <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#a91b0192de0a8a488c3cbdf67a63ad98e">to_str</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a String representation of this <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>. <a href="#a91b0192de0a8a488c3cbdf67a63ad98e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#a03843b4c0131ad7d08dc38d7d16cd6f2">what</a> () const noexcept</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns an explanatory string for the <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>. <a href="#a03843b4c0131ad7d08dc38d7d16cd6f2"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides a mechanism for tracking the completion of an asynchronous action. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a73a6898a5ebe4794c0bb04be6c88100e"></a><!-- doxytag: member="mqtt::exception::get_message" ref="a73a6898a5ebe4794c0bb04be6c88100e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mqtt::exception::get_message </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the underlying cause of this <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>, if available. </p>
<p>Returns the detail <a class="el" href="classmqtt_1_1message.html" title="An MQTT message holds the application payload and options specifying how the message...">message</a> for this <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>. </p>
</div>
</div>
<a class="anchor" id="a91b0192de0a8a488c3cbdf67a63ad98e"></a><!-- doxytag: member="mqtt::exception::to_str" ref="a91b0192de0a8a488c3cbdf67a63ad98e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mqtt::exception::to_str </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a String representation of this <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>std::tring </dd></dl>
</div>
</div>
<a class="anchor" id="a03843b4c0131ad7d08dc38d7d16cd6f2"></a><!-- doxytag: member="mqtt::exception::what" ref="a03843b4c0131ad7d08dc38d7d16cd6f2" args="() const noexcept" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* mqtt::exception::what </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an explanatory string for the <a class="el" href="classmqtt_1_1exception.html" title="Provides a mechanism for tracking the completion of an asynchronous action.">exception</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>const char* </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>mqtt/<a class="el" href="exception_8h_source.html">exception.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Apr 2014 for mqttpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>