mirror of
https://git.openldap.org/openldap/openldap.git
synced 2025-01-06 10:46:21 +08:00
72 lines
1.9 KiB
C++
72 lines
1.9 KiB
C++
/*
|
|
* Copyright 2000, OpenLDAP Foundation, All Rights Reserved.
|
|
* COPYING RESTRICTIONS APPLY, see COPYRIGHT file
|
|
*/
|
|
|
|
|
|
#ifndef LDAP_MESSAGE_QUEUE_H
|
|
#define LDAP_MESSAGE_QUEUE_H
|
|
|
|
#include <stack>
|
|
|
|
#include <LDAPUrlList.h>
|
|
|
|
class LDAPAsynConnection;
|
|
class LDAPMsg;
|
|
class LDAPRequest;
|
|
class LDAPSearchRequest;
|
|
class LDAPUrl;
|
|
typedef std::stack<LDAPRequest*> LDAPRequestStack;
|
|
typedef std::list<LDAPRequest*> LDAPRequestList;
|
|
|
|
/**
|
|
* This class is created for the asynchronous LDAP-operations. And can be
|
|
* used by the client to retrieve the results of an operation.
|
|
*/
|
|
class LDAPMessageQueue{
|
|
public :
|
|
|
|
/**
|
|
* This creates a new LDAPMessageQueue. For a LDAP-request
|
|
*
|
|
* @param conn The Request for that is queue can be used to get
|
|
* the results.
|
|
*/
|
|
LDAPMessageQueue(LDAPRequest *conn);
|
|
/**
|
|
* Destructor
|
|
*/
|
|
~LDAPMessageQueue();
|
|
|
|
/**
|
|
* This method reads exactly one Message from the results of a
|
|
* Request.
|
|
* @throws LDAPException
|
|
* @return A pointer to an object of one of the classes that were
|
|
* derived from LDAPMsg. The user has to cast it to the
|
|
* correct type (e.g. LDAPResult or LDAPSearchResult)
|
|
*/
|
|
LDAPMsg* getNext();
|
|
|
|
/**
|
|
* For internat use only.
|
|
*
|
|
* The method is used to start the automatic referral chasing
|
|
*/
|
|
LDAPRequest* chaseReferral(LDAPMsg* ref);
|
|
|
|
/**
|
|
* For internal use only
|
|
*
|
|
* The referral chasing algorithm needs this method to see the
|
|
* currently active requests.
|
|
*/
|
|
LDAPRequestStack* getRequestStack();
|
|
|
|
private :
|
|
LDAPRequestStack m_activeReq;
|
|
LDAPRequestList m_issuedReq;
|
|
};
|
|
#endif //ifndef LDAP_MESSAGE_QUEUE_H
|
|
|