Entry rwlock is no longer needed as concurrency is managed

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

diff --git a/contrib/ldapc++/src/LDAPControlSet.h b/contrib/ldapc++/src/LDAPControlSet.h
index b3e107537d3c00afb612ebcec8e1179a49e5d6b9..82b4649e29deddae48025effa05b15a0ad198b7d 100644 (file)
--- a/contrib/ldapc++/src/LDAPControlSet.h
+++ b/contrib/ldapc++/src/LDAPControlSet.h
@@ -8,27 +8,80 @@
 
 #include <list>
 #include <ldap.h>
-#include "LDAPControl.h"
-
-typedef list<LDAPCtrl> CtrlList;
+#include <LDAPControl.h>
 
+typedef std::list<LDAPCtrl> CtrlList;
 
+/**
+ * This container class is used to store multiple LDAPCtrl-objects.
+ */
 class LDAPControlSet {
     typedef CtrlList::const_iterator const_iterator;
     public :
-        LDAPControlSet();
+        /**
+         * Constructs an empty std::list
+         */
+        LDAPControlSet();   
+
+
+        /**
+         * Copy-constructor
+         */
         LDAPControlSet(const LDAPControlSet& cs);
-        //!for internal use only
-        //untested til now. Due to lack of server that return Controls
+        
+        /**
+         * For internal use only
+         *
+         * This constructor creates a new LDAPControlSet for a
+         * 0-terminiated array of LDAPControl-structures as used by the
+         * C-API
+         * @param controls: pointer to a 0-terminated array of pointers to 
+         *                  LDAPControll-structures
+         * @note: untested til now. Due to lack of server that return 
+         *          Controls
+         */
         LDAPControlSet(LDAPControl** controls);
+
+        /**
+         * Destructor
+         */
         ~LDAPControlSet();
+
+        /**
+         * @return The number of LDAPCtrl-objects that are currently
+         * stored in this list.
+         */
         size_t size() const ;
+        
+        /**
+         * @return true if there are zero LDAPCtrl-objects currently
+         * stored in this list.
+         */
+        bool empty() const;
+        
+        /**
+         * @return A iterator that points to the first element of the list.
+         */
         const_iterator begin() const;
+
+        /**
+         * @return A iterator that points to the element after the last
+         * element of the list.
+         */
         const_iterator end() const;
+       
+        /**
+         * Adds one element to the end of the list.
+         * @param ctrl The Control to add to the list.
+         */
         void add(const LDAPCtrl& ctrl); 
         
+        /**
+         * Translates the list to a 0-terminated array of pointers to
+         * LDAPControl-structures as needed by the C-API
+         */
         LDAPControl** toLDAPControlArray()const ;
-
+       static void freeLDAPControlArray(LDAPControl **ctrl);
     private :
         CtrlList data;
 } ;