Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

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.
LDAPMsggetNext ()
 This method reads exactly one Message from the results of a Request.
LDAPRequestchaseReferral (LDAPMsg *ref)
 For internat use only.
LDAPRequestStackgetRequestStack ()
 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.

LDAPMessageQueue::~LDAPMessageQueue  ) 
 

Destructor.


Member Function Documentation

LDAPRequest * LDAPMessageQueue::chaseReferral LDAPMsg ref  ) 
 

For internat use only.

The method is used to start the automatic referral chasing

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)

LDAPRequestStack * LDAPMessageQueue::getRequestStack  ) 
 

For internal use only.

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


Member Data Documentation

LDAPRequestStack LDAPMessageQueue::m_activeReq [private]
 

LDAPRequestList LDAPMessageQueue::m_issuedReq [private]
 


The documentation for this class was generated from the following files:
Generated on Wed Nov 12 02:19:04 2008 for ldapsdk by  doxygen 1.3.9.1