Merge remote branch 'origin/mdb.master'

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

diff --git a/contrib/ldapc++/src/LDAPSearchReference.h b/contrib/ldapc++/src/LDAPSearchReference.h
index 7b27229136fbdf7c0b0767acf780b7987c1fb8d2..532dbbf7057ae874e9c580632241780f000d2faf 100644 (file)
--- a/contrib/ldapc++/src/LDAPSearchReference.h
+++ b/contrib/ldapc++/src/LDAPSearchReference.h
@@ -1,29 +1,44 @@
+// $OpenLDAP$
 /*
- * Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
+ * Copyright 2000-2012 The OpenLDAP Foundation, All Rights Reserved.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
  */
 
-// $Id: LDAPSearchReference.h,v 1.7 2000/08/31 17:43:49 rhafer Exp $
 
 #ifndef LDAP_SEARCH_REFERENCE_H
 #define LDAP_SEARCH_REFERENCE_H 
 
-#include "LDAPMessage.h"
-#include "LDAPUrlList.h"
+#include <LDAPMessage.h>
+#include <LDAPUrlList.h>
 
 class LDAPRequest;
 class LDAPUrl;
 
+/**
+ * This class is used to represent Continuation References that were
+ * returned during a SEARCH-Operation.
+ */
 class LDAPSearchReference : public LDAPMsg{
 
+    public :
+        /**
+         * Constructor that create an object from the C-API structures
+         */
+        LDAPSearchReference(const LDAPRequest* req, LDAPMessage* msg);
+
+        /**
+         * The Destructor
+         */
+        ~LDAPSearchReference();
+
+        /**
+         * @returns The destination URLs that were send with this message
+         */
+        const LDAPUrlList& getUrls() const;
+
     private :
         LDAPUrlList m_urlList;
         LDAPSearchReference();
-
-    public :
-        LDAPSearchReference(LDAPRequest* req, LDAPMessage* msg);
-        ~LDAPSearchReference();
-        LDAPUrlList* getURLs();
 };