From 7763f07327f3abce839a690df46ced3bfd1d3d09 Mon Sep 17 00:00:00 2001 From: Erwin Nindl Date: Sun, 7 Oct 2007 22:07:03 +0000 Subject: added doxygen generatet documentation --- doc/html/classSocketException.html | 137 +++++++++++++++++++++++++++++++++++++ 1 file changed, 137 insertions(+) create mode 100644 doc/html/classSocketException.html (limited to 'doc/html/classSocketException.html') 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 @@ + + +anytun: SocketException Class Reference + + + + +
+
+
+
+

SocketException Class Reference

#include <PracticalSocket.h> +

+List of all members. + + + + + + + + + + + +

Public Member Functions

 SocketException (const string &message, bool inclSysMsg=false) throw ()
 ~SocketException () throw ()
const char * what () const throw ()

Private Attributes

string userMessage
+

Detailed Description

+Signals a problem with the execution of a socket call. +

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
SocketException::SocketException (const string &  message,
bool  inclSysMsg = false 
) throw ()
+
+
+ +

+Construct a SocketException with a explanatory message.

Parameters:
+ + + +
message explanatory message
incSysMsg true if system message (from strerror(errno)) should be postfixed to the user provided message
+
+ +
+

+ +

+
+ + + + + + + + +
SocketException::~SocketException (  )  throw ()
+
+
+ +

+Provided just to guarantee that no exceptions are thrown. +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
const char * SocketException::what (  )  const throw ()
+
+
+ +

+Get the exception message

Returns:
exception message
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
string SocketException::userMessage [private]
+
+
+ +

+ +

+

+

The documentation for this class was generated from the following files: +
Generated on Sun Oct 7 23:43:50 2007 for anytun by  + +doxygen 1.5.1
+ + -- cgit v1.2.3