C# Class Novell.Directory.Ldap.LdapMessageQueue

Represents a queue of incoming asynchronous messages from the server. It is the common interface for {@link LdapResponseQueue} and {@link LdapSearchQueue}.

Datei anzeigen Open project: EventStore/csharp-ldap Class Usage Examples

Private Properties

Property	Type	Description
LdapMessageQueue	System
LdapMessageQueue	System
getResponse	LdapMessage

Public Methods

Method	Description
getResponse ( ) : LdapMessage	Returns the response from an Ldap request. The getResponse method blocks until a response is available, or until all operations associated with the object have completed or been canceled, and then returns the response. The application is responsible to determine the type of message returned.
getResponse ( System msgid ) : LdapMessage	Returns the response from an Ldap request for a particular message ID. The getResponse method blocks until a response is available for a particular message ID, or until all operations associated with the object have completed or been canceled, and then returns the response. If there is no outstanding operation for the message ID (or if it is zero or a negative number), IllegalArgumentException is thrown. The application is responsible to determine the type of message returned.
isComplete ( int msgid ) : bool	Reports true if all results have been received for a particular message id. If the search result done has been received from the server for the message id, it reports true. There may still be messages waiting to be retrieved by the applcation with getResponse. @throws IllegalArgumentException if there is no outstanding operation for the message ID,
isResponseReceived ( ) : bool	Reports true if any response has been received from the server and not yet retrieved with getResponse. If getResponse has been used to retrieve all messages received to this point, then isResponseReceived returns false.
isResponseReceived ( int msgid ) : bool	Reports true if a response has been received from the server for a particular message ID but not yet retrieved with getResponse. If there is no outstanding operation for the message ID (or if it is zero or a negative number), IllegalArgumentException is thrown.

Private Methods

Method	Description
LdapMessageQueue ( ) : System
LdapMessageQueue ( System myname, MessageAgent agent ) : System	Constructs a response queue using the specified message agent
getResponse ( Integer32 msgid ) : LdapMessage	Private implementation of getResponse. Has an Integer object as a parameter so we can distinguish the null and the message number case

Method Details

getResponse() public method

Returns the response from an Ldap request. The getResponse method blocks until a response is available, or until all operations associated with the object have completed or been canceled, and then returns the response. The application is responsible to determine the type of message returned.

LdapException A general exception which includes an error /// message and an Ldap error code. ///

public getResponse ( ) : LdapMessage
return	LdapMessage

getResponse() public method

Returns the response from an Ldap request for a particular message ID. The getResponse method blocks until a response is available for a particular message ID, or until all operations associated with the object have completed or been canceled, and then returns the response. If there is no outstanding operation for the message ID (or if it is zero or a negative number), IllegalArgumentException is thrown. The application is responsible to determine the type of message returned.

LdapException A general exception which includes an error /// message and an Ldap error code. ///

public getResponse ( System msgid ) : LdapMessage
msgid	System	query for responses for a specific message request /// ///
return	LdapMessage

isComplete() public method

Reports true if all results have been received for a particular message id. If the search result done has been received from the server for the message id, it reports true. There may still be messages waiting to be retrieved by the applcation with getResponse. @throws IllegalArgumentException if there is no outstanding operation for the message ID,

public isComplete ( int msgid ) : bool
msgid	int
return	bool

isResponseReceived() public method

Reports true if any response has been received from the server and not yet retrieved with getResponse. If getResponse has been used to retrieve all messages received to this point, then isResponseReceived returns false.

public isResponseReceived ( ) : bool
return	bool

isResponseReceived() public method

Reports true if a response has been received from the server for a particular message ID but not yet retrieved with getResponse. If there is no outstanding operation for the message ID (or if it is zero or a negative number), IllegalArgumentException is thrown.

public isResponseReceived ( int msgid ) : bool
msgid	int	A particular message ID to query for available responses. /// ///
return	bool