org.apache.directory.ldap.client.api.message

Interface Request

All Superinterfaces:

Message

All Known Subinterfaces:

AbandonableRequest, RequestWithResponse

All Known Implementing Classes:

AbandonRequest, AbstractRequest, AddRequest, BindRequest, CompareRequest, DeleteRequest, ExtendedRequest, ModifyDnRequest, ModifyRequest, SearchRequest, UnbindRequest

public interface Request
extends Message

Ldap protocol request messages derive from this super interface.

Version:

$Rev: 760984 $

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
long	getTimeout() Get the client message timeout.
Message	setTimeout(long timeout) Set a request client timeout.

Methods inherited from interface org.apache.directory.ldap.client.api.message.Message

add, getControl, getControls, getMessageId, hasControl, remove, setMessageId

Method Detail

getTimeout

long getTimeout()

Get the client message timeout. When the timeout is reached, the request is canceled.

Returns:

The timeout

setTimeout

Message setTimeout(long timeout)

Set a request client timeout. When this timeout is reached, the request will be canceled. If <= 0, then we wait for the response forever.

Parameters:

timeout - The new timeout, expressed in milliseconds