org.jboss.as.protocol

Interface ProtocolTimeoutHandler

All Known Implementing Classes:

GeneralTimeoutHandler

public interface ProtocolTimeoutHandler

An implementation of this interface can be provided by calling clients where they wish to supply their own implementation to handle timeouts whilst establishing a connection. The general purpose of this is for clients that wish to take into account additional factors during connection such as user think time / value entry.

Author:

Darran Lofthouse

Method Summary

Modifier and Type	Method and Description
org.xnio.IoFuture.Status	await(org.xnio.IoFuture<?> future, long timeoutMillis) Wait for the specified time on the supplied IoFuture, taking into account that some of this time could actually not be related to the establishment of the connection but instead some local task such as user think time.

Method Detail

await

org.xnio.IoFuture.Status await(org.xnio.IoFuture<?> future,
                               long timeoutMillis)

Wait for the specified time on the supplied IoFuture, taking into account that some of this time could actually not be related to the establishment of the connection but instead some local task such as user think time.

Parameters:

future - - The IoFuture to wait on.

timeoutMillis - - The configures timeout in milliseconds.

Returns:

The IoFuture.Status when available or at the time the timeout is reached - whichever is soonest.