Uses of Class
io.vertx.core.http.HttpServerOptions
Packages that use HttpServerOptions
Package
Description
-
Uses of HttpServerOptions in io.vertx.core
Methods in io.vertx.core with parameters of type HttpServerOptionsModifier and TypeMethodDescriptiondefault HttpServerVertx.createHttpServer(HttpServerOptions options) Create an HTTP/HTTPS server using the specifiedoptions -
Uses of HttpServerOptions in io.vertx.core.http
Methods in io.vertx.core.http that return HttpServerOptionsModifier and TypeMethodDescriptionHttpServerOptions.addCompressor(CompressionOptions compressor) Add a compressor.HttpServerOptions.addCrlPath(String crlPath) HttpServerOptions.addCrlValue(Buffer crlValue) HttpServerOptions.addEnabledCipherSuite(String suite) HttpServerOptions.addEnabledSecureTransportProtocol(String protocol) HttpServerOptions.addWebSocketSubProtocol(String subProtocol) Add a WebSocket sub-protocol to the list supported by the server.HttpServerOptions.copy()Copy these options.HttpServerOptions.removeEnabledCipherSuite(String suite) HttpServerOptions.removeEnabledSecureTransportProtocol(String protocol) HttpServerOptions.setAcceptBacklog(int acceptBacklog) HttpServerOptions.setAcceptUnmaskedFrames(boolean acceptUnmaskedFrames) Settruewhen the server accepts unmasked frame.HttpServerOptions.setActivityLogDataFormat(ByteBufFormat activityLogDataFormat) HttpServerOptions.setAlpnVersions(List<HttpVersion> alpnVersions) Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.HttpServerOptions.setClientAuth(ClientAuth clientAuth) HttpServerOptions.setCompression(CompressionConfig compression) Configure the server compression, this overwrites any previously configuration.HttpServerOptions.setCompressionContentSizeThreshold(int compressionContentSizeThreshold) Set the compression content size threshold if compression is enabled.HttpServerOptions.setCompressionLevel(int compressionLevel) This method allows to set the compression level to be used in http1.x/2 response bodies when compression support is turned on (@see setCompressionSupported) and the client advertises to supportdeflate/gzipcompression in theAccept-Encodingheader default value is : 6 (Netty legacy) The compression level determines how much the data is compressed on a scale from 1 to 9, where '9' is trying to achieve the maximum compression ratio while '1' instead is giving priority to speed instead of compression ratio using some algorithm optimizations and skipping pedantic loops that usually gives just little improvements While one can think that best value is always the maximum compression ratio, there's a trade-off to consider: the most compressed level requires the most computational work to compress/decompress data, e.g. more dictionary lookups and loops.HttpServerOptions.setCompressionSupported(boolean compressionSupported) Set whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header)HttpServerOptions.setCompressors(List<CompressionOptions> compressors) Set the list of compressor to use instead of using the default gzip/deflateHttpServerOptions.setCompressionLevel(int)configuration.HttpServerOptions.setDecoderInitialBufferSize(int decoderInitialBufferSize) Set the initial buffer size for the HTTP decoderHttpServerOptions.setDecompressionSupported(boolean decompressionSupported) Set whether the server supports decompressionHttpServerOptions.setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols) HttpServerOptions.setHandle100ContinueAutomatically(boolean handle100ContinueAutomatically) Set whether 100 Continue should be handled automaticallyHttpServerOptions.setHttp2ClearTextEnabled(boolean http2ClearTextEnabled) Set whether HTTP/2 over clear text is enabled or disabled, default is enabled.HttpServerOptions.setHttp2ConnectionWindowSize(int http2ConnectionWindowSize) Set the default HTTP/2 connection window size.HttpServerOptions.setHttp2MaxSmallContinuationFrames(int http2MaxSmallContinuationFrames) Set the maximum number of small continuation frames allowed, this is used to prevent flood DoS attack via zero-byte continuation frames.HttpServerOptions.setHttp2MultiplexImplementation(boolean http2MultiplexImplementation) Set which HTTP/2 implementation to useHttpServerOptions.setHttp2RstFloodMaxRstFramePerWindow(int http2RstFloodMaxRstFramePerWindow) Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks.HttpServerOptions.setHttp2RstFloodWindowDuration(int http2RstFloodWindowDuration) Set the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks.HttpServerOptions.setHttp2RstFloodWindowDurationTimeUnit(TimeUnit http2RstFloodWindowDurationTimeUnit) Set the time unit of the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks.HttpServerOptions.setIdleTimeout(int idleTimeout) HttpServerOptions.setIdleTimeoutUnit(TimeUnit idleTimeoutUnit) HttpServerOptions.setInitialSettings(Http2Settings settings) Set the HTTP/2 connection settings immediatly sent by the server when a client connects.HttpServerOptions.setKeyCertOptions(KeyCertOptions options) HttpServerOptions.setLogActivity(boolean logEnabled) HttpServerOptions.setMaxChunkSize(int maxChunkSize) Set the maximum HTTP chunk size thatHttpServerRequest.handler(Handler)will receiveHttpServerOptions.setMaxFormAttributeSize(int maxSize) Set the maximum size of a form attribute.HttpServerOptions.setMaxFormBufferedBytes(int maxFormBufferedBytes) Set the maximum number of bytes a server can buffer when decoding a form.HttpServerOptions.setMaxFormFields(int maxFormFields) Set the maximum number of fields of a form.HttpServerOptions.setMaxHeaderSize(int maxHeaderSize) Set the maximum length of all headers for HTTP/1.x .HttpServerOptions.setMaxInitialLineLength(int maxInitialLineLength) Set the maximum length of the initial line for HTTP/1.x (e.g.HttpServerOptions.setMaxWebSocketFrameSize(int maxWebSocketFrameSize) Set the maximum WebSocket frames sizeHttpServerOptions.setMaxWebSocketMessageSize(int maxWebSocketMessageSize) Set the maximum WebSocket message sizeHttpServerOptions.setMetricsName(String metricsName) Set the metrics name identifying the reported metrics, useful for naming the server metrics.HttpServerOptions.setPerFrameWebSocketCompressionSupported(boolean supported) Enable or disable support for the WebSocket per-frame deflate compression extension.HttpServerOptions.setPerMessageWebSocketCompressionSupported(boolean supported) Enable or disable support for WebSocket per-message deflate compression extension.HttpServerOptions.setPort(int port) HttpServerOptions.setProxyProtocolTimeout(long proxyProtocolTimeout) HttpServerOptions.setProxyProtocolTimeoutUnit(TimeUnit proxyProtocolTimeoutUnit) HttpServerOptions.setReadIdleTimeout(int idleTimeout) HttpServerOptions.setReceiveBufferSize(int receiveBufferSize) HttpServerOptions.setRegisterWebSocketWriteHandlers(boolean registerWebSocketWriteHandlers) Whether write-handlers for server websockets should be registered on theEventBus.HttpServerOptions.setRegisterWriteHandler(boolean registerWriteHandler) Has no effect on HTTP server options.HttpServerOptions.setReuseAddress(boolean reuseAddress) HttpServerOptions.setReusePort(boolean reusePort) HttpServerOptions.setSendBufferSize(int sendBufferSize) HttpServerOptions.setSni(boolean sni) HttpServerOptions.setSoLinger(int soLinger) HttpServerOptions.setSsl(boolean ssl) HttpServerOptions.setSslEngineOptions(SSLEngineOptions sslEngineOptions) HttpServerOptions.setSslHandshakeTimeout(long sslHandshakeTimeout) HttpServerOptions.setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit) HttpServerOptions.setStrictThreadMode(boolean strictThreadMode) Indicates the server that the HTTP request/response interactions will happen exclusively on the expected thread when the threading model is event-loop.HttpServerOptions.setTcpCork(boolean tcpCork) HttpServerOptions.setTcpFastOpen(boolean tcpFastOpen) HttpServerOptions.setTcpKeepAlive(boolean tcpKeepAlive) HttpServerOptions.setTcpNoDelay(boolean tcpNoDelay) HttpServerOptions.setTcpQuickAck(boolean tcpQuickAck) HttpServerOptions.setTcpUserTimeout(int tcpUserTimeout) HttpServerOptions.setTracingPolicy(TracingPolicy tracingPolicy) Set the tracing policy for the server behavior when Vert.x has tracing enabled.HttpServerOptions.setTrafficClass(int trafficClass) HttpServerOptions.setTrafficShapingOptions(TrafficShapingOptions trafficShapingOptions) HttpServerOptions.setTrustOptions(TrustOptions options) HttpServerOptions.setUseAlpn(boolean useAlpn) HttpServerOptions.setUseProxyProtocol(boolean useProxyProtocol) HttpServerOptions.setWebSocketAllowServerNoContext(boolean accept) Set whether the WebSocket server will accept theserver_no_context_takeoverparameter of the per-message deflate compression extension offered by the client.HttpServerOptions.setWebSocketClosingTimeout(int webSocketClosingTimeout) Set the amount of time a server WebSocket will wait until it closes the TCP connection after sending a close frame.HttpServerOptions.setWebSocketCompressionLevel(int compressionLevel) Set the WebSocket compression level.HttpServerOptions.setWebSocketPreferredClientNoContext(boolean accept) Set whether the WebSocket server will accept theclient_no_context_takeoverparameter of the per-message deflate compression extension offered by the client.HttpServerOptions.setWebSocketSubProtocols(List<String> subProtocols) Set the WebSocket list of sub-protocol supported by the server.HttpServerOptions.setWriteIdleTimeout(int idleTimeout) Constructors in io.vertx.core.http with parameters of type HttpServerOptionsModifierConstructorDescriptionHttpServerConfig(HttpServerOptions options) Copies theHttpServerOptions.Copy constructor -
Uses of HttpServerOptions in io.vertx.ext.shell.term
Subclasses of HttpServerOptions in io.vertx.ext.shell.term -
Uses of HttpServerOptions in io.vertx.grpc
Method parameters in io.vertx.grpc with type arguments of type HttpServerOptionsModifier and TypeMethodDescriptionVertxServerBuilder.useSsl(Handler<HttpServerOptions> handler) Deprecated, for removal: This API element is subject to removal in a future version. -
Uses of HttpServerOptions in io.vertx.micrometer
Methods in io.vertx.micrometer that return HttpServerOptionsModifier and TypeMethodDescriptionVertxPrometheusOptions.getEmbeddedServerOptions()Get the HTTP server options of the embedded server, if anyMethods in io.vertx.micrometer with parameters of type HttpServerOptionsModifier and TypeMethodDescriptionVertxPrometheusOptions.setEmbeddedServerOptions(HttpServerOptions embeddedServerOptions) HTTP server options for the embedded server -
Uses of HttpServerOptions in io.vertx.reactivex.core
Methods in io.vertx.reactivex.core with parameters of type HttpServerOptionsModifier and TypeMethodDescriptionVertx.createHttpServer(HttpServerOptions options) Create an HTTP/HTTPS server using the specifiedoptions -
Uses of HttpServerOptions in io.vertx.rxjava3.core
Methods in io.vertx.rxjava3.core with parameters of type HttpServerOptionsModifier and TypeMethodDescriptionVertx.createHttpServer(HttpServerOptions options) Create an HTTP/HTTPS server using the specifiedoptions