openldap/contrib/ldapc++/src/LDAPSearchResults.h
Ralf Haferkamp b1957678d4 - Fixed some memory leak detected by Jeff Costlow <j.costlow@f5.com>
- Fixed some trouble time.h / sys/time.h
- modified include statements
2001-03-15 11:07:58 +00:00

55 lines
1.5 KiB
C++

/*
* Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
*/
#ifndef LDAP_SEARCH_RESULTS_H
#define LDAP_SEARCH_RESULTS_H
#include <LDAPEntry.h>
#include <LDAPEntryList.h>
#include <LDAPMessage.h>
#include <LDAPMessageQueue.h>
#include <LDAPReferenceList.h>
#include <LDAPSearchReference.h>
class LDAPResult;
/**
* The class stores the results of a synchronous SEARCH-Operation
*/
class LDAPSearchResults{
public:
/**
* Default-Constructor
*/
LDAPSearchResults();
/**
* For internal use only.
*
* This method read Search result entries from a
* LDAPMessageQueue-object.
* @param msg The message queue to read
*/
LDAPResult* readMessageQueue(LDAPMessageQueue* msg);
/**
* The methode is used by the client-application to read the
* result entries of the SEARCH-Operation. Every call of this
* method returns one entry. If all entries were read it return 0.
* @throws LDAPReferralException If a Search Reference was
* returned by the server
* @returns A LDAPEntry-object as a result of a SEARCH-Operation or
* 0 if no more entries are there to return.
*/
LDAPEntry* getNext();
private :
LDAPEntryList entryList;
LDAPReferenceList refList;
LDAPEntryList::const_iterator entryPos;
LDAPReferenceList::const_iterator refPos;
};
#endif //LDAP_SEARCH_RESULTS_H