Entry rwlock is no longer needed as concurrency is managed

[openldap] / contrib / ldapc++ / src / LDAPException.h

diff --git a/contrib/ldapc++/src/LDAPException.h b/contrib/ldapc++/src/LDAPException.h
index df48f39f3c2b3076807e496280fd0bcf4f13582a..be4873a534da85c1248ecaa89c9a21d8b8d0a562 100644 (file)
--- a/contrib/ldapc++/src/LDAPException.h
+++ b/contrib/ldapc++/src/LDAPException.h
@@ -12,19 +12,60 @@
 
 class LDAPAsynConnection;
 
+/**
+ * This class is only thrown as an Exception and used to signalize error
+ * conditions during LDAP-operations
+ */
 class LDAPException{
-
-       private :
-               int m_res_code;
-               string m_res_string;
-               string m_err_string;
                
        public :
-               LDAPException(int res_code, const string& err_string=string());
-               LDAPException(const LDAPAsynConnection *lc);
+        /**
+         * Constructs a LDAPException-object from the parameters
+         * @param res_code A valid LDAP result code.
+         * @param err_std::string    An addional error message for the error
+         *                      that happend (optional)
+         */
+               LDAPException(int res_code, const std::string& err_string=std::string());
+               
+        /**
+         * Constructs a LDAPException-object from the error state of a
+         * LDAPAsynConnection-object
+         * @param lc A LDAP-Connection for that an error has happend. The
+         *          Constructor tries to read its error state.
+         */
+        LDAPException(const LDAPAsynConnection *lc);
+
+        /**
+         * Destructor
+         */
         virtual ~LDAPException();
+
+        /**
+         * @return The Result code of the object
+         */
+        
                int getResultCode() const;
-               const string& getResultMsg() const;
-               friend ostream& operator << (ostream &s, LDAPException e);
+
+        /**
+         * @return The error message that is corresponding to the result
+         *          code .
+         */
+               const std::string& getResultMsg() const;
+        
+        /**
+         * @return The addional error message of the error (if it was set)
+         */
+        const std::string& getServerMsg() const;
+
+        /**
+         * This method can be used to dump the data of a LDAPResult-Object.
+         * It is only useful for debugging purposes at the moment
+         */
+               friend std::ostream& operator << (std::ostream &s, LDAPException e);
+
+       private :
+               int m_res_code;
+               std::string m_res_string;
+               std::string m_err_string;
 };
 #endif //LDAP_EXCEPTION_H