LDAPMessageQueue Class Reference

This class is created for the asynchronous LDAP-operations. More...

#include <LDAPMessageQueue.h>

List of all members.

Public Member Functions

 LDAPMessageQueue (LDAPRequest *conn)
 This creates a new LDAPMessageQueue.
 ~LDAPMessageQueue ()
 Destructor.
LDAPMsg * getNext ()
 This method reads exactly one Message from the results of a Request.
LDAPRequest * chaseReferral (LDAPMsg *ref)
 For internat use only.
LDAPRequestStack * getRequestStack ()
 For internal use only.

Private Attributes

LDAPRequestStack m_activeReq
LDAPRequestList m_issuedReq

Detailed Description

This class is created for the asynchronous LDAP-operations.

And can be used by the client to retrieve the results of an operation.

Constructor & Destructor Documentation

LDAPMessageQueue::LDAPMessageQueue ( LDAPRequest *  conn  ) 

This creates a new LDAPMessageQueue.

For a LDAP-request

Parameters:
conn The Request for that is queue can be used to get the results.

References DEBUG, LDAP_DEBUG_CONSTRUCT, m_activeReq, and m_issuedReq.

LDAPMessageQueue::~LDAPMessageQueue (  ) 

Destructor.

References DEBUG, LDAP_DEBUG_DESTROY, and m_issuedReq.

Member Function Documentation

LDAPRequest * LDAPMessageQueue::chaseReferral ( LDAPMsg *  ref  ) 

For internat use only.

The method is used to start the automatic referral chasing

References DEBUG, LDAPRequest::followReferral(), LDAPRequest::getConstraints(), LDAPRequest::getHopCount(), LDAPConstraints::getHopLimit(), LDAPRequest::isCycle(), LDAP_DEBUG_TRACE, m_activeReq, and LDAPRequest::sendRequest().

Referenced by getNext().

LDAPMsg * LDAPMessageQueue::getNext (  ) 

This method reads exactly one Message from the results of a Request.

Exceptions:
LDAPException 
Returns:
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)

References chaseReferral(), DEBUG, LDAPRequest::getConstraints(), LDAPMsg::getMessageType(), LDAPRequest::getNextMessage(), LDAPConstraints::getReferralChase(), LDAPResult::getResultCode(), LDAPRequest::isReferral(), LDAP_DEBUG_TRACE, m_activeReq, m_issuedReq, LDAPResult::REFERRAL, LDAPMsg::SEARCH_DONE, LDAPMsg::SEARCH_ENTRY, LDAPMsg::SEARCH_REFERENCE, LDAPResult::SUCCESS, and LDAPRequest::unbind().

Referenced by LDAPConnection::add(), LDAPSearchResults::readMessageQueue(), and LDAPConnection::saslInteractiveBind().

LDAPRequestStack * LDAPMessageQueue::getRequestStack (  ) 

For internal use only.

The referral chasing algorithm needs this method to see the currently active requests.

References DEBUG, LDAP_DEBUG_TRACE, and m_activeReq.

Referenced by LDAPAsynConnection::abandon().

Member Data Documentation

LDAPRequestStack LDAPMessageQueue::m_activeReq [private]

Referenced by chaseReferral(), getNext(), getRequestStack(), and LDAPMessageQueue().

LDAPRequestList LDAPMessageQueue::m_issuedReq [private]

Referenced by getNext(), LDAPMessageQueue(), and ~LDAPMessageQueue().

The documentation for this class was generated from the following files:
doxygen