Class HttpServerResponse
- java.lang.Object
-
- io.vertx.reactivex.core.http.HttpServerResponse
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,StreamBase,WriteStream<Buffer>
public class HttpServerResponse extends Object implements io.vertx.lang.rx.RxDelegate, WriteStream<Buffer>
Represents a server-side HTTP response.An instance of this is created and associated to every instance of
HttpServerRequestthat.It allows the developer to control the HTTP response that is sent back to the client for a particular HTTP request.
It contains methods that allow HTTP headers and trailers to be set, and for a body to be written out to the response.
It also allows files to be streamed by the kernel directly from disk to the outgoing HTTP connection, bypassing user space altogether (where supported by the underlying operating system). This is a very efficient way of serving files from the server since buffers do not have to be read one by one from the file and written to the outgoing socket.
It implements
WriteStreamso it can be used withPipeto pipe data with flow control.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<HttpServerResponse>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description HttpServerResponse(HttpServerResponse delegate)HttpServerResponse(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HttpServerResponseaddCookie(Cookie cookie)Add a cookie.HttpServerResponsebodyEndHandler(Handler<Void> handler)Provides a handler that will be called after the last part of the body is written to the wire.longbytesWritten()booleanclosed()HttpServerResponsecloseHandler(Handler<Void> handler)Set a close handler for the response, this is called when the underlying connection is closed and the response was still using the connection.HttpServerResponsedrainHandler(Handler<Void> handler)Set a drain handler on the stream.Future<Void>end()Ends the response.Future<Void>end(Buffer chunk)Same asend(java.lang.String)but writes some data to the response body before ending.Future<Void>end(String chunk)Same asend(java.lang.String)but writes a String in UTF-8 encoding before ending the response.Future<Void>end(String chunk, String enc)Same asend(java.lang.String)but writes a String with the specified encoding before ending the response.booleanended()HttpServerResponseendHandler(Handler<Void> handler)Set an end handler for the response.booleanequals(Object o)HttpServerResponseexceptionHandler(Handler<Throwable> handler)Set an exception handler on the write stream.HttpServerResponsegetDelegate()intgetStatusCode()StringgetStatusMessage()inthashCode()MultiMapheaders()HttpServerResponseheadersEndHandler(Handler<Void> handler)Provide a handler that will be called just before the headers are written to the wire.booleanheadWritten()booleanisChunked()static HttpServerResponsenewInstance(HttpServerResponse arg)Future<HttpServerResponse>push(HttpMethod method, HostAndPort authority, String path)Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with no headers.Future<HttpServerResponse>push(HttpMethod method, HostAndPort authority, String path, MultiMap headers)Push a response to the client.Future<HttpServerResponse>push(HttpMethod method, String path)Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.Future<HttpServerResponse>push(HttpMethod method, String path, MultiMap headers)Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.HttpServerResponseputHeader(CharSequence name, CharSequence value)LikeputHeader(java.lang.String, java.lang.String)but using CharSequenceHttpServerResponseputHeader(CharSequence name, Iterable<CharSequence> values)LikeputHeader(java.lang.String, java.lang.String)but with CharSequence IterableHttpServerResponseputHeader(String name, Iterable<String> values)LikeputHeader(java.lang.String, java.lang.String)but providing multiple values via a String IterableHttpServerResponseputHeader(String name, String value)Put an HTTP headerHttpServerResponseputTrailer(CharSequence name, CharSequence value)LikeputTrailer(java.lang.String, java.lang.String)but using CharSequenceHttpServerResponseputTrailer(CharSequence name, Iterable<CharSequence> value)LikeputTrailer(java.lang.String, java.lang.String)but with CharSequence IterableHttpServerResponseputTrailer(String name, Iterable<String> values)LikeputTrailer(java.lang.String, java.lang.String)but providing multiple values via a String IterableHttpServerResponseputTrailer(String name, String value)Put an HTTP trailerCookieremoveCookie(String name)Expire a cookie, notifying a User Agent to remove it from its cookie jar.CookieremoveCookie(String name, boolean invalidate)Remove a cookie from the cookie set.CookieremoveCookie(String name, String domain, String path)Expires a cookie from the cookie set.CookieremoveCookie(String name, String domain, String path, boolean invalidate)Remove a cookie from the cookie set.Set<Cookie>removeCookies(String name)Expire all cookies, notifying a User Agent to remove it from its cookie jar.Set<Cookie>removeCookies(String name, boolean invalidate)Remove all cookies from the cookie set.Future<Void>reset()Reset this HTTP/2 stream with the error code0.Future<Void>reset(long code)Reset this response:CompletablerxEnd()Ends the response.CompletablerxEnd(Buffer chunk)Same asend(java.lang.String)but writes some data to the response body before ending.CompletablerxEnd(String chunk)Same asend(java.lang.String)but writes a String in UTF-8 encoding before ending the response.CompletablerxEnd(String chunk, String enc)Same asend(java.lang.String)but writes a String with the specified encoding before ending the response.Single<HttpServerResponse>rxPush(HttpMethod method, HostAndPort authority, String path)Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with no headers.Single<HttpServerResponse>rxPush(HttpMethod method, HostAndPort authority, String path, MultiMap headers)Push a response to the client.Single<HttpServerResponse>rxPush(HttpMethod method, String path)Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.Single<HttpServerResponse>rxPush(HttpMethod method, String path, MultiMap headers)Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.CompletablerxReset()Reset this HTTP/2 stream with the error code0.CompletablerxReset(long code)Reset this response:CompletablerxSend()Send the request with an empty body.CompletablerxSend(Flowable<Buffer> body)Send the request with a streambody.CompletablerxSend(Buffer body)Send the request with a bufferbody.CompletablerxSend(ReadStream<Buffer> body)Send the request with a streambody.CompletablerxSend(String body)Send the request with a stringbody.CompletablerxSendFile(String filename)Send the request with a streambody.CompletablerxSendFile(String filename, long offset)Same assendFile(java.lang.String)using length @code{Long.MAX_VALUE} which means until the end of the file.CompletablerxSendFile(String filename, long offset, long length)Ask the OS to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.CompletablerxWrite(Buffer data)Write some data to the stream.CompletablerxWrite(String chunk)Write aStringto the response body, encoded in UTF-8.CompletablerxWrite(String chunk, String enc)Write aStringto the response body, encoded using the encodingenc.CompletablerxWriteContinue()Used to write an interim 100 Continue response to signify that the client should send the rest of the request.CompletablerxWriteCustomFrame(int type, int flags, Buffer payload)Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.CompletablerxWriteCustomFrame(HttpFrame frame)LikewriteCustomFrame(int, int, io.vertx.core.buffer.Buffer)but with anHttpFrame.CompletablerxWriteEarlyHints(MultiMap headers)Used to write an interim 103 Early Hints response to return some HTTP headers before the final HTTP message.Future<Void>send()Send the request with an empty body.Future<Void>send(Flowable<Buffer> body)Send the request with a streambody.Future<Void>send(Buffer body)Send the request with a bufferbody.Future<Void>send(ReadStream<Buffer> body)Send the request with a streambody.Future<Void>send(String body)Send the request with a stringbody.Future<Void>sendFile(String filename)Send the request with a streambody.Future<Void>sendFile(String filename, long offset)Same assendFile(java.lang.String)using length @code{Long.MAX_VALUE} which means until the end of the file.Future<Void>sendFile(String filename, long offset, long length)Ask the OS to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.HttpServerResponsesetChunked(boolean chunked)Ifchunkedistrue, this response will use HTTP chunked encoding, and each call to write to the body will correspond to a new HTTP chunk sent on the wire.HttpServerResponsesetStatusCode(int statusCode)Set the status code.HttpServerResponsesetStatusMessage(String statusMessage)Set the status messageHttpServerResponsesetStreamPriority(StreamPriority streamPriority)Sets the priority of the associated streamHttpServerResponsesetWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.intstreamId()WriteStreamObserver<Buffer>toObserver()StringtoString()WriteStreamSubscriber<Buffer>toSubscriber()MultiMaptrailers()Future<Void>write(Buffer data)Write some data to the stream.Future<Void>write(String chunk)Write aStringto the response body, encoded in UTF-8.Future<Void>write(String chunk, String enc)Write aStringto the response body, encoded using the encodingenc.Future<Void>writeContinue()Used to write an interim 100 Continue response to signify that the client should send the rest of the request.Future<Void>writeCustomFrame(int type, int flags, Buffer payload)Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.Future<Void>writeCustomFrame(HttpFrame frame)LikewriteCustomFrame(int, int, io.vertx.core.buffer.Buffer)but with anHttpFrame.Future<Void>writeEarlyHints(MultiMap headers)Used to write an interim 103 Early Hints response to return some HTTP headers before the final HTTP message.booleanwriteQueueFull()This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<HttpServerResponse> __TYPE_ARG
-
-
Constructor Detail
-
HttpServerResponse
public HttpServerResponse(HttpServerResponse delegate)
-
HttpServerResponse
public HttpServerResponse(Object delegate)
-
-
Method Detail
-
getDelegate
public HttpServerResponse getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Specified by:
getDelegatein interfaceWriteStream<Buffer>
-
toObserver
public WriteStreamObserver<Buffer> toObserver()
- Specified by:
toObserverin interfaceWriteStream<Buffer>
-
toSubscriber
public WriteStreamSubscriber<Buffer> toSubscriber()
- Specified by:
toSubscriberin interfaceWriteStream<Buffer>
-
write
public Future<Void> write(Buffer data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
writein interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
rxWrite
public Completable rxWrite(Buffer data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
rxWritein interfaceWriteStream<Buffer>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
writeQueueFull
public boolean writeQueueFull()
This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)- Specified by:
writeQueueFullin interfaceWriteStream<Buffer>- Returns:
trueif write queue is full
-
exceptionHandler
public HttpServerResponse exceptionHandler(Handler<Throwable> handler)
Description copied from interface:WriteStreamSet an exception handler on the write stream.- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWriteStream<Buffer>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
public HttpServerResponse setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStreamSet the maximum size of the write queue tomaxSize. You will still be able to write to the stream even if there is more thanmaxSizeitems in the write queue. This is used as an indicator by classes such asPipeto provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket, etc...- Specified by:
setWriteQueueMaxSizein interfaceWriteStream<Buffer>- Parameters:
maxSize- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public HttpServerResponse drainHandler(Handler<Void> handler)
Description copied from interface:WriteStreamSet a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. SeePipefor an example of this being used.The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to
maxSize / 2.- Specified by:
drainHandlerin interfaceWriteStream<Buffer>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
getStatusCode
public int getStatusCode()
- Returns:
- the HTTP status code of the response. The default is
200representingOK.
-
setStatusCode
public HttpServerResponse setStatusCode(int statusCode)
Set the status code. If the status message hasn't been explicitly set, a default status message corresponding to the code will be looked-up and used.- Parameters:
statusCode-- Returns:
- a reference to this, so the API can be used fluently
-
getStatusMessage
public String getStatusMessage()
- Returns:
- the HTTP status message of the response. If this is not specified a default value will be used depending on what
setStatusCode(int)has been set to.
-
setStatusMessage
public HttpServerResponse setStatusMessage(String statusMessage)
Set the status message- Parameters:
statusMessage-- Returns:
- a reference to this, so the API can be used fluently
-
setChunked
public HttpServerResponse setChunked(boolean chunked)
Ifchunkedistrue, this response will use HTTP chunked encoding, and each call to write to the body will correspond to a new HTTP chunk sent on the wire.If chunked encoding is used the HTTP header
Transfer-Encodingwith a value ofChunkedwill be automatically inserted in the response.If
chunkedisfalse, this response will not use HTTP chunked encoding, and therefore the total size of any data that is written in the respone body must be set in theContent-Lengthheader before any data is written out.An HTTP chunked response is typically used when you do not know the total size of the request body up front.
- Parameters:
chunked-- Returns:
- a reference to this, so the API can be used fluently
-
isChunked
public boolean isChunked()
- Returns:
- is the response chunked?
-
headers
public MultiMap headers()
- Returns:
- The HTTP headers
-
putHeader
public HttpServerResponse putHeader(String name, String value)
Put an HTTP header- Parameters:
name- the header namevalue- the header value.- Returns:
- a reference to this, so the API can be used fluently
-
trailers
public MultiMap trailers()
- Returns:
- The HTTP trailers
-
putTrailer
public HttpServerResponse putTrailer(String name, String value)
Put an HTTP trailer- Parameters:
name- the trailer namevalue- the trailer value- Returns:
- a reference to this, so the API can be used fluently
-
closeHandler
public HttpServerResponse closeHandler(Handler<Void> handler)
Set a close handler for the response, this is called when the underlying connection is closed and the response was still using the connection.For HTTP/1.x it is called when the connection is closed before
end()is called, therefore it is not guaranteed to be called.For HTTP/2 it is called when the related stream is closed, and therefore it will be always be called.
- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public HttpServerResponse endHandler(Handler<Void> handler)
Set an end handler for the response. This will be called when the response is disposed to allow consistent cleanup of the response.- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
write
public Future<Void> write(String chunk, String enc)
Write aStringto the response body, encoded using the encodingenc.- Parameters:
chunk- the string to writeenc- the encoding to use- Returns:
- a future completed with the body result
-
rxWrite
public Completable rxWrite(String chunk, String enc)
Write aStringto the response body, encoded using the encodingenc.- Parameters:
chunk- the string to writeenc- the encoding to use- Returns:
- a future completed with the body result
-
write
public Future<Void> write(String chunk)
Write aStringto the response body, encoded in UTF-8.- Parameters:
chunk- the string to write- Returns:
- a future completed with the body result
-
rxWrite
public Completable rxWrite(String chunk)
Write aStringto the response body, encoded in UTF-8.- Parameters:
chunk- the string to write- Returns:
- a future completed with the body result
-
writeContinue
public Future<Void> writeContinue()
Used to write an interim 100 Continue response to signify that the client should send the rest of the request. Must only be used if the request contains an "Expect:100-Continue" header- Returns:
- a reference to this, so the API can be used fluently
-
rxWriteContinue
public Completable rxWriteContinue()
Used to write an interim 100 Continue response to signify that the client should send the rest of the request. Must only be used if the request contains an "Expect:100-Continue" header- Returns:
- a reference to this, so the API can be used fluently
-
writeEarlyHints
public Future<Void> writeEarlyHints(MultiMap headers)
Used to write an interim 103 Early Hints response to return some HTTP headers before the final HTTP message.- Parameters:
headers- headers to write- Returns:
- a future
-
rxWriteEarlyHints
public Completable rxWriteEarlyHints(MultiMap headers)
Used to write an interim 103 Early Hints response to return some HTTP headers before the final HTTP message.- Parameters:
headers- headers to write- Returns:
- a future
-
end
public Future<Void> end(String chunk)
Same asend(java.lang.String)but writes a String in UTF-8 encoding before ending the response.- Parameters:
chunk- the string to write before ending the response- Returns:
- a future completed with the body result
-
rxEnd
public Completable rxEnd(String chunk)
Same asend(java.lang.String)but writes a String in UTF-8 encoding before ending the response.- Parameters:
chunk- the string to write before ending the response- Returns:
- a future completed with the body result
-
end
public Future<Void> end(String chunk, String enc)
Same asend(java.lang.String)but writes a String with the specified encoding before ending the response.- Parameters:
chunk- the string to write before ending the responseenc- the encoding to use- Returns:
- a future completed with the body result
-
rxEnd
public Completable rxEnd(String chunk, String enc)
Same asend(java.lang.String)but writes a String with the specified encoding before ending the response.- Parameters:
chunk- the string to write before ending the responseenc- the encoding to use- Returns:
- a future completed with the body result
-
end
public Future<Void> end(Buffer chunk)
Same asend(java.lang.String)but writes some data to the response body before ending. If the response is not chunked and no other data has been written then the @code{Content-Length} header will be automatically set.- Specified by:
endin interfaceWriteStream<Buffer>- Parameters:
chunk- the buffer to write before ending the response- Returns:
- a future completed with the body result
-
rxEnd
public Completable rxEnd(Buffer chunk)
Same asend(java.lang.String)but writes some data to the response body before ending. If the response is not chunked and no other data has been written then the @code{Content-Length} header will be automatically set.- Specified by:
rxEndin interfaceWriteStream<Buffer>- Parameters:
chunk- the buffer to write before ending the response- Returns:
- a future completed with the body result
-
end
public Future<Void> end()
Ends the response. If no data has been written to the response body, the actual response won't get written until this method gets called.Once the response has ended, it cannot be used any more.
- Specified by:
endin interfaceWriteStream<Buffer>- Returns:
- a future completed with the body result
-
rxEnd
public Completable rxEnd()
Ends the response. If no data has been written to the response body, the actual response won't get written until this method gets called.Once the response has ended, it cannot be used any more.
- Specified by:
rxEndin interfaceWriteStream<Buffer>- Returns:
- a future completed with the body result
-
send
public Future<Void> send()
Send the request with an empty body.- Returns:
- a future notified when the response has been written
-
rxSend
public Completable rxSend()
Send the request with an empty body.- Returns:
- a future notified when the response has been written
-
send
public Future<Void> send(String body)
Send the request with a stringbody.- Parameters:
body-- Returns:
- a future notified when the response has been written
-
rxSend
public Completable rxSend(String body)
Send the request with a stringbody.- Parameters:
body-- Returns:
- a future notified when the response has been written
-
send
public Future<Void> send(Buffer body)
Send the request with a bufferbody.- Parameters:
body-- Returns:
- a future notified when the response has been written
-
rxSend
public Completable rxSend(Buffer body)
Send the request with a bufferbody.- Parameters:
body-- Returns:
- a future notified when the response has been written
-
send
public Future<Void> send(ReadStream<Buffer> body)
Send the request with a streambody.If the
HttpHeadersis set then the request assumes this is the length of the {stream}, otherwise the request will set a chunkedHttpHeaders.- Parameters:
body-- Returns:
- a future notified when the last bytes of the response was sent
-
rxSend
public Completable rxSend(ReadStream<Buffer> body)
Send the request with a streambody.If the
HttpHeadersis set then the request assumes this is the length of the {stream}, otherwise the request will set a chunkedHttpHeaders.- Parameters:
body-- Returns:
- a future notified when the last bytes of the response was sent
-
send
public Future<Void> send(Flowable<Buffer> body)
Send the request with a streambody.If the
HttpHeadersis set then the request assumes this is the length of the {stream}, otherwise the request will set a chunkedHttpHeaders.- Parameters:
body-- Returns:
- a future notified when the last bytes of the response was sent
-
rxSend
public Completable rxSend(Flowable<Buffer> body)
Send the request with a streambody.If the
HttpHeadersis set then the request assumes this is the length of the {stream}, otherwise the request will set a chunkedHttpHeaders.- Parameters:
body-- Returns:
- a future notified when the last bytes of the response was sent
-
sendFile
public Future<Void> sendFile(String filename)
Send the request with a streambody.If the
HttpHeadersis set then the request assumes this is the length of the {stream}, otherwise the request will set a chunkedHttpHeaders.- Parameters:
filename-- Returns:
- a future notified when the response has been written
-
rxSendFile
public Completable rxSendFile(String filename)
Send the request with a streambody.If the
HttpHeadersis set then the request assumes this is the length of the {stream}, otherwise the request will set a chunkedHttpHeaders.- Parameters:
filename-- Returns:
- a future notified when the response has been written
-
sendFile
public Future<Void> sendFile(String filename, long offset)
Same assendFile(java.lang.String)using length @code{Long.MAX_VALUE} which means until the end of the file.- Parameters:
filename- path to the file to serveoffset- offset to start serving from- Returns:
- a future completed with the body result
-
rxSendFile
public Completable rxSendFile(String filename, long offset)
Same assendFile(java.lang.String)using length @code{Long.MAX_VALUE} which means until the end of the file.- Parameters:
filename- path to the file to serveoffset- offset to start serving from- Returns:
- a future completed with the body result
-
sendFile
public Future<Void> sendFile(String filename, long offset, long length)
Ask the OS to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to serve files.The actual serve is asynchronous and may not complete until some time after this method has returned.
- Parameters:
filename- path to the file to serveoffset- offset to start serving fromlength- the number of bytes to send- Returns:
- a future completed with the body result
-
rxSendFile
public Completable rxSendFile(String filename, long offset, long length)
Ask the OS to stream a file as specified byfilenamedirectly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system. This is a very efficient way to serve files.The actual serve is asynchronous and may not complete until some time after this method has returned.
- Parameters:
filename- path to the file to serveoffset- offset to start serving fromlength- the number of bytes to send- Returns:
- a future completed with the body result
-
ended
public boolean ended()
- Returns:
- has the response already ended?
-
closed
public boolean closed()
- Returns:
- has the underlying TCP connection corresponding to the request already been closed?
-
headWritten
public boolean headWritten()
- Returns:
- have the headers for the response already been written?
-
headersEndHandler
public HttpServerResponse headersEndHandler(Handler<Void> handler)
Provide a handler that will be called just before the headers are written to the wire.This provides a hook allowing you to add any more headers or do any more operations before this occurs.
- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
bodyEndHandler
public HttpServerResponse bodyEndHandler(Handler<Void> handler)
Provides a handler that will be called after the last part of the body is written to the wire. The handler is called asynchronously of when the response has been received by the client. This provides a hook allowing you to do more operations once the request has been sent over the wire such as resource cleanup.- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
bytesWritten
public long bytesWritten()
- Returns:
- the total number of bytes written for the body of the response.
-
streamId
public int streamId()
- Returns:
- the id of the stream of this response, for HTTP/1.x
-
push
public Future<HttpServerResponse> push(HttpMethod method, HostAndPort authority, String path)
Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with no headers.- Parameters:
method-authority-path-- Returns:
-
rxPush
public Single<HttpServerResponse> rxPush(HttpMethod method, HostAndPort authority, String path)
Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with no headers.- Parameters:
method-authority-path-- Returns:
-
push
public Future<HttpServerResponse> push(HttpMethod method, String path, MultiMap headers)
Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.- Parameters:
method-path-headers-- Returns:
-
rxPush
public Single<HttpServerResponse> rxPush(HttpMethod method, String path, MultiMap headers)
Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.- Parameters:
method-path-headers-- Returns:
-
push
public Future<HttpServerResponse> push(HttpMethod method, String path)
Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.- Parameters:
method-path-- Returns:
-
rxPush
public Single<HttpServerResponse> rxPush(HttpMethod method, String path)
Likepush(io.vertx.core.http.HttpMethod, io.vertx.core.net.HostAndPort, java.lang.String)with the host copied from the current request.- Parameters:
method-path-- Returns:
-
push
public Future<HttpServerResponse> push(HttpMethod method, HostAndPort authority, String path, MultiMap headers)
Push a response to the client. Thehandlerwill be notified with a success when the push can be sent and with a failure when the client has disabled push or reset the push before it has been sent. Thehandlermay be queued if the client has reduced the maximum number of streams the server can push concurrently. Push can be sent only for peer initiated streams and if the response is not ended.- Parameters:
method- the method of the promised requestauthority- the authority of the promised requestpath- the path of the promised requestheaders- the headers of the promised request- Returns:
- a future notified when the response can be written
-
rxPush
public Single<HttpServerResponse> rxPush(HttpMethod method, HostAndPort authority, String path, MultiMap headers)
Push a response to the client. Thehandlerwill be notified with a success when the push can be sent and with a failure when the client has disabled push or reset the push before it has been sent. Thehandlermay be queued if the client has reduced the maximum number of streams the server can push concurrently. Push can be sent only for peer initiated streams and if the response is not ended.- Parameters:
method- the method of the promised requestauthority- the authority of the promised requestpath- the path of the promised requestheaders- the headers of the promised request- Returns:
- a future notified when the response can be written
-
rxReset
public Completable rxReset()
Reset this HTTP/2 stream with the error code0.- Returns:
-
reset
public Future<Void> reset(long code)
Reset this response:- for HTTP/2, send an HTTP/2 reset frame with the specified error
code - for HTTP/1.x, close the connection when the current response has not yet been sent
falseis returned as indicator.- Parameters:
code- the error code- Returns:
truewhen reset has been performed
- for HTTP/2, send an HTTP/2 reset frame with the specified error
-
rxReset
public Completable rxReset(long code)
Reset this response:- for HTTP/2, send an HTTP/2 reset frame with the specified error
code - for HTTP/1.x, close the connection when the current response has not yet been sent
falseis returned as indicator.- Parameters:
code- the error code- Returns:
truewhen reset has been performed
- for HTTP/2, send an HTTP/2 reset frame with the specified error
-
writeCustomFrame
public Future<Void> writeCustomFrame(int type, int flags, Buffer payload)
Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.The frame is sent immediatly and is not subject to flow control.
- Parameters:
type- the 8-bit frame typeflags- the 8-bit frame flagspayload- the frame payload- Returns:
- a reference to this, so the API can be used fluently
-
rxWriteCustomFrame
public Completable rxWriteCustomFrame(int type, int flags, Buffer payload)
Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.The frame is sent immediatly and is not subject to flow control.
- Parameters:
type- the 8-bit frame typeflags- the 8-bit frame flagspayload- the frame payload- Returns:
- a reference to this, so the API can be used fluently
-
writeCustomFrame
public Future<Void> writeCustomFrame(HttpFrame frame)
LikewriteCustomFrame(int, int, io.vertx.core.buffer.Buffer)but with anHttpFrame.- Parameters:
frame- the frame to write- Returns:
-
rxWriteCustomFrame
public Completable rxWriteCustomFrame(HttpFrame frame)
LikewriteCustomFrame(int, int, io.vertx.core.buffer.Buffer)but with anHttpFrame.- Parameters:
frame- the frame to write- Returns:
-
setStreamPriority
public HttpServerResponse setStreamPriority(StreamPriority streamPriority)
Sets the priority of the associated stream This is not implemented for HTTP/1.x.- Parameters:
streamPriority- the priority for this request's stream- Returns:
-
addCookie
public HttpServerResponse addCookie(Cookie cookie)
Add a cookie. This will be sent back to the client in the response.- Parameters:
cookie- the cookie- Returns:
- a reference to this, so the API can be used fluently
-
removeCookie
public Cookie removeCookie(String name)
Expire a cookie, notifying a User Agent to remove it from its cookie jar. NOTE: This method will only remove the first occurrence of the given name. Users probably may want to use:removeCookies(java.lang.String)- Parameters:
name- the name of the cookie- Returns:
- the cookie, if it existed, or null
-
removeCookie
public Cookie removeCookie(String name, boolean invalidate)
Remove a cookie from the cookie set. If invalidate istruethen it will expire a cookie, notifying a User Agent to remove it from its cookie jar. NOTE: This method will only expire the first occurrence of the given name. Users probably may want to use:removeCookies(java.lang.String)- Parameters:
name- the name of the cookieinvalidate-- Returns:
- the cookie, if it existed, or
null
-
removeCookies
public Set<Cookie> removeCookies(String name)
Expire all cookies, notifying a User Agent to remove it from its cookie jar. NOTE: the returned is read-only. This means any attempt to modify (add or remove to the set), will throwUnsupportedOperationException.- Parameters:
name- the name of the cookie- Returns:
- a read only set of affected cookies, if they existed, or an empty set.
-
removeCookies
public Set<Cookie> removeCookies(String name, boolean invalidate)
Remove all cookies from the cookie set. If invalidate istruethen it will expire a cookie, notifying a User Agent to remove it from its cookie jar. NOTE: the returned is read-only. This means any attempt to modify (add or remove to the set), will throwUnsupportedOperationException.- Parameters:
name- the name of the cookieinvalidate- invalidate from the user agent- Returns:
- a read only set of affected cookies, if they existed, or an empty set.
-
removeCookie
public Cookie removeCookie(String name, String domain, String path)
Expires a cookie from the cookie set. This will notify a User Agent to remove it from its cookie jar.- Parameters:
name- the name of the cookiedomain- the domain of the cookiepath- the path of the cookie- Returns:
- the cookie, if it existed, or
null
-
removeCookie
public Cookie removeCookie(String name, String domain, String path, boolean invalidate)
Remove a cookie from the cookie set. If invalidate istruethen it will expire a cookie, notifying a User Agent to remove it from its cookie jar.- Parameters:
name- the name of the cookiedomain- the domain of the cookiepath- the path of the cookieinvalidate-- Returns:
- the cookie, if it existed, or
null
-
putHeader
public HttpServerResponse putHeader(CharSequence name, CharSequence value)
LikeputHeader(java.lang.String, java.lang.String)but using CharSequence- Parameters:
name-value-- Returns:
-
putHeader
public HttpServerResponse putHeader(String name, Iterable<String> values)
LikeputHeader(java.lang.String, java.lang.String)but providing multiple values via a String Iterable- Parameters:
name-values-- Returns:
-
putHeader
public HttpServerResponse putHeader(CharSequence name, Iterable<CharSequence> values)
LikeputHeader(java.lang.String, java.lang.String)but with CharSequence Iterable- Parameters:
name-values-- Returns:
-
putTrailer
public HttpServerResponse putTrailer(CharSequence name, CharSequence value)
LikeputTrailer(java.lang.String, java.lang.String)but using CharSequence- Parameters:
name-value-- Returns:
-
putTrailer
public HttpServerResponse putTrailer(String name, Iterable<String> values)
LikeputTrailer(java.lang.String, java.lang.String)but providing multiple values via a String Iterable- Parameters:
name-values-- Returns:
-
putTrailer
public HttpServerResponse putTrailer(CharSequence name, Iterable<CharSequence> value)
LikeputTrailer(java.lang.String, java.lang.String)but with CharSequence Iterable- Parameters:
name-value-- Returns:
-
newInstance
public static HttpServerResponse newInstance(HttpServerResponse arg)
-
-