Google Git
Sign in
apache / activemq-website / 254c925c8b9c5da093d15047d12a2037ed564fcb / . / src / components / cms / api_docs / activemqcpp-3.4.0 / html / classdecaf_1_1net_1_1_socket_exception.html
blob: 791febaa33b08ee0b86e96e2853e5f248ccdd118 [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>activemq-cpp-3.4.0: decaf::net::SocketException Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">activemq-cpp-3.4.0</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classdecaf_1_1net_1_1_socket_exception.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>decaf::net::SocketException Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="decaf::net::SocketException" --><!-- doxytag: inherits="decaf::io::IOException" -->
<p>Exception for errors when manipulating sockets.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_socket_exception_8h_source.html">src/main/decaf/net/SocketException.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for decaf::net::SocketException:</div>
<div class="dyncontent">
<div class="center"><img src="classdecaf_1_1net_1_1_socket_exception__inherit__graph.png" border="0" usemap="#decaf_1_1net_1_1_socket_exception_inherit__map" alt="Inheritance graph"/></div>
<map name="decaf_1_1net_1_1_socket_exception_inherit__map" id="decaf_1_1net_1_1_socket_exception_inherit__map">
<area shape="rect" id="node9" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_socket_exception.html" title="Subclass of the standard SocketException that knows how to produce an error message from the OpenSSL ..." alt="" coords="944,5,1371,35"/><area shape="rect" id="node11" href="classdecaf_1_1net_1_1_bind_exception.html" title="decaf::net::BindException" alt="" coords="1057,59,1257,88"/><area shape="rect" id="node13" href="classdecaf_1_1net_1_1_connect_exception.html" title="decaf::net::ConnectException" alt="" coords="1043,112,1272,141"/><area shape="rect" id="node15" href="classdecaf_1_1net_1_1_no_route_to_host_exception.html" title="decaf::net::NoRouteToHostException" alt="" coords="1019,165,1296,195"/><area shape="rect" id="node17" href="classdecaf_1_1net_1_1_port_unreachable_exception.html" title="decaf::net::PortUnreachableException" alt="" coords="1016,219,1299,248"/><area shape="rect" id="node2" href="classdecaf_1_1io_1_1_i_o_exception.html" title="decaf::io::IOException" alt="" coords="455,112,628,141"/><area shape="rect" id="node4" href="classdecaf_1_1lang_1_1_exception.html" title="decaf::lang::Exception" alt="" coords="231,112,404,141"/><area shape="rect" id="node6" href="classdecaf_1_1lang_1_1_throwable.html" title="This class represents an error that has occurred." alt="" coords="7,112,180,141"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#a2c5f08f92c6c1a86db6d8a6e4dcc1524">SocketException</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#af7a17fbe21e47d3542af89ff5121f93f">SocketException</a> (const <a class="el" href="classdecaf_1_1lang_1_1_exception.html">lang::Exception</a> &amp;ex) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#a74fa3c3e87dc3f40d86d85d66fe90fc9">SocketException</a> (const <a class="el" href="classdecaf_1_1net_1_1_socket_exception.html">SocketException</a> &amp;ex) throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#a9295abbc4a358ce293bafae84d1526d1">SocketException</a> (const char *file, const int lineNumber, const std::exception *<a class="el" href="classdecaf_1_1lang_1_1_exception.html#a0f15a2e2a8f39bbcf3594575f260e3be">cause</a>, const char *msg,...) throw ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor - Initializes the file name and line number where this message occurred. <a href="#a9295abbc4a358ce293bafae84d1526d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#a9edb10478b364c2406ea401fda4d7fd3">SocketException</a> (const std::exception *<a class="el" href="classdecaf_1_1lang_1_1_exception.html#a0f15a2e2a8f39bbcf3594575f260e3be">cause</a>) throw ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a9edb10478b364c2406ea401fda4d7fd3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#afa6acd4b9c5e2e37163e3de66254dad8">SocketException</a> (const char *file, const int lineNumber, const char *msg,...) throw ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor - Initializes the file name and line number where this message occurred. <a href="#afa6acd4b9c5e2e37163e3de66254dad8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classdecaf_1_1net_1_1_socket_exception.html">SocketException</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#a06266cddeca411c994e412d9ccc8629c">clone</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clones this exception. <a href="#a06266cddeca411c994e412d9ccc8629c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html#a3cc67dca9055d28397774b46438b13c3">~SocketException</a> () throw ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Exception for errors when manipulating sockets. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2c5f08f92c6c1a86db6d8a6e4dcc1524"></a><!-- doxytag: member="decaf::net::SocketException::SocketException" ref="a2c5f08f92c6c1a86db6d8a6e4dcc1524" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::net::SocketException::SocketException </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af7a17fbe21e47d3542af89ff5121f93f"></a><!-- doxytag: member="decaf::net::SocketException::SocketException" ref="af7a17fbe21e47d3542af89ff5121f93f" args="(const lang::Exception &amp;ex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::net::SocketException::SocketException </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdecaf_1_1lang_1_1_exception.html">lang::Exception</a> &amp;&#160;</td>
<td class="paramname"><em>ex</em></td><td>)</td>
<td> throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a74fa3c3e87dc3f40d86d85d66fe90fc9"></a><!-- doxytag: member="decaf::net::SocketException::SocketException" ref="a74fa3c3e87dc3f40d86d85d66fe90fc9" args="(const SocketException &amp;ex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::net::SocketException::SocketException </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classdecaf_1_1net_1_1_socket_exception.html">SocketException</a> &amp;&#160;</td>
<td class="paramname"><em>ex</em></td><td>)</td>
<td> throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9295abbc4a358ce293bafae84d1526d1"></a><!-- doxytag: member="decaf::net::SocketException::SocketException" ref="a9295abbc4a358ce293bafae84d1526d1" args="(const char *file, const int lineNumber, const std::exception *cause, const char *msg,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::net::SocketException::SocketException </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>lineNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::exception *&#160;</td>
<td class="paramname"><em>cause</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor - Initializes the file name and line number where this message occurred. </p>
<p>Sets the message to report, using an optional list of arguments to parse into the message </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The file name where exception occurs </td></tr>
<tr><td class="paramname">lineNumber</td><td>The line number where the exception occurred. </td></tr>
<tr><td class="paramname">cause</td><td>The exception that was the cause for this one to be thrown. </td></tr>
<tr><td class="paramname">msg</td><td>The message to report </td></tr>
<tr><td class="paramname">...</td><td>list of primitives that are formatted into the message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9edb10478b364c2406ea401fda4d7fd3"></a><!-- doxytag: member="decaf::net::SocketException::SocketException" ref="a9edb10478b364c2406ea401fda4d7fd3" args="(const std::exception *cause)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::net::SocketException::SocketException </td>
<td>(</td>
<td class="paramtype">const std::exception *&#160;</td>
<td class="paramname"><em>cause</em></td><td>)</td>
<td> throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cause</td><td>Pointer to the exception that caused this one to be thrown, the object is cloned caller retains ownership. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afa6acd4b9c5e2e37163e3de66254dad8"></a><!-- doxytag: member="decaf::net::SocketException::SocketException" ref="afa6acd4b9c5e2e37163e3de66254dad8" args="(const char *file, const int lineNumber, const char *msg,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::net::SocketException::SocketException </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>lineNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor - Initializes the file name and line number where this message occurred. </p>
<p>Sets the message to report, using an optional list of arguments to parse into the message </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The file name where exception occurs </td></tr>
<tr><td class="paramname">lineNumber</td><td>The line number where the exception occurred. </td></tr>
<tr><td class="paramname">msg</td><td>The message to report </td></tr>
<tr><td class="paramname">...</td><td>list of primitives that are formatted into the message </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3cc67dca9055d28397774b46438b13c3"></a><!-- doxytag: member="decaf::net::SocketException::~SocketException" ref="a3cc67dca9055d28397774b46438b13c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual decaf::net::SocketException::~SocketException </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> throw ()<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a06266cddeca411c994e412d9ccc8629c"></a><!-- doxytag: member="decaf::net::SocketException::clone" ref="a06266cddeca411c994e412d9ccc8629c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classdecaf_1_1net_1_1_socket_exception.html">SocketException</a>* decaf::net::SocketException::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clones this exception. </p>
<p>This is useful for cases where you need to preserve the type of the original exception as well as the message. All subclasses should override.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a new Exception instance that is a copy of this Exception object. </dd></dl>
<p>Reimplemented from <a class="el" href="classdecaf_1_1io_1_1_i_o_exception.html#a106000a6c06bc588d7aa396e214871b3">decaf::io::IOException</a>.</p>
<p>Reimplemented in <a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_socket_exception.html#afdfe4d15a4e87756e7f3cef1c80bc05c">decaf::internal::net::ssl::openssl::OpenSSLSocketException</a>, <a class="el" href="classdecaf_1_1net_1_1_bind_exception.html#a3eb1e6d3a04607cff95cf998202ef710">decaf::net::BindException</a>, <a class="el" href="classdecaf_1_1net_1_1_connect_exception.html#aef18e7f6895da2cd9eaa896f07341807">decaf::net::ConnectException</a>, <a class="el" href="classdecaf_1_1net_1_1_no_route_to_host_exception.html#a1ac6b36ce248595b288ff81af4055d04">decaf::net::NoRouteToHostException</a>, and <a class="el" href="classdecaf_1_1net_1_1_port_unreachable_exception.html#a97e4f5ff988375f35b4e8eda3762f8cd">decaf::net::PortUnreachableException</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/main/decaf/net/<a class="el" href="_socket_exception_8h_source.html">SocketException.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedecaf.html">decaf</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1net.html">net</a> </li>
<li class="navelem"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html">SocketException</a> </li>
<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>