Package org.apache.http.nio.protocol

Class HttpAsyncService.HttpAsyncExchangeImpl

java.lang.Object

org.apache.http.nio.protocol.HttpAsyncService.HttpAsyncExchangeImpl

All Implemented Interfaces:

HttpAsyncExchange

Enclosing class:

HttpAsyncService

class HttpAsyncService.HttpAsyncExchangeImpl
extends Object
implements HttpAsyncExchange

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicBoolean	completed
private final NHttpServerConnection	conn
private final HttpContext	context
private final HttpRequest	request
private final HttpResponse	response
private final HttpAsyncService.State	state

Constructor Summary

Constructors

Constructor	Description
HttpAsyncExchangeImpl(HttpRequest request, HttpResponse response, HttpAsyncService.State state, NHttpServerConnection conn, HttpContext context)

Method Summary

Modifier and Type	Method	Description
HttpRequest	getRequest()	Returns the received HTTP request message.
HttpResponse	getResponse()	Returns the default HTTP response message.
int	getTimeout()	Returns timeout for this message exchange.
boolean	isCompleted()	Determines whether or not the message exchange has been completed.
void	setCallback(Cancellable cancellable)	Sets Cancellable callback to be invoked in case the underlying connection times out or gets terminated prematurely by the client.
void	setTimeout(int timeout)	Sets timeout for this message exchange.
void	submitResponse()	Submits the default HTTP response and completed the message exchange.
void	submitResponse(HttpAsyncResponseProducer responseProducer)	Submits an HTTP response using a custom HttpAsyncResponseProducer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

completed

private final AtomicBoolean completed

request

private final HttpRequest request

response

private final HttpResponse response

state

private final HttpAsyncService.State state

conn

private final NHttpServerConnection conn

context

private final HttpContext context

Constructor Details

HttpAsyncExchangeImpl

public HttpAsyncExchangeImpl(HttpRequest request,
 HttpResponse response,
 HttpAsyncService.State state,
 NHttpServerConnection conn,
 HttpContext context)

Method Details

getRequest

public HttpRequest getRequest()

Description copied from interface: HttpAsyncExchange

Returns the received HTTP request message.

Specified by:

getRequest in interface HttpAsyncExchange

Returns:

received HTTP request message.

getResponse

public HttpResponse getResponse()

Description copied from interface: HttpAsyncExchange

Returns the default HTTP response message. Once ready the response message can submitted using HttpAsyncExchange.submitResponse() method.

Specified by:

getResponse in interface HttpAsyncExchange

Returns:

default HTTP response message.

setCallback

public void setCallback(Cancellable cancellable)

Description copied from interface: HttpAsyncExchange

Sets Cancellable callback to be invoked in case the underlying connection times out or gets terminated prematurely by the client. This callback can be used to cancel a long running response generating process if a response is no longer needed.

Specified by:

setCallback in interface HttpAsyncExchange

submitResponse

public void submitResponse(HttpAsyncResponseProducer responseProducer)

Description copied from interface: HttpAsyncExchange

Submits an HTTP response using a custom HttpAsyncResponseProducer.

Specified by:

submitResponse in interface HttpAsyncExchange

submitResponse

public void submitResponse()

Description copied from interface: HttpAsyncExchange

Submits the default HTTP response and completed the message exchange. If the response encloses an HttpEntity instance the entity is also expected to implement the HttpAsyncContentProducer interface for efficient content streaming to a non-blocking HTTP connection.

Specified by:

submitResponse in interface HttpAsyncExchange

isCompleted

public boolean isCompleted()

Description copied from interface: HttpAsyncExchange

Determines whether or not the message exchange has been completed.

Specified by:

isCompleted in interface HttpAsyncExchange

Returns:

true if the message exchange has been completed, false otherwise.

setTimeout

public void setTimeout(int timeout)

Description copied from interface: HttpAsyncExchange

Sets timeout for this message exchange.

Specified by:

setTimeout in interface HttpAsyncExchange

getTimeout

public int getTimeout()

Description copied from interface: HttpAsyncExchange

Returns timeout for this message exchange.

Specified by:

getTimeout in interface HttpAsyncExchange