org.vertx.java.core.http.impl

Class DefaultHttpClientResponse

java.lang.Object

org.vertx.java.core.http.impl.DefaultHttpClientResponse

All Implemented Interfaces:

HttpClientResponse, ExceptionSupport<HttpClientResponse>, ReadStream<HttpClientResponse>

public class DefaultHttpClientResponse
extends java.lang.Object
implements HttpClientResponse

Method Summary

Methods

Modifier and Type	Method and Description
HttpClientResponse	bodyHandler(Handler<Buffer> bodyHandler) Convenience method for receiving the entire request body in one piece.
java.util.List<java.lang.String>	cookies()
HttpClientResponse	dataHandler(Handler<Buffer> dataHandler) Set a data handler.
HttpClientResponse	endHandler(Handler<java.lang.Void> endHandler) Set an end handler.
HttpClientResponse	exceptionHandler(Handler<java.lang.Throwable> exceptionHandler) Set an exception handler.
MultiMap	headers()
NetSocket	netSocket() Get a net socket for the underlying connection of this request.
HttpClientResponse	pause() Pause the ReadStream.
HttpClientResponse	resume() Resume reading.
int	statusCode() The HTTP status code of the response
java.lang.String	statusMessage() The HTTP status message of the response
MultiMap	trailers()

Methods inherited from class java.lang.Object

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

Method Detail

statusCode

public int statusCode()

Description copied from interface: HttpClientResponse

The HTTP status code of the response

Specified by:

statusCode in interface HttpClientResponse

statusMessage

public java.lang.String statusMessage()

Description copied from interface: HttpClientResponse

The HTTP status message of the response

Specified by:

statusMessage in interface HttpClientResponse

headers

public MultiMap headers()

Specified by:

headers in interface HttpClientResponse

Returns:

The HTTP headers

trailers

public MultiMap trailers()

Specified by:

trailers in interface HttpClientResponse

Returns:

The HTTP trailers

cookies

public java.util.List<java.lang.String> cookies()

Specified by:

cookies in interface HttpClientResponse

Returns:

The Set-Cookie headers (including trailers)

dataHandler

public HttpClientResponse dataHandler(Handler<Buffer> dataHandler)

Description copied from interface: ReadStream

Set a data handler. As data is read, the handler will be called with the data.

Specified by:

dataHandler in interface ReadStream<HttpClientResponse>

endHandler

public HttpClientResponse endHandler(Handler<java.lang.Void> endHandler)

Description copied from interface: ReadStream

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Specified by:

endHandler in interface ReadStream<HttpClientResponse>

exceptionHandler

public HttpClientResponse exceptionHandler(Handler<java.lang.Throwable> exceptionHandler)

Description copied from interface: ExceptionSupport

Set an exception handler.

Specified by:

exceptionHandler in interface ExceptionSupport<HttpClientResponse>

pause

public HttpClientResponse pause()

Description copied from interface: ReadStream

Pause the ReadStream. While the stream is paused, no data will be sent to the dataHandler

Specified by:

pause in interface ReadStream<HttpClientResponse>

resume

public HttpClientResponse resume()

Description copied from interface: ReadStream

Resume reading. If the ReadStream has been paused, reading will recommence on it.

Specified by:

resume in interface ReadStream<HttpClientResponse>

bodyHandler

public HttpClientResponse bodyHandler(Handler<Buffer> bodyHandler)

Description copied from interface: HttpClientResponse

Convenience method for receiving the entire request body in one piece. This saves the user having to manually set a data and end handler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

Specified by:

bodyHandler in interface HttpClientResponse

Parameters:

bodyHandler - This handler will be called after all the body has been received

netSocket

public NetSocket netSocket()

Description copied from interface: HttpClientResponse

Get a net socket for the underlying connection of this request. USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol

Specified by:

netSocket in interface HttpClientResponse

Returns:

the net socket