LDAPRequest Class Reference

For internal use only. More...

#include <LDAPRequest.h>

Inheritance diagram for LDAPRequest:

List of all members.

Public Member Functions
	LDAPRequest (const LDAPRequest &req)
	LDAPRequest (LDAPAsynConnection *conn, const LDAPConstraints *cons, bool isReferral=false, const LDAPRequest *parent=0)
virtual	~LDAPRequest ()
const LDAPConstraints *	getConstraints () const
const LDAPAsynConnection *	getConnection () const
virtual LDAPMsg *	getNextMessage () const
int	getType () const
int	getMsgID () const
int	getHopCount () const
const LDAPRequest *	getParent () const
bool	isReferral () const
void	unbind () const
virtual LDAPMessageQueue *	sendRequest ()=0
	This method encodes the request an calls the apprpriate functions of the C-API to send the Request to a LDAP-Server.
virtual LDAPRequest *	followReferral (LDAPMsg *ref)
virtual bool	equals (const LDAPRequest *req) const
	Compare this request with another on.
bool	isCycle () const
Static Public Attributes
static const int	BIND = 0
static const int	UNBIND = 2
static const int	SEARCH = 3
static const int	MODIFY = 7
static const int	ADD = 8
static const int	DELETE = 10
static const int	COMPARE = 14
Protected Member Functions
	LDAPRequest ()
Protected Attributes
bool	m_isReferral
int	m_requestType
LDAPConstraints *	m_cons
LDAPAsynConnection *	m_connection
const LDAPRequest *	m_parent
int	m_hopCount
int	m_msgID

---

Detailed Description

For internal use only.

Each request that is sent to a LDAP-server by this library is represented by a special object that contains the parameters and some other info of the request. This virtual class is the common base classe for these specialized request classes.

---

Constructor & Destructor Documentation

LDAPRequest::LDAPRequest

(

const LDAPRequest &

req

)

LDAPRequest::LDAPRequest	(	LDAPAsynConnection *	conn,
		const LDAPConstraints *	cons,
		bool	isReferral = false,
		const LDAPRequest *	parent = 0
	)

LDAPRequest::~LDAPRequest

(

)

[virtual]

LDAPRequest::LDAPRequest

(

)

[protected]

---

Member Function Documentation

const LDAPConstraints * LDAPRequest::getConstraints

(

)

const

const LDAPAsynConnection * LDAPRequest::getConnection

(

)

const

LDAPMsg * LDAPRequest::getNextMessage

(

)

const [virtual]

Reimplemented in LDAPSaslInteractiveBind.

int LDAPRequest::getType

(

)

const

int LDAPRequest::getMsgID

(

)

const

int LDAPRequest::getHopCount

(

)

const

const LDAPRequest * LDAPRequest::getParent

(

)

const

Returns:

The LDAPRequest that has created this object. Or 0 if this object was not created by another request.

bool LDAPRequest::isReferral

(

)

const

Returns:

true if this object was created during the automatic chasing of referrals. Otherwise false

void LDAPRequest::unbind

(

)

const

virtual LDAPMessageQueue* LDAPRequest::sendRequest

(

)

[pure virtual]

This method encodes the request an calls the apprpriate functions of the C-API to send the Request to a LDAP-Server.

Implemented in LDAPAddRequest, LDAPBindRequest, LDAPSaslBindRequest, LDAPSaslInteractiveBind, LDAPCompareRequest, LDAPDeleteRequest, LDAPExtRequest, LDAPModDNRequest, LDAPModifyRequest, and LDAPSearchRequest.

LDAPRequest * LDAPRequest::followReferral

(

LDAPMsg *

ref

)

[virtual]

Reimplemented in LDAPAddRequest, LDAPCompareRequest, LDAPDeleteRequest, LDAPExtRequest, LDAPModDNRequest, LDAPModifyRequest, and LDAPSearchRequest.

bool LDAPRequest::equals

(

const LDAPRequest *

req

)

const [virtual]

Compare this request with another on.

And returns true if they have the same parameters.

Reimplemented in LDAPSearchRequest.

bool LDAPRequest::isCycle

(

)

const

---

Member Data Documentation

const int LDAPRequest::BIND = 0 [static]

const int LDAPRequest::UNBIND = 2 [static]

const int LDAPRequest::SEARCH = 3 [static]

const int LDAPRequest::MODIFY = 7 [static]

const int LDAPRequest::ADD = 8 [static]

const int LDAPRequest::DELETE = 10 [static]

const int LDAPRequest::COMPARE = 14 [static]

bool LDAPRequest::m_isReferral [protected]

int LDAPRequest::m_requestType [protected]

LDAPConstraints* LDAPRequest::m_cons [protected]

LDAPAsynConnection* LDAPRequest::m_connection [protected]

const LDAPRequest* LDAPRequest::m_parent [protected]

int LDAPRequest::m_hopCount [protected]

int LDAPRequest::m_msgID [protected]

---

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

• LDAPRequest.h
• LDAPRequest.cpp