openldap/contrib/ldapc++/src/LDAPControlSet.h
Josh Soref 10566c8be3 ITS#8605 - spelling fixes
* javascript
* kernel
* ldap
* length
* macros
* maintained
* manager
* matching
* maximum
* mechanism
* memory
* method
* mimic
* minimum
* modifiable
* modifiers
* modifying
* multiple
* necessary
* normalized
* objectclass
* occurrence
* occurring
* offered
* operation
* original
* overridden
* parameter
* permanent
* preemptively
* printable
* protocol
* provider
* really
* redistribution
* referenced
* refresh
* regardless
* registered
* request
* reserved
* resource
* response
* sanity
* separated
* setconcurrency
* should
* specially
* specifies
* structure
* structures
* subordinates
* substitution
* succeed
* successful
* successfully
* sudoers
* sufficient
* superiors
* supported
* synchronization
* terminated
* they're
* through
* traffic
* transparent
* unsigned
* unsupported
* version
* absence
* achieves
* adamson
* additional
* address
* against
* appropriate
* architecture
* associated
* async
* attribute
* authentication
* authorized
* auxiliary
* available
* begin
* beginning
* buffered
* canonical
* certificate
* charray
* check
* class
* compatibility
* compilation
* component
* configurable
* configuration
* configure
* conjunction
* constraints
* constructor
* contained
* containing
* continued
* control
* convenience
* correspond
* credentials
* cyrillic
* database
* definitions
* deloldrdn
* dereferencing
* destroy
* distinguish
* documentation
* emmanuel
* enabled
* entry
* enumerated
* everything
* exhaustive
* existence
* existing
* explicitly
* extract
* fallthru
* fashion
* february
* finally
* function
* generically
* groupname
* happened
* implementation
* including
* initialization
* initializes
* insensitive
* instantiated
* instantiation
* integral
* internal
* iterate
2017-10-11 14:39:38 -07:00

89 lines
2.3 KiB
C++

// $OpenLDAP$
/*
* Copyright 2000-2017 The OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
#ifndef LDAP_CONTROL_SET_H
#define LDAP_CONTROL_SET_H
#include <list>
#include <ldap.h>
#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 :
/**
* Constructs an empty std::list
*/
LDAPControlSet();
/**
* Copy-constructor
*/
LDAPControlSet(const LDAPControlSet& cs);
/**
* For internal use only
*
* This constructor creates a new LDAPControlSet for a
* 0-terminated array of LDAPControl-structures as used by the
* C-API
* @param controls: pointer to a 0-terminated array of pointers to
* LDAPControl-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;
} ;
#endif //LDAP_CONTROL_SET_H