public class HttpServerResponse extends Object implements WriteStream<Buffer>
An instance of this is created and associated to every instance of
HttpServerRequest
that.
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 WriteStream
so it can be used with
Pipe
to pipe data with flow control.
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<HttpServerResponse> |
__TYPE_ARG |
Constructor and Description |
---|
HttpServerResponse(HttpServerResponse delegate) |
HttpServerResponse(Object delegate) |
Modifier and Type | Method and Description |
---|---|
HttpServerResponse |
addCookie(Cookie cookie)
Add a cookie.
|
HttpServerResponse |
bodyEndHandler(Handler<Void> handler)
Provides a handler that will be called after the last part of the body is written to the wire.
|
long |
bytesWritten() |
void |
close()
Close the underlying TCP connection corresponding to the request.
|
boolean |
closed() |
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.
|
HttpServerResponse |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(Buffer chunk)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(Buffer chunk,
Handler<AsyncResult<Void>> handler)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(Handler<AsyncResult<Void>> handler)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(String chunk)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(String chunk,
Handler<AsyncResult<Void>> handler)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(String chunk,
String enc)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(String chunk,
String enc,
Handler<AsyncResult<Void>> handler)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
boolean |
ended() |
HttpServerResponse |
endHandler(Handler<Void> handler)
Set an end handler for the response.
|
boolean |
equals(Object o) |
HttpServerResponse |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.
|
HttpServerResponse |
getDelegate() |
int |
getStatusCode() |
String |
getStatusMessage() |
int |
hashCode() |
MultiMap |
headers() |
HttpServerResponse |
headersEndHandler(Handler<Void> handler)
Provide a handler that will be called just before the headers are written to the wire.
|
boolean |
headWritten() |
boolean |
isChunked() |
static HttpServerResponse |
newInstance(HttpServerResponse arg) |
HttpServerResponse |
push(HttpMethod method,
String path)
Like
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>) with the host copied from the current request. |
HttpServerResponse |
push(HttpMethod method,
String path,
Handler<AsyncResult<HttpServerResponse>> handler)
Like
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>) with the host copied from the current request. |
HttpServerResponse |
push(HttpMethod method,
String path,
MultiMap headers)
Like
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>) with the host copied from the current request. |
HttpServerResponse |
push(HttpMethod method,
String path,
MultiMap headers,
Handler<AsyncResult<HttpServerResponse>> handler)
Like
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>) with the host copied from the current request. |
HttpServerResponse |
push(HttpMethod method,
String host,
String path)
|
HttpServerResponse |
push(HttpMethod method,
String host,
String path,
Handler<AsyncResult<HttpServerResponse>> handler)
|
HttpServerResponse |
push(HttpMethod method,
String host,
String path,
MultiMap headers)
Push a response to the client.
The
handler will 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.
The handler may 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. |
HttpServerResponse |
push(HttpMethod method,
String host,
String path,
MultiMap headers,
Handler<AsyncResult<HttpServerResponse>> handler)
Push a response to the client.
The
handler will 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.
The handler may 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. |
HttpServerResponse |
putHeader(CharSequence name,
CharSequence value)
Like
putHeader(java.lang.String, java.lang.String) but using CharSequence |
HttpServerResponse |
putHeader(CharSequence name,
Iterable<CharSequence> values)
Like
putHeader(java.lang.String, java.lang.String) but with CharSequence Iterable |
HttpServerResponse |
putHeader(String name,
Iterable<String> values)
Like
putHeader(java.lang.String, java.lang.String) but providing multiple values via a String Iterable |
HttpServerResponse |
putHeader(String name,
String value)
Put an HTTP header
|
HttpServerResponse |
putTrailer(CharSequence name,
CharSequence value)
Like
putTrailer(java.lang.String, java.lang.String) but using CharSequence |
HttpServerResponse |
putTrailer(CharSequence name,
Iterable<CharSequence> value)
Like
putTrailer(java.lang.String, java.lang.String) but with CharSequence Iterable |
HttpServerResponse |
putTrailer(String name,
Iterable<String> values)
Like
putTrailer(java.lang.String, java.lang.String) but providing multiple values via a String Iterable |
HttpServerResponse |
putTrailer(String name,
String value)
Put an HTTP trailer
|
Cookie |
removeCookie(String name)
Expire a cookie, notifying a User Agent to remove it from its cookie jar.
|
Cookie |
removeCookie(String name,
boolean invalidate)
Remove a cookie from the cookie set.
|
Cookie |
removeCookie(String name,
String domain,
String path)
Expires a cookie from the cookie set.
|
Cookie |
removeCookie(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.
|
boolean |
reset()
Reset this HTTP/2 stream with the error code
0 . |
boolean |
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
When the response has already been sent nothing happens and false is returned as indicator. |
Completable |
rxEnd()
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Completable |
rxEnd(Buffer chunk)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Completable |
rxEnd(String chunk)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Completable |
rxEnd(String chunk,
String enc)
Same as
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Single<HttpServerResponse> |
rxPush(HttpMethod method,
String path)
Like
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>) with the host copied from the current request. |
Single<HttpServerResponse> |
rxPush(HttpMethod method,
String path,
MultiMap headers)
Like
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>) with the host copied from the current request. |
Single<HttpServerResponse> |
rxPush(HttpMethod method,
String host,
String path)
|
Single<HttpServerResponse> |
rxPush(HttpMethod method,
String host,
String path,
MultiMap headers)
Push a response to the client.
The
handler will 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.
The handler may 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. |
Completable |
rxSend()
Send the request with an empty body.
|
Completable |
rxSend(Buffer body)
Send the request with a buffer
body . |
Completable |
rxSend(Flowable<Buffer> body)
Send the request with a stream
body . |
Completable |
rxSend(ReadStream<Buffer> body)
Send the request with a stream
body . |
Completable |
rxSend(String body)
Send the request with a string
body . |
Completable |
rxSendFile(String filename)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been completely
written to the wire. |
Completable |
rxSendFile(String filename,
long offset)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been completely
written to the wire. |
Completable |
rxSendFile(String filename,
long offset,
long length)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been
completely written to the wire. |
Completable |
rxWrite(Buffer data)
Same as but with an
handler called when the operation completes |
Completable |
rxWrite(String chunk)
Same as
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Completable |
rxWrite(String chunk,
String enc)
Same as
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Completable |
rxWriteEarlyHints(MultiMap headers)
Same as
writeEarlyHints(io.vertx.reactivex.core.MultiMap, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
send()
Send the request with an empty body.
|
void |
send(Buffer body)
Send the request with a buffer
body . |
void |
send(Buffer body,
Handler<AsyncResult<Void>> handler)
Send the request with a buffer
body . |
void |
send(Flowable<Buffer> body)
Send the request with a stream
body . |
void |
send(Flowable<Buffer> body,
Handler<AsyncResult<Void>> handler)
Send the request with a stream
body . |
void |
send(Handler<AsyncResult<Void>> handler)
Send the request with an empty body.
|
void |
send(ReadStream<Buffer> body)
Send the request with a stream
body . |
void |
send(ReadStream<Buffer> body,
Handler<AsyncResult<Void>> handler)
Send the request with a stream
body . |
void |
send(String body)
Send the request with a string
body . |
void |
send(String body,
Handler<AsyncResult<Void>> handler)
Send the request with a string
body . |
HttpServerResponse |
sendFile(String filename)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been completely
written to the wire. |
HttpServerResponse |
sendFile(String filename,
Handler<AsyncResult<Void>> resultHandler)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been completely
written to the wire. |
HttpServerResponse |
sendFile(String filename,
long offset)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been completely
written to the wire. |
HttpServerResponse |
sendFile(String filename,
long offset,
Handler<AsyncResult<Void>> resultHandler)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been completely
written to the wire. |
HttpServerResponse |
sendFile(String filename,
long offset,
long length)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been
completely written to the wire. |
HttpServerResponse |
sendFile(String filename,
long offset,
long length,
Handler<AsyncResult<Void>> resultHandler)
Like
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but providing a handler which will be notified once the file has been
completely written to the wire. |
HttpServerResponse |
setChunked(boolean chunked)
If
chunked is true , 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. |
HttpServerResponse |
setStatusCode(int statusCode)
Set the status code.
|
HttpServerResponse |
setStatusMessage(String statusMessage)
Set the status message
|
HttpServerResponse |
setStreamPriority(StreamPriority streamPriority)
Sets the priority of the associated stream
This is not implemented for HTTP/1.x.
|
HttpServerResponse |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize . |
int |
streamId() |
WriteStreamObserver<Buffer> |
toObserver() |
String |
toString() |
WriteStreamSubscriber<Buffer> |
toSubscriber() |
MultiMap |
trailers() |
void |
write(Buffer data)
Same as but with an
handler called when the operation completes |
void |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as but with an
handler called when the operation completes |
void |
write(String chunk)
Same as
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
write(String chunk,
Handler<AsyncResult<Void>> handler)
Same as
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
write(String chunk,
String enc)
Same as
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
write(String chunk,
String enc,
Handler<AsyncResult<Void>> handler)
Same as
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
HttpServerResponse |
writeContinue()
Used to write an interim 100 Continue response to signify that the client should send the rest of the request.
|
HttpServerResponse |
writeCustomFrame(HttpFrame frame)
Like
writeCustomFrame(int, int, io.vertx.reactivex.core.buffer.Buffer) but with an HttpFrame . |
HttpServerResponse |
writeCustomFrame(int type,
int flags,
Buffer payload)
Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.
|
void |
writeEarlyHints(MultiMap headers)
Same as
writeEarlyHints(io.vertx.reactivex.core.MultiMap, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
writeEarlyHints(MultiMap headers,
Handler<AsyncResult<Void>> handler)
Same as
writeEarlyHints(io.vertx.reactivex.core.MultiMap, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
newInstance, newInstance
newInstance
public static final io.vertx.lang.rx.TypeArg<HttpServerResponse> __TYPE_ARG
public HttpServerResponse(HttpServerResponse delegate)
public HttpServerResponse(Object delegate)
public HttpServerResponse getDelegate()
getDelegate
in interface StreamBase
getDelegate
in interface WriteStream<Buffer>
public WriteStreamObserver<Buffer> toObserver()
public WriteStreamSubscriber<Buffer> toSubscriber()
public void write(Buffer data, Handler<AsyncResult<Void>> handler)
handler
called when the operation completeswrite
in interface WriteStream<Buffer>
data
- handler
- public void write(Buffer data)
handler
called when the operation completeswrite
in interface WriteStream<Buffer>
data
- public Completable rxWrite(Buffer data)
handler
called when the operation completesrxWrite
in interface WriteStream<Buffer>
data
- public void end(Handler<AsyncResult<Void>> handler)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesend
in interface WriteStream<Buffer>
handler
- public void end()
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesend
in interface WriteStream<Buffer>
public Completable rxEnd()
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesrxEnd
in interface WriteStream<Buffer>
public boolean writeQueueFull()
true
if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)
writeQueueFull
in interface WriteStream<Buffer>
true
if write queue is fullpublic HttpServerResponse exceptionHandler(Handler<Throwable> handler)
WriteStream
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerpublic HttpServerResponse setWriteQueueMaxSize(int maxSize)
WriteStream
maxSize
. You will still be able to write to the stream even
if there is more than maxSize
items in the write queue. This is used as an indicator by classes such as
Pipe
to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket
, etc...setWriteQueueMaxSize
in interface WriteStream<Buffer>
maxSize
- the max size of the write streampublic HttpServerResponse drainHandler(Handler<Void> handler)
WriteStream
Pipe
for 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
.
drainHandler
in interface WriteStream<Buffer>
handler
- the handlerpublic int getStatusCode()
200
representing OK
.public HttpServerResponse setStatusCode(int statusCode)
statusCode
- public String getStatusMessage()
setStatusCode(int)
has been set to.public HttpServerResponse setStatusMessage(String statusMessage)
statusMessage
- public HttpServerResponse setChunked(boolean chunked)
chunked
is true
, 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-Encoding
with a value of Chunked
will be
automatically inserted in the response.
If chunked
is false
, 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 the Content-Length
header 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.
chunked
- public boolean isChunked()
public MultiMap headers()
public HttpServerResponse putHeader(String name, String value)
name
- the header namevalue
- the header value.public MultiMap trailers()
public HttpServerResponse putTrailer(String name, String value)
name
- the trailer namevalue
- the trailer valuepublic HttpServerResponse closeHandler(Handler<Void> handler)
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.
handler
- the handlerpublic HttpServerResponse endHandler(Handler<Void> handler)
handler
- the handlerpublic void write(String chunk, String enc, Handler<AsyncResult<Void>> handler)
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- enc
- handler
- public void write(String chunk, String enc)
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- enc
- public Completable rxWrite(String chunk, String enc)
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- enc
- public void write(String chunk, Handler<AsyncResult<Void>> handler)
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- handler
- public void write(String chunk)
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- public Completable rxWrite(String chunk)
write(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- public HttpServerResponse writeContinue()
public void writeEarlyHints(MultiMap headers, Handler<AsyncResult<Void>> handler)
writeEarlyHints(io.vertx.reactivex.core.MultiMap, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesheaders
- headers to writehandler
- public void writeEarlyHints(MultiMap headers)
writeEarlyHints(io.vertx.reactivex.core.MultiMap, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesheaders
- headers to writepublic Completable rxWriteEarlyHints(MultiMap headers)
writeEarlyHints(io.vertx.reactivex.core.MultiMap, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesheaders
- headers to writepublic void end(String chunk, Handler<AsyncResult<Void>> handler)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- handler
- public void end(String chunk)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- public Completable rxEnd(String chunk)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- public void end(String chunk, String enc, Handler<AsyncResult<Void>> handler)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- enc
- handler
- public void end(String chunk, String enc)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- enc
- public Completable rxEnd(String chunk, String enc)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completeschunk
- enc
- public void end(Buffer chunk, Handler<AsyncResult<Void>> handler)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesend
in interface WriteStream<Buffer>
chunk
- handler
- public void end(Buffer chunk)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesend
in interface WriteStream<Buffer>
chunk
- public Completable rxEnd(Buffer chunk)
end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with an handler
called when the operation completesrxEnd
in interface WriteStream<Buffer>
chunk
- public void send(Handler<AsyncResult<Void>> handler)
handler
- the completion handlerpublic void send()
public Completable rxSend()
public void send(String body, Handler<AsyncResult<Void>> handler)
body
.body
- handler
- the completion handlerpublic void send(String body)
body
.body
- public Completable rxSend(String body)
body
.body
- public void send(Buffer body, Handler<AsyncResult<Void>> handler)
body
.body
- handler
- the completion handlerpublic void send(Buffer body)
body
.body
- public Completable rxSend(Buffer body)
body
.body
- public void send(ReadStream<Buffer> body, Handler<AsyncResult<Void>> handler)
body
.
If the HttpHeaders
is set then the request assumes this is the
length of the {stream}, otherwise the request will set a chunked HttpHeaders
.
body
- handler
- the completion handlerpublic void send(ReadStream<Buffer> body)
body
.
If the HttpHeaders
is set then the request assumes this is the
length of the {stream}, otherwise the request will set a chunked HttpHeaders
.
body
- public Completable rxSend(ReadStream<Buffer> body)
body
.
If the HttpHeaders
is set then the request assumes this is the
length of the {stream}, otherwise the request will set a chunked HttpHeaders
.
body
- public void send(Flowable<Buffer> body, Handler<AsyncResult<Void>> handler)
body
.
If the HttpHeaders
is set then the request assumes this is the
length of the {stream}, otherwise the request will set a chunked HttpHeaders
.
body
- handler
- the completion handlerpublic void send(Flowable<Buffer> body)
body
.
If the HttpHeaders
is set then the request assumes this is the
length of the {stream}, otherwise the request will set a chunked HttpHeaders
.
body
- public Completable rxSend(Flowable<Buffer> body)
body
.
If the HttpHeaders
is set then the request assumes this is the
length of the {stream}, otherwise the request will set a chunked HttpHeaders
.
body
- public HttpServerResponse sendFile(String filename, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been completely
written to the wire.filename
- path to the file to serveresultHandler
- handler that will be called on completionpublic HttpServerResponse sendFile(String filename)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been completely
written to the wire.filename
- path to the file to servepublic Completable rxSendFile(String filename)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been completely
written to the wire.filename
- path to the file to servepublic HttpServerResponse sendFile(String filename, long offset, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been completely
written to the wire.filename
- path to the file to serveoffset
- the offset to serve fromresultHandler
- handler that will be called on completionpublic HttpServerResponse sendFile(String filename, long offset)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been completely
written to the wire.filename
- path to the file to serveoffset
- the offset to serve frompublic Completable rxSendFile(String filename, long offset)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been completely
written to the wire.filename
- path to the file to serveoffset
- the offset to serve frompublic HttpServerResponse sendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been
completely written to the wire.filename
- path to the file to serveoffset
- the offset to serve fromlength
- length the number of bytes to sendresultHandler
- handler that will be called on completionpublic HttpServerResponse sendFile(String filename, long offset, long length)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been
completely written to the wire.filename
- path to the file to serveoffset
- the offset to serve fromlength
- length the number of bytes to sendpublic Completable rxSendFile(String filename, long offset, long length)
sendFile(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but providing a handler which will be notified once the file has been
completely written to the wire.filename
- path to the file to serveoffset
- the offset to serve fromlength
- length the number of bytes to sendpublic void close()
public boolean ended()
public boolean closed()
public boolean headWritten()
public HttpServerResponse headersEndHandler(Handler<Void> handler)
This provides a hook allowing you to add any more headers or do any more operations before this occurs.
handler
- the handlerpublic HttpServerResponse bodyEndHandler(Handler<Void> handler)
handler
- the handlerpublic long bytesWritten()
public int streamId()
public HttpServerResponse push(HttpMethod method, String host, String path, Handler<AsyncResult<HttpServerResponse>> handler)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with no headers.method
- host
- path
- handler
- public HttpServerResponse push(HttpMethod method, String host, String path)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with no headers.method
- host
- path
- public Single<HttpServerResponse> rxPush(HttpMethod method, String host, String path)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with no headers.method
- host
- path
- public HttpServerResponse push(HttpMethod method, String path, MultiMap headers, Handler<AsyncResult<HttpServerResponse>> handler)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with the host copied from the current request.method
- path
- headers
- handler
- public HttpServerResponse push(HttpMethod method, String path, MultiMap headers)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with the host copied from the current request.method
- path
- headers
- public Single<HttpServerResponse> rxPush(HttpMethod method, String path, MultiMap headers)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with the host copied from the current request.method
- path
- headers
- public HttpServerResponse push(HttpMethod method, String path, Handler<AsyncResult<HttpServerResponse>> handler)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with the host copied from the current request.method
- path
- handler
- public HttpServerResponse push(HttpMethod method, String path)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with the host copied from the current request.method
- path
- public Single<HttpServerResponse> rxPush(HttpMethod method, String path)
push(io.vertx.core.http.HttpMethod, java.lang.String, java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.http.HttpServerResponse>>)
with the host copied from the current request.method
- path
- public HttpServerResponse push(HttpMethod method, String host, String path, MultiMap headers, Handler<AsyncResult<HttpServerResponse>> handler)
handler
will 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.
The handler
may 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.method
- the method of the promised requesthost
- the host of the promised requestpath
- the path of the promised requestheaders
- the headers of the promised requesthandler
- the handler notified when the response can be writtenpublic HttpServerResponse push(HttpMethod method, String host, String path, MultiMap headers)
handler
will 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.
The handler
may 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.method
- the method of the promised requesthost
- the host of the promised requestpath
- the path of the promised requestheaders
- the headers of the promised requestpublic Single<HttpServerResponse> rxPush(HttpMethod method, String host, String path, MultiMap headers)
handler
will 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.
The handler
may 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.method
- the method of the promised requesthost
- the host of the promised requestpath
- the path of the promised requestheaders
- the headers of the promised requestpublic boolean reset()
0
.public boolean reset(long code)
code
false
is returned as indicator.code
- the error codetrue
when reset has been performedpublic HttpServerResponse writeCustomFrame(int type, int flags, Buffer payload)
The frame is sent immediatly and is not subject to flow control.
type
- the 8-bit frame typeflags
- the 8-bit frame flagspayload
- the frame payloadpublic HttpServerResponse writeCustomFrame(HttpFrame frame)
writeCustomFrame(int, int, io.vertx.reactivex.core.buffer.Buffer)
but with an HttpFrame
.frame
- the frame to writepublic HttpServerResponse setStreamPriority(StreamPriority streamPriority)
streamPriority
- the priority for this request's streampublic HttpServerResponse addCookie(Cookie cookie)
cookie
- the cookiepublic Cookie removeCookie(String name)
removeCookies(java.lang.String)
name
- the name of the cookiepublic Cookie removeCookie(String name, boolean invalidate)
true
then 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)
name
- the name of the cookieinvalidate
- null
public Set<Cookie> removeCookies(String name)
UnsupportedOperationException
.name
- the name of the cookiepublic Set<Cookie> removeCookies(String name, boolean invalidate)
true
then 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
throw UnsupportedOperationException
.name
- the name of the cookieinvalidate
- invalidate from the user agentpublic Cookie removeCookie(String name, String domain, String path)
name
- the name of the cookiedomain
- the domain of the cookiepath
- the path of the cookienull
public Cookie removeCookie(String name, String domain, String path, boolean invalidate)
true
then it will expire a cookie, notifying a User
Agent to remove it from its cookie jar.name
- the name of the cookiedomain
- the domain of the cookiepath
- the path of the cookieinvalidate
- null
public HttpServerResponse putHeader(CharSequence name, CharSequence value)
putHeader(java.lang.String, java.lang.String)
but using CharSequencename
- value
- public HttpServerResponse putHeader(String name, Iterable<String> values)
putHeader(java.lang.String, java.lang.String)
but providing multiple values via a String Iterablename
- values
- public HttpServerResponse putHeader(CharSequence name, Iterable<CharSequence> values)
putHeader(java.lang.String, java.lang.String)
but with CharSequence Iterablename
- values
- public HttpServerResponse putTrailer(CharSequence name, CharSequence value)
putTrailer(java.lang.String, java.lang.String)
but using CharSequencename
- value
- public HttpServerResponse putTrailer(String name, Iterable<String> values)
putTrailer(java.lang.String, java.lang.String)
but providing multiple values via a String Iterablename
- values
- public HttpServerResponse putTrailer(CharSequence name, Iterable<CharSequence> value)
putTrailer(java.lang.String, java.lang.String)
but with CharSequence Iterablename
- value
- public static HttpServerResponse newInstance(HttpServerResponse arg)
Copyright © 2023 Eclipse. All rights reserved.