openldap/contrib/ldapc++/src/LDAPReferenceList.h
Ralf Haferkamp bef9945dff - some code cleanups
- fix for the client caching code (cache is flushed after modifications
  rather than removing only the changed entry)

The code was submitted by Jeff Costlow <j.costlow@f5.com> under the
following terms:

Copyright 2002, F5 Networks, Inc, All rights reserved.
This software is not subject to any license of F5 Networks.

This is free software; you can redistribute and use it
under the same terms as OpenLDAP itself.
2002-04-23 15:28:11 +00:00

72 lines
1.6 KiB
C++

/*
* Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
#ifndef LDAP_REFERENCE_LIST_H
#define LDAP_REFERENCE_LIST_H
#include <list>
class LDAPSearchReference;
typedef std::list<LDAPSearchReference> RefList;
/**
* Container class for storing a list of Search References
*
* Used internally only by LDAPSearchResults
*/
class LDAPReferenceList{
public:
typedef RefList::const_iterator const_iterator;
/**
* Constructs an empty list.
*/
LDAPReferenceList();
/**
* Copy-constructor
*/
LDAPReferenceList(const LDAPReferenceList& rl);
/**
* Destructor
*/
~LDAPReferenceList();
/**
* @return The number of LDAPSearchReference-objects that are
* currently stored in this list.
*/
size_t size() const;
/**
* @return true if there are zero LDAPSearchReference-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 e The LDAPSearchReference to add to the list.
*/
void addReference(const LDAPSearchReference& e);
private:
RefList m_refs;
};
#endif // LDAP_REFERENCE_LIST_H