io.vertx.core.http.impl

Class HttpClientResponseImpl

java.lang.Object

io.vertx.core.http.impl.HttpClientResponseImpl

All Implemented Interfaces:

HttpClientResponse, ReadStream<Buffer>, StreamBase

public class HttpClientResponseImpl
extends Object
implements HttpClientResponse

This class is optimised for performance when used on the same event loop that is was passed to the handler with. However it can be used safely from other threads. The internal state is protected using the synchronized keyword. If always used on the same event loop, then we benefit from biased locking which makes the overhead of synchronized near zero.

Author:

Tim Fox

Method Summary

Modifier and Type	Method and Description
HttpClientResponse	bodyHandler(Handler<Buffer> bodyHandler) Convenience method for receiving the entire request body in one piece.
List<String>	cookies()
HttpClientResponse	endHandler(Handler<Void> endHandler) Set an end handler.
HttpClientResponse	exceptionHandler(Handler<Throwable> exceptionHandler) Set an exception handler on the read stream.
String	getHeader(String headerName) Return the first header value with the specified name
String	getTrailer(String trailerName) Return the first trailer value with the specified name
HttpClientResponse	handler(Handler<Buffer> dataHandler) Set a data handler.
MultiMap	headers()
NetSocket	netSocket() Get a net socket for the underlying connection of this request.
HttpClientResponse	pause() Pause the ReadSupport.
HttpClientResponse	resume() Resume reading.
int	statusCode()
String	statusMessage()
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()

Specified by:

statusCode in interface HttpClientResponse

Returns:

the status code of the response

statusMessage

public String statusMessage()

Specified by:

statusMessage in interface HttpClientResponse

Returns:

the status message of the response

headers

public MultiMap headers()

Specified by:

headers in interface HttpClientResponse

Returns:

the headers

getHeader

public String getHeader(String headerName)

Description copied from interface: HttpClientResponse

Return the first header value with the specified name

Specified by:

getHeader in interface HttpClientResponse

Parameters:

headerName - the header name

Returns:

the header value

trailers

public MultiMap trailers()

Specified by:

trailers in interface HttpClientResponse

Returns:

the trailers

getTrailer

public String getTrailer(String trailerName)

Description copied from interface: HttpClientResponse

Return the first trailer value with the specified name

Specified by:

getTrailer in interface HttpClientResponse

Parameters:

trailerName - the trailer name

Returns:

the trailer value

cookies

public List<String> cookies()

Specified by:

cookies in interface HttpClientResponse

Returns:

the Set-Cookie headers (including trailers)

handler

public HttpClientResponse handler(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:

handler in interface HttpClientResponse

Specified by:

handler in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

endHandler

public HttpClientResponse endHandler(Handler<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 HttpClientResponse

Specified by:

endHandler in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

exceptionHandler

public HttpClientResponse exceptionHandler(Handler<Throwable> exceptionHandler)

Description copied from interface: ReadStream

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface HttpClientResponse

Specified by:

exceptionHandler in interface ReadStream<Buffer>

Specified by:

exceptionHandler in interface StreamBase

Parameters:

exceptionHandler - the exception handler

Returns:

a reference to this, so the API can be used fluently

pause

public HttpClientResponse pause()

Description copied from interface: ReadStream

Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler

Specified by:

pause in interface HttpClientResponse

Specified by:

pause in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

resume

public HttpClientResponse resume()

Description copied from interface: ReadStream

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

Specified by:

resume in interface HttpClientResponse

Specified by:

resume in interface ReadStream<Buffer>

Returns:

a reference to this, so the API can be used fluently

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 you having to manually set a dataHandler and an endHandler 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

One valid use-case for calling this is to receive the NetSocket after a HTTP CONNECT was issued to the remote peer and it responded with a status code of 200.

Specified by:

netSocket in interface HttpClientResponse

Returns:

the net socket