#include <string>
#include <boost/serialization/serialization.hpp>
-#include <boost/serialization/export.hpp>
-// serialization for std::exception
namespace boost {
namespace serialization {
+// make std::exception serializable
template<class Archive>
void serialize(Archive & ar, std::exception & g, const unsigned int version)
{
namespace libt2n
{
-
-/**
- generic libt2n exception
+/** @brief a generic exception that can be handeled with libt2n
+ @note don't derive the exceptions your application generates directly from this one
+ but use libt2n::t2n_runtime_error for this
*/
-// a generic exception that can be handeled with libt2n
class t2n_exception : public std::exception
{
private:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(exception);
- ar & BOOST_SERIALIZATION_NVP(message);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_exception(const std::string& _message)
virtual void do_throw()
{ throw *this; }
};
-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:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_exception);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_communication_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-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:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_communication_error);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_connect_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-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:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_communication_error);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_server_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-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:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_communication_error);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_transfer_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-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:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_communication_error);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_version_mismatch(const std::string& _message)
void do_throw()
{ throw *this; }
};
-BOOST_CLASS_EXPORT(t2n_version_mismatch)
-// illegal libt2n command received
+/// illegal libt2n command received
class t2n_command_error : public t2n_exception
{
private:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_exception);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_command_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-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:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_exception);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_serialization_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-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
+
+ @note you must override the virtual clone method if you do so (used by libt2n::command_server::handle())
+*/
class t2n_runtime_error : public t2n_exception
{
private:
friend class boost::serialization::access;
template<class Archive>
- void serialize(Archive & ar, const unsigned int version)
- {
- ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(t2n_exception);
- }
+ void serialize(Archive & ar, const unsigned int version);
public:
t2n_runtime_error(const std::string& _message)
void do_throw()
{ throw *this; }
};
-BOOST_CLASS_EXPORT(t2n_runtime_error)
-}
+} // namespace libt2n
+
+#include "t2n_exception.tcc"
#endif