Vert.x 4.5.13 · io.vertx.core.http.impl.Http1xServerResponse

Modifier and Type	Field and Description
private Handler<Void>	bodyEndHandler
private long	bytesWritten
private boolean	closed
private Handler<Void>	closeHandler
private final Http1xServerConnection	conn
private final ContextInternal	context
private CookieJar	cookies
private Handler<Void>	drainHandler
private static final Buffer	EMPTY_BUFFER References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
private Handler<Void>	endHandler
private Handler<Throwable>	exceptionHandler
private final boolean	head
private final HeadersMultiMap	headers
private Handler<Void>	headersEndHandler
private boolean	headWritten
private final boolean	keepAlive
private static final Logger	log
private Future<NetSocket>	netSocket
private final HttpRequest	request
private final Object	requestMetric
private static final String	RESPONSE_WRITTEN
private HttpResponseStatus	status
private String	statusMessage
private MultiMap	trailers
private HttpHeaders	trailingHeaders
private final HttpVersion	version
private final VertxInternal	vertx
private boolean	writable
private boolean	written

Access	Constructor and Description
pack-priv	Http1xServerResponse(VertxInternal vertx, ContextInternal context, Http1xServerConnection conn, HttpRequest request, Object requestMetric, boolean writable, boolean keepAlive)

Method Summary

Modifier and Type	Method and Description
public HttpServerResponse	addCookie(Cookie the cookie cookie) Implements io.vertx.core.http.HttpServerResponse.addCookie. Add a cookie.
public HttpServerResponse	bodyEndHandler(Handler<Void> handler)
public long	bytesWritten() Implements io.vertx.core.http.HttpServerResponse.bytesWritten.
private void	checkHeadWritten()
private void	checkValid()
public void	close() Implements io.vertx.core.http.HttpServerResponse.close. Close the underlying TCP connection corresponding to the request.
private void	closeConnAfterWrite()
public boolean	closed() Implements io.vertx.core.http.HttpServerResponse.closed.
public HttpServerResponse	closeHandler(Handler<Void> handler)
pack-priv void	completeHandshake()
pack-priv CookieJar	cookies()
private void	doSendFile(String filename, long offset, long length, Handler<AsyncResult<Void>> resultHandler)
public HttpServerResponse	drainHandler(Handler<Void> handler) Implements io.vertx.core.http.HttpServerResponse.drainHandler.
public Future<Void>	end(String the string to write before ending the response chunk) Implements io.vertx.core.http.HttpServerResponse.end. Same as `end(Buffer)` but writes a String in UTF-8 encoding before ending the response.
public void	end(String chunk, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.HttpServerResponse.end. Same as `end(String)` but with an `handler` called when the operation completes
public Future<Void>	end(String the string to write before ending the response chunk, String the encoding to use enc) Implements io.vertx.core.http.HttpServerResponse.end. Same as `end(Buffer)` but writes a String with the specified encoding before ending the response.
public void	end(String chunk, String enc, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.HttpServerResponse.end. Same as `end(String, String)` but with an `handler` called when the operation completes
public Future<Void>	end(Buffer the buffer to write before ending the response chunk) Implements io.vertx.core.http.HttpServerResponse.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `end()` but writes some data to the response body before ending.
public void	end(Buffer chunk, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.HttpServerResponse.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `end(Buffer)` but with an `handler` called when the operation completes
private void	end(Buffer chunk, PromiseInternal<Void> listener) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
public Future<Void>	end() Implements io.vertx.core.http.HttpServerResponse.end. Ends the response.
public void	end(Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Implements io.vertx.core.streams.WriteStream.end. Same as `end()` but with an `handler` called when the operation completes
public boolean	ended() Implements io.vertx.core.http.HttpServerResponse.ended.
public HttpServerResponse	endHandler(@Nullable Handler<Void> handler)
public HttpServerResponse	exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.HttpServerResponse.exceptionHandler.
public int	getStatusCode() Implements io.vertx.core.http.HttpServerResponse.getStatusCode.
public String	getStatusMessage() Implements io.vertx.core.http.HttpServerResponse.getStatusMessage.
private void	handleClosed()
pack-priv void	handleException(Throwable t)
pack-priv void	handleWritabilityChanged(boolean writable)
public MultiMap	headers() Implements io.vertx.core.http.HttpServerResponse.headers, io.vertx.core.spi.observability.HttpResponse.headers.
public HttpServerResponse	headersEndHandler(Handler<Void> handler)
public boolean	headWritten() Implements io.vertx.core.http.HttpServerResponse.headWritten.
public boolean	isChunked() Implements io.vertx.core.http.HttpServerResponse.isChunked.
pack-priv Future<NetSocket>	netSocket(HttpMethod requestMethod, MultiMap requestHeaders)
private void	prepareHeaders(long contentLength)
public Future<HttpServerResponse>	push(HttpMethod method, HostAndPort authority, String path, MultiMap headers) Implements io.vertx.core.http.HttpServerResponse.push. Same as `push(HttpMethod, String, String, MultiMap, Handler)` but with an `handler` called when the operation completes
public Future<HttpServerResponse>	push(HttpMethod the method of the promised request method, String the host of the promised request host, String the path of the promised request path, MultiMap the headers of the promised request headers) Implements io.vertx.core.http.HttpServerResponse.push. Push a response to the client.
public Http1xServerResponse	putHeader(String the header name key, String the header value. value) Implements io.vertx.core.http.HttpServerResponse.putHeader. Put an HTTP header
public Http1xServerResponse	putHeader(String key, Iterable<String> values) Implements io.vertx.core.http.HttpServerResponse.putHeader. Like `putHeader(String, String)` but providing multiple values via a String Iterable
public HttpServerResponse	putHeader(CharSequence name, CharSequence value) Implements io.vertx.core.http.HttpServerResponse.putHeader. Like `putHeader(String, String)` but using CharSequence
public HttpServerResponse	putHeader(CharSequence name, Iterable<CharSequence> values) Implements io.vertx.core.http.HttpServerResponse.putHeader. Like `putHeader(String, Iterable)` but with CharSequence Iterable
public Http1xServerResponse	putTrailer(String the trailer name key, String the trailer value value) Implements io.vertx.core.http.HttpServerResponse.putTrailer. Put an HTTP trailer
public Http1xServerResponse	putTrailer(String key, Iterable<String> values) Implements io.vertx.core.http.HttpServerResponse.putTrailer. Like `putTrailer(String, String)` but providing multiple values via a String Iterable
public HttpServerResponse	putTrailer(CharSequence name, CharSequence value) Implements io.vertx.core.http.HttpServerResponse.putTrailer. Like `putTrailer(String, String)` but using CharSequence
public HttpServerResponse	putTrailer(CharSequence name, Iterable<CharSequence> value) Implements io.vertx.core.http.HttpServerResponse.putTrailer. Like `putTrailer(String, Iterable)` but with CharSequence Iterable
public @Nullable Cookie	removeCookie(String the name of the cookie name, boolean invalidate) Implements io.vertx.core.http.HttpServerResponse.removeCookie. Remove a cookie from the cookie set.
public @Nullable Cookie	removeCookie(String the name of the cookie name, String the domain of the cookie domain, String the path of the cookie path, boolean invalidate) Implements io.vertx.core.http.HttpServerResponse.removeCookie. Remove a cookie from the cookie set.
public @Nullable Set<Cookie>	removeCookies(String the name of the cookie name, boolean invalidate from the user agent invalidate) Implements io.vertx.core.http.HttpServerResponse.removeCookies. Remove all cookies from the cookie set.
private void	reportResponseBegin()
public boolean	reset(long the error code code) Implements io.vertx.core.http.HttpServerResponse.reset. 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
public Future<Void>	sendFile(String path to the file to serve filename, long offset to start serving from offset, long the number of bytes to send length) Implements io.vertx.core.http.HttpServerResponse.sendFile. Ask the OS to stream a file as specified by `filename` directly from disk to the outgoing connection, bypassing userspace altogether (where supported by the underlying operating system.
public HttpServerResponse	sendFile(String path to the file to serve filename, long the offset to serve from start, long length the number of bytes to send end, Handler<AsyncResult<Void>> handler that will be called on completion resultHandler) Implements io.vertx.core.http.HttpServerResponse.sendFile. Like `sendFile(String, long, long)` but providing a handler which will be notified once the file has been completely written to the wire.
public Http1xServerResponse	setChunked(boolean chunked) Implements io.vertx.core.http.HttpServerResponse.setChunked. 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.
private void	setCookies()
public HttpServerResponse	setStatusCode(int statusCode) Implements io.vertx.core.http.HttpServerResponse.setStatusCode. Set the status code.
public HttpServerResponse	setStatusMessage(String statusMessage) Implements io.vertx.core.http.HttpServerResponse.setStatusMessage. Set the status message
public HttpServerResponse	setWriteQueueMaxSize(int the max size of the write stream size) Implements io.vertx.core.http.HttpServerResponse.setWriteQueueMaxSize. Set the maximum size of the write queue to `maxSize`.
public int	statusCode() Implements io.vertx.core.spi.observability.HttpResponse.statusCode.
public int	streamId() Implements io.vertx.core.http.HttpServerResponse.streamId.
public MultiMap	trailers() Implements io.vertx.core.http.HttpServerResponse.trailers.
public Future<Void>	write(Buffer the data to write chunk) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Write some data to the stream.
public void	write(Buffer chunk, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `write(T)` but with an `handler` called when the operation completes
public Future<Void>	write(String the string to write chunk, String the encoding to use enc) Implements io.vertx.core.http.HttpServerResponse.write. Write a `String` to the response body, encoded using the encoding `enc`.
public void	write(String chunk, String enc, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.HttpServerResponse.write. Same as `write(String, String)` but with an `handler` called when the operation completes
public Future<Void>	write(String the string to write chunk) Implements io.vertx.core.http.HttpServerResponse.write. Write a `String` to the response body, encoded in UTF-8.
public void	write(String chunk, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.HttpServerResponse.write. Same as `write(String)` but with an `handler` called when the operation completes
private Http1xServerResponse	write(ByteBuf chunk, PromiseInternal<Void> promise)
public HttpServerResponse	writeContinue() Implements io.vertx.core.http.HttpServerResponse.writeContinue. Used to write an interim 100 Continue response to signify that the client should send the rest of the request.
public HttpServerResponse	writeCustomFrame(int the 8-bit frame type type, int the 8-bit frame flags flags, Buffer the frame payload payload) Implements io.vertx.core.http.HttpServerResponse.writeCustomFrame. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.
public Future<Void>	writeEarlyHints(MultiMap headers to write headers) Implements io.vertx.core.http.HttpServerResponse.writeEarlyHints. Used to write an interim 103 Early Hints response to return some HTTP headers before the final HTTP message.
public void	writeEarlyHints(MultiMap headers to write headers, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.HttpServerResponse.writeEarlyHints. Same as `writeEarlyHints(MultiMap)` but with an `handler` called when the operation completes
public boolean	writeQueueFull() Implements io.vertx.core.streams.WriteStream.writeQueueFull. This will return `true` if there are more bytes in the write queue than the value set using `setWriteQueueMaxSize`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class Http1xServerResponse

Field Summary

Constructor Summary

Method Summary