Top Description Methods
org.glassfish.grizzly.http.server

public Interface SuspendContext

Known Direct Implementers
org.glassfish.grizzly.http.server.Response.SuspendedContextImpl
Imports
java.util.concurrent.TimeUnit, org.glassfish.grizzly.CompletionHandler

Interface represents a context of the suspended Response.
Author
Alexey Stashok

Method Summary

Modifier and TypeMethod and Description
public CompletionHandler<Response>

Returns:

the suspended Response CompletionHandler.
getCompletionHandler
()

Get the suspended Response CompletionHandler.

public long

Returns:

the suspended Response timeout. If returned value less or equal to zero - timeout is not set.
getTimeout
(TimeUnit timeunit)

Get the suspended Response timeout.

public TimeoutHandler

Returns:

the suspended Response TimeoutHandler.
getTimeoutHandler
()

Get the suspended Response TimeoutHandler.

public boolean

Returns:

true, if the Response is suspended, or false otherwise.
isSuspended
()

Returns true, if the Response is suspended, or false otherwise.

public void
setTimeout(long
the suspended Response timeout.
timeout
,
TimeUnit
timeout units.
timeunit
)

Set the suspended Response timeout.

Method Detail

getCompletionHandlerback to summary
public CompletionHandler<Response> getCompletionHandler()

Get the suspended Response CompletionHandler.

Returns:CompletionHandler<Response>

the suspended Response CompletionHandler.

getTimeoutback to summary
public long getTimeout(TimeUnit timeunit)

Get the suspended Response timeout. If returned value less or equal to zero - timeout is not set.

Returns:long

the suspended Response timeout. If returned value less or equal to zero - timeout is not set.

getTimeoutHandlerback to summary
public TimeoutHandler getTimeoutHandler()

Get the suspended Response TimeoutHandler.

Returns:TimeoutHandler

the suspended Response TimeoutHandler.

isSuspendedback to summary
public boolean isSuspended()

Returns true, if the Response is suspended, or false otherwise.

Returns:boolean

true, if the Response is suspended, or false otherwise.

setTimeoutback to summary
public void setTimeout(long timeout, TimeUnit timeunit)

Set the suspended Response timeout. If timeout value less or equal to zero - suspended Response won't be never timed out.

Parameters
timeout:long

the suspended Response timeout.

timeunit:TimeUnit

timeout units.