libt2n: (gerd) add ip communication
[libt2n] / src / t2n_exception.hxx
index c756b09..9d789b5 100644 (file)
@@ -22,8 +22,8 @@
 #include <stdexcept>
 #include <string>
 
+#include <boost/serialization/serialization.hpp>
 #include <boost/serialization/export.hpp>
-#include <boost/serialization/tracking.hpp>
 
 // serialization for std::exception
 namespace boost {
@@ -40,11 +40,11 @@ void serialize(Archive & ar, std::exception & g, const unsigned int version)
 namespace libt2n
 {
 
-// a generic exception that can be handeled with libt2n
+/// a generic exception that can be handeled with libt2n
 class t2n_exception : public std::exception
 {
     private:
-        string message;
+        std::string message;
 
         friend class boost::serialization::access;
         template<class Archive>
@@ -55,7 +55,7 @@ class t2n_exception : public std::exception
         }
 
     public:
-        t2n_exception(const string& _message)
+        t2n_exception(const std::string& _message)
             { message=_message; }
 
         t2n_exception()
@@ -75,7 +75,7 @@ class t2n_exception : public std::exception
 };
 BOOST_CLASS_EXPORT(t2n_exception)
 
-// a (unspecified) problem with libt2n communication
+/// a (unspecified) problem with libt2n communication
 class t2n_communication_error : public t2n_exception
 {
     private:
@@ -87,14 +87,14 @@ class t2n_communication_error : public t2n_exception
         }
 
     public:
-        t2n_communication_error(const string& _message)
+        t2n_communication_error(const std::string& _message)
             : t2n_exception(_message)
             { }
 
         t2n_communication_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_communication_error(*this); }
 
         void do_throw()
@@ -102,7 +102,7 @@ class t2n_communication_error : public t2n_exception
 };
 BOOST_CLASS_EXPORT(t2n_communication_error)
 
-// can't connect to libt2n server
+/// can't connect to libt2n server
 class t2n_connect_error : public t2n_communication_error
 {
     private:
@@ -114,14 +114,14 @@ class t2n_connect_error : public t2n_communication_error
         }
 
     public:
-        t2n_connect_error(const string& _message)
+        t2n_connect_error(const std::string& _message)
             : t2n_communication_error(_message)
             { }
 
         t2n_connect_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_connect_error(*this); }
 
         void do_throw()
@@ -129,7 +129,7 @@ class t2n_connect_error : public t2n_communication_error
 };
 BOOST_CLASS_EXPORT(t2n_connect_error)
 
-// error establishing a socket on the server (only thrown on the server-side)
+/// error establishing a socket on the server (only thrown on the server-side)
 class t2n_server_error : public t2n_communication_error
 {
     private:
@@ -141,14 +141,14 @@ class t2n_server_error : public t2n_communication_error
         }
 
     public:
-        t2n_server_error(const string& _message)
+        t2n_server_error(const std::string& _message)
             : t2n_communication_error(_message)
             { }
 
         t2n_server_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_server_error(*this); }
 
         void do_throw()
@@ -156,7 +156,7 @@ class t2n_server_error : public t2n_communication_error
 };
 BOOST_CLASS_EXPORT(t2n_server_error)
 
-// error transmitting or receiving libt2n messages
+/// error transmitting or receiving libt2n messages
 class t2n_transfer_error : public t2n_communication_error
 {
     private:
@@ -168,14 +168,14 @@ class t2n_transfer_error : public t2n_communication_error
         }
 
     public:
-        t2n_transfer_error(const string& _message)
+        t2n_transfer_error(const std::string& _message)
             : t2n_communication_error(_message)
             { }
 
         t2n_transfer_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_transfer_error(*this); }
 
         void do_throw()
@@ -183,7 +183,7 @@ class t2n_transfer_error : public t2n_communication_error
 };
 BOOST_CLASS_EXPORT(t2n_transfer_error)
 
-// tried to talk to an incompatible libt2n version
+/// tried to talk to an incompatible libt2n version
 class t2n_version_mismatch : public t2n_communication_error
 {
     private:
@@ -195,14 +195,14 @@ class t2n_version_mismatch : public t2n_communication_error
         }
 
     public:
-        t2n_version_mismatch(const string& _message)
+        t2n_version_mismatch(const std::string& _message)
             : t2n_communication_error(_message)
             { }
 
         t2n_version_mismatch()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_version_mismatch(*this); }
 
         void do_throw()
@@ -210,7 +210,7 @@ class t2n_version_mismatch : public t2n_communication_error
 };
 BOOST_CLASS_EXPORT(t2n_version_mismatch)
 
-// illegal libt2n command received
+/// illegal libt2n command received
 class t2n_command_error : public t2n_exception
 {
     private:
@@ -222,14 +222,14 @@ class t2n_command_error : public t2n_exception
         }
 
     public:
-        t2n_command_error(const string& _message)
+        t2n_command_error(const std::string& _message)
             : t2n_exception(_message)
             { }
 
         t2n_command_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_command_error(*this); }
 
         void do_throw()
@@ -237,7 +237,7 @@ class t2n_command_error : public t2n_exception
 };
 BOOST_CLASS_EXPORT(t2n_command_error)
 
-// error serializing or deserializing a libt2n command packet
+/// error serializing or deserializing a libt2n command packet
 class t2n_serialization_error : public t2n_exception
 {
     private:
@@ -249,14 +249,14 @@ class t2n_serialization_error : public t2n_exception
         }
 
     public:
-        t2n_serialization_error(const string& _message)
+        t2n_serialization_error(const std::string& _message)
             : t2n_exception(_message)
             { }
 
         t2n_serialization_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_serialization_error(*this); }
 
         void do_throw()
@@ -264,8 +264,9 @@ class t2n_serialization_error : public t2n_exception
 };
 BOOST_CLASS_EXPORT(t2n_serialization_error)
 
-// a runtime error within the remote function
-// derive your own custom exceptions from this one
+/** @brief a runtime error within the remote function.
+ derive your own custom exceptions from this one
+*/
 class t2n_runtime_error : public t2n_exception
 {
     private:
@@ -277,14 +278,14 @@ class t2n_runtime_error : public t2n_exception
         }
 
     public:
-        t2n_runtime_error(const string& _message)
+        t2n_runtime_error(const std::string& _message)
             : t2n_exception(_message)
             { }
 
         t2n_runtime_error()
             { }
 
-        ipc_exception* clone() const
+        t2n_exception* clone() const
             { return new t2n_runtime_error(*this); }
 
         void do_throw()