diff options
Diffstat (limited to 'doc/html/classSocketException.html')
| -rw-r--r-- | doc/html/classSocketException.html | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/doc/html/classSocketException.html b/doc/html/classSocketException.html new file mode 100644 index 0000000..25d3427 --- /dev/null +++ b/doc/html/classSocketException.html @@ -0,0 +1,137 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>anytun: SocketException Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.1 --> +<div class="tabs"> + <ul> + <li><a href="main.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li id="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 List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul></div> +<h1>SocketException Class Reference</h1><!-- doxytag: class="SocketException" --><code>#include <<a class="el" href="PracticalSocket_8h-source.html">PracticalSocket.h</a>></code> +<p> +<a href="classSocketException-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocketException.html#bb5bcecd9d9e20868c237ec5a82cf5c3">SocketException</a> (const string &message, bool inclSysMsg=false) throw ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocketException.html#659557c899329aea01977c980c4db9b9">~SocketException</a> () throw ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocketException.html#534b0625abe62cad2bae94758aa6eb42">what</a> () const throw ()</td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocketException.html#dcfeba6d4ce5754b48ae9d37b07a7e87">userMessage</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Signals a problem with the execution of a socket call. +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="bb5bcecd9d9e20868c237ec5a82cf5c3"></a><!-- doxytag: member="SocketException::SocketException" ref="bb5bcecd9d9e20868c237ec5a82cf5c3" args="(const string &message, bool inclSysMsg=false)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SocketException::SocketException </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"> <em>message</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>inclSysMsg</em> = <code>false</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> throw ()</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Construct a <a class="el" href="classSocketException.html">SocketException</a> with a explanatory message. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>explanatory message </td></tr> + <tr><td valign="top"></td><td valign="top"><em>incSysMsg</em> </td><td>true if system message (from strerror(errno)) should be postfixed to the user provided message </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="659557c899329aea01977c980c4db9b9"></a><!-- doxytag: member="SocketException::~SocketException" ref="659557c899329aea01977c980c4db9b9" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">SocketException::~SocketException </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> throw ()</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Provided just to guarantee that no exceptions are thrown. +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="534b0625abe62cad2bae94758aa6eb42"></a><!-- doxytag: member="SocketException::what" ref="534b0625abe62cad2bae94758aa6eb42" args="() const" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char * SocketException::what </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> const throw ()</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the exception message <dl class="return" compact><dt><b>Returns:</b></dt><dd>exception message </dd></dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="dcfeba6d4ce5754b48ae9d37b07a7e87"></a><!-- doxytag: member="SocketException::userMessage" ref="dcfeba6d4ce5754b48ae9d37b07a7e87" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">string <a class="el" href="classSocketException.html#dcfeba6d4ce5754b48ae9d37b07a7e87">SocketException::userMessage</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="PracticalSocket_8h-source.html">PracticalSocket.h</a><li><a class="el" href="PracticalSocket_8cpp.html">PracticalSocket.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:50 2007 for anytun by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address> +</body> +</html> |