]> git.sur5r.net Git - openldap/blobdiff - contrib/ldapc++/src/LDAPReferralException.h
Entry rwlock is no longer needed as concurrency is managed
[openldap] / contrib / ldapc++ / src / LDAPReferralException.h
index 1988107acdae7cfb17f901f1842fc61688dddb29..5ec0d2d4d374951ebbd415332fee6e0948423c1b 100644 (file)
@@ -8,20 +8,35 @@
 #define LDAP_REFERRAL_EXCEPTION_H
 
 #include <list>
-#include "LDAPMessage.h"
-#include "LDAPUrlList.h"
+#include <LDAPMessage.h>
+#include <LDAPUrlList.h>
 
 class LDAPUrlList;
 
+/**
+ * This class extends LDAPException and is used to signalize Referrals
+ * there were received during synchronous LDAP-operations
+ */
 class LDAPReferralException : public LDAPException{
 
-    private :
-        LDAPUrlList m_urlList;
-
     public :
+        /**
+         * Creates an object that is initialized with a std::list of URLs
+         */
         LDAPReferralException(const LDAPUrlList& urls);
+
+        /**
+         * Destructor
+         */
         ~LDAPReferralException();
+
+        /**
+         * @return The List of URLs of the Referral/Search Reference
+         */
         const LDAPUrlList& getUrls();
+
+    private :
+        LDAPUrlList m_urlList;
 };
 
 #endif //LDAP_REFERRAL_EXCEPTION_H