io.vertx.core.http.HttpServer instance
| Modifier and Type | Field and Description |
|---|---|
| private boolean | |
| private List | |
| private int | |
| private boolean | |
| private List | |
| private int | |
| private boolean | |
| public static final boolean | DEFAULT_ACCEPT_UNMASKED_FRAMES
Default WebSocket Masked bit is true as depicted by RFC = |
| public static final List | DEFAULT_ALPN_VERSIONS
Default Application-Layer Protocol Negotiation versions = [HTTP/2,HTTP/1.1] |
| public static final int | DEFAULT_COMPRESSION_LEVEL
Default gzip/deflate compression level = 6 (Netty legacy) |
| public static final boolean | DEFAULT_COMPRESSION_SUPPORTED
Default value of whether compression is supported = |
| public static final int | DEFAULT_DECODER_INITIAL_BUFFER_SIZE
Default initial buffer size for HttpObjectDecoder = 128 bytes |
| public static final boolean | DEFAULT_DECOMPRESSION_SUPPORTED
Default value of whether decompression is supported = |
| public static final boolean | DEFAULT_HANDLE_100_CONTINE_AUTOMATICALLY
Default value of whether 100-Continue should be handled automatically = |
| public static final boolean | DEFAULT_HTTP2_CLEAR_TEXT_ENABLED
Default H2C is enabled = |
| public static final int | DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE
The default HTTP/2 connection window size = -1 |
| public static final int | DEFAULT_HTTP2_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW
HTTP/2 RST floods DDOS protection, max number of RST frame per time window allowed = 200. |
| public static final int | DEFAULT_HTTP2_RST_FLOOD_WINDOW_DURATION
HTTP/2 RST floods DDOS protection, time window duration = 30. |
| public static final TimeUnit | DEFAULT_HTTP2_RST_FLOOD_WINDOW_DURATION_TIME_UNIT
HTTP/2 RST floods DDOS protection, time window duration unit = |
| public static final long | DEFAULT_INITIAL_SETTINGS_MAX_CONCURRENT_STREAMS
The default initial settings max concurrent stream for an HTTP/2 server = 100 |
| public static final int | DEFAULT_MAX_CHUNK_SIZE
Default max HTTP chunk size = 8192 |
| public static final int | DEFAULT_MAX_FORM_ATTRIBUTE_SIZE
Default max size of a form attribute = 8192 |
| public static final int | DEFAULT_MAX_FORM_BUFFERED_SIZE
Default max number buffered bytes when decoding a form = 1024 |
| public static final int | DEFAULT_MAX_FORM_FIELDS
Default max number of form fields = 256 |
| public static final int | DEFAULT_MAX_HEADER_SIZE
Default max length of all headers = 8192 |
| public static final int | DEFAULT_MAX_INITIAL_LINE_LENGTH
Default max length of the initial line (e.g. |
| public static final int | DEFAULT_MAX_WEBSOCKET_FRAME_SIZE
Default max WebSocket frame size = 65536 |
| public static final int | DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE
Default max WebSocket message size (could be assembled from multiple frames) is 4 full frames worth of data |
| public static final boolean | DEFAULT_PER_FRAME_WEBSOCKET_COMPRESSION_SUPPORTED
Default support for WebSockets per-frame deflate compression extension = |
| public static final boolean | DEFAULT_PER_MESSAGE_WEBSOCKET_COMPRESSION_SUPPORTED
Default support for WebSockets per-message deflate compression extension = |
| public static final int | DEFAULT_PORT
Default port the server will listen on = 80
|
| public static final boolean | DEFAULT_REGISTER_WEBSOCKET_WRITE_HANDLERS
Whether write-handlers for server websockets should be registered by default = false. |
| public static final TracingPolicy | DEFAULT_TRACING_POLICY
Default tracing control = |
| public static final boolean | DEFAULT_WEBSOCKET_ALLOW_SERVER_NO_CONTEXT
Default allowance of the |
| public static final int | DEFAULT_WEBSOCKET_CLOSING_TIMEOUT
Default WebSocket closing timeout = 10 second) |
| public static final int | DEFAULT_WEBSOCKET_COMPRESSION_LEVEL
Default WebSocket deflate compression level = 6 |
| public static final boolean | DEFAULT_WEBSOCKET_PREFERRED_CLIENT_NO_CONTEXT
Default allowance of the |
| private boolean | |
| private boolean | |
| private int | |
| private int | |
| private int | |
| private TimeUnit | |
| private Http2Settings | |
| private int | |
| private int | |
| private int | |
| private int | |
| private int | |
| private int | |
| private int | |
| private int | |
| private boolean | |
| private boolean | |
| private boolean | |
| private TracingPolicy | |
| private boolean | |
| private int | |
| private int | |
| private boolean | |
| private List |
| Access | Constructor and Description |
|---|---|
| public | |
| public | |
| public | HttpServerOptions(JsonObject
the JSON json)
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
Create an options from JSON |
| Modifier and Type | Method and Description |
|---|---|
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlyAdd a compressor. |
| public HttpServerOptions | addCrlPath(String
the path crlPath)Overrides io. Add a CRL path |
| public HttpServerOptions | addCrlValue(Buffer
the value crlValue)Overrides io.
References Deprecated
Buffer is deprecated or references (maybe indirectly) at least one deprecated element.
Add a CRL value |
| public HttpServerOptions | addEnabledCipherSuite(String
the suite suite)Overrides io. Add an enabled cipher suite, appended to the ordered suites. |
| public HttpServerOptions | addEnabledSecureTransportProtocol(final String
the SSL/TLS protocol to enable protocol)Overrides io. Add an enabled SSL/TLS protocols, appended to the ordered protocols. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe sub-protocol to add subProtocol)Add a WebSocket sub-protocol to the list supported by the server. |
| public List | Returns: the list of protocol versions to provide during the Application-Layer Protocol Negotiatiation
|
| public int | Returns: the server gzip/deflate 'compression level' to be used in responses when client and server support is turned on
|
| public List | |
| public int | |
| public int | |
| public int | |
| public int | Returns: the duration of the time window when checking the max number of RST frames.
|
| public TimeUnit | Returns: the time unit of the duration of the time window when checking the max number of RST frames.
|
| public Http2Settings | |
| public int | Returns: the maximum HTTP chunk size thatHttpServerRequest#handler(Handler) will receive
|
| public int | |
| public int | Returns: Returns the maximum number of bytes a server can buffer when decoding a form
|
| public int | |
| public int | |
| public int | Returns: the maximum length of the initial line for HTTP/1.x (e.g."GET / HTTP/1.0")
|
| public int | |
| public int | |
| public boolean | Returns: true if the http server will accept the per-frame deflate compression extensionGet whether WebSocket the per-frame deflate compression extension is supported. |
| public boolean | Returns: true if the http server will accept the per-message deflate compression extensionGet whether WebSocket per-message deflate compression extension is supported. |
| public TracingPolicy | |
| public boolean | Returns: true when the WebSocket server will accept the server_no_context_takeover parameter for the per-message
deflate compression extension offered by the client
|
| public int | Returns: the amount of time (in seconds) a client WebSocket will wait until it closes TCP connection after receiving a close frame
|
| public int | |
| public boolean | Returns: true when the WebSocket server will accept the client_no_context_takeover parameter for the per-message
deflate compression extension offered by the client
|
| public List | |
| private void | |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | |
| public boolean | Returns: true if write-handlers for server websockets should be registered on the io., otherwise false
|
| public boolean | Returns: false, does not apply to HTTP serversOverrides io.
|
| public HttpServerOptions | removeEnabledCipherSuite(String
the suite suite)Overrides io. Removes an enabled cipher suite from the ordered suites. |
| public HttpServerOptions | removeEnabledSecureTransportProtocol(String
the SSL/TLS protocol to disable protocol)Overrides io. Removes an enabled SSL/TLS protocol from the ordered protocols. |
| public HttpServerOptions | setAcceptBacklog(int
accept backlog acceptBacklog)Overrides io. Set the accept back log |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue if enabledSet |
| public HttpServerOptions | setActivityLogDataFormat(ByteBufFormat
the format to use activityLogDataFormat)Overrides io. Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe versions alpnVersions)Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiatiation. |
| public HttpServerOptions | setClientAuth(ClientAuth
One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the
SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then
it won't mandate the certificate to be presented, basically make it optional. clientAuth)Overrides io. Set whether client auth is required |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlyinteger 1-9, 1 means use fastest algorithm, 9 slower algorithm but better compression ratio compressionLevel)This method allows to set the compression level to be used in http1.x/2 response bodies
when compression support is turned on |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue to enable compression supportSet whether the server should support gzip/deflate compression (serving compressed responses to clients advertising support for them with Accept-Encoding header) |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe list of compressors compressors)Set the list of compressor to use instead of using the default gzip/deflate |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe initial size decoderInitialBufferSize)Set the initial buffer size for the HTTP decoder |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue if decompression supportedSet whether the server supports decompression |
| public HttpServerOptions | setEnabledSecureTransportProtocols(Set<String>
the SSL/TLS protocols to enable enabledSecureTransportProtocols)Overrides io. Sets the list of enabled SSL/TLS protocols. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue if it should be handled automaticallySet whether 100 Continue should be handled automatically |
| public HttpServerOptions | |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlywhether to accept HTTP/2 over clear text http2ClearTextEnabled)Set whether HTTP/2 over clear text is enabled or disabled, default is enabled. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe window size applied to the connection http2ConnectionWindowSize)Set the default HTTP/2 connection window size. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new maximum http2RstFloodMaxRstFramePerWindow)Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new duration 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. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new duration 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. |
| public HttpServerOptions | setIdleTimeout(int
the timeout idleTimeout)Overrides io. Set the idle timeout, default time unit is seconds. |
| public HttpServerOptions | setIdleTimeoutUnit(TimeUnit
specify time unit. idleTimeoutUnit)Overrides io. Set the idle timeout unit. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe settings value settings)Set the HTTP/2 connection settings immediatly sent by the server when a client connects. |
| public HttpServerOptions | setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
Overrides io.
Deprecated
|
| public HttpServerOptions | setKeyCertOptions(KeyCertOptions
the key store options options)Overrides io. Set the key/cert options. |
| public HttpServerOptions | setKeyStoreOptions(JksOptions
the key store in jks format options)Overrides io.
Deprecated
Set the key/cert options in jks format, aka Java keystore. |
| public HttpServerOptions | setLogActivity(boolean
true for logging the network activity logEnabled)Overrides io. Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe maximum chunk size maxChunkSize)Set the maximum HTTP chunk size that |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new maximum size maxSize)Set the maximum size of a form attribute. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new maximum maxFormBufferedBytes)Set the maximum number of bytes a server can buffer when decoding a form. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new maximum maxFormFields)Set the maximum number of fields of a form. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new maximum length maxHeaderSize)Set the maximum length of all headers for HTTP/1.x . |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe new maximum initial length maxInitialLineLength)Set the maximum length of the initial line for HTTP/1.x (e.g. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe maximum frame size in bytes. maxWebSocketFrameSize)Set the maximum WebSocket frames size |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe maximum message size in bytes. maxWebSocketMessageSize)Set the maximum WebSocket message size |
| public HttpServerOptions | setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
Overrides io.
Deprecated
|
| public HttpServerOptions | setPemKeyCertOptions(PemKeyCertOptions
the options in pem format options)Overrides io.
Deprecated
Set the key/cert store options in pem format. |
| public HttpServerOptions | setPemTrustOptions(PemTrustOptions
the trust options in pem format options)Overrides io.
Deprecated
Set the trust options in pem format |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue when the per-frame deflate compression extension is supportedEnable or disable support for the WebSocket per-frame deflate compression extension. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue when the per-message WebSocket compression extension is supportedEnable or disable support for WebSocket per-message deflate compression extension. |
| public HttpServerOptions | setPfxKeyCertOptions(PfxOptions
the key cert options in pfx format options)Overrides io.
Deprecated
Set the key/cert options in pfx format. |
| public HttpServerOptions | setPfxTrustOptions(PfxOptions
the trust options in pfx format options)Overrides io.
Deprecated
Set the trust options in pfx format |
| public HttpServerOptions | |
| public HttpServerOptions | setProxyProtocolTimeout(long
the Proxy protocol timeout to set proxyProtocolTimeout)Overrides io. Set the Proxy protocol timeout, default time unit is seconds. |
| public HttpServerOptions | setProxyProtocolTimeoutUnit(TimeUnit
specify time unit. proxyProtocolTimeoutUnit)Overrides io. Set the Proxy protocol timeout unit. |
| public HttpServerOptions | setReadIdleTimeout(int
the read timeout idleTimeout)Overrides io. Set the read idle timeout, default time unit is seconds. |
| public HttpServerOptions | setReceiveBufferSize(int
the buffers size, in bytes receiveBufferSize)Overrides io. Set the TCP receive buffer size |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue to register write-handlers registerWebSocketWriteHandlers)Whether write-handlers for server websockets should be registered on the |
| public HttpServerOptions | setRegisterWriteHandler(boolean
true to register a write-handler registerWriteHandler)Overrides io. Has no effect on HTTP server options. |
| public HttpServerOptions | setReuseAddress(boolean
the value of reuse address reuseAddress)Overrides io. Set the value of reuse address |
| public HttpServerOptions | setReusePort(boolean
the value of reuse port reusePort)Overrides io. Set the value of reuse port. |
| public HttpServerOptions | setSendBufferSize(int
the buffers size, in bytes sendBufferSize)Overrides io. Set the TCP send buffer size |
| public HttpServerOptions | setSni(boolean sni)
Overrides io. Set whether the server supports Server Name Indiciation |
| public HttpServerOptions | setSoLinger(int
true if SO_linger is enabled soLinger)Overrides io. Set whether SO_linger keep alive is enabled |
| public HttpServerOptions | setSsl(boolean
true if enabled ssl)Overrides io. Set whether SSL/TLS is enabled |
| public HttpServerOptions | setSslEngineOptions(SSLEngineOptions
the ssl engine to use sslEngineOptions)Overrides io. Set to use SSL engine implementation to use. |
| public HttpServerOptions | setSslHandshakeTimeout(long
the SSL handshake timeout to set, in milliseconds sslHandshakeTimeout)Overrides io. Set the SSL handshake timeout, default time unit is seconds. |
| public HttpServerOptions | setSslHandshakeTimeoutUnit(TimeUnit
specify time unit. sslHandshakeTimeoutUnit)Overrides io. Set the SSL handshake timeout unit. |
| public HttpServerOptions | setTcpCork(boolean
the cork value tcpCork)Overrides io. Enable the |
| public HttpServerOptions | setTcpFastOpen(boolean
the fast open value tcpFastOpen)Overrides io. Enable the |
| public HttpServerOptions | setTcpKeepAlive(boolean
true if TCP keep alive is enabled tcpKeepAlive)Overrides io. Set whether TCP keep alive is enabled |
| public HttpServerOptions | setTcpNoDelay(boolean
true if TCP no delay is enabled (Nagle disabled) tcpNoDelay)Overrides io. Set whether TCP no delay is enabled |
| public HttpServerOptions | setTcpQuickAck(boolean
the quick ack value tcpQuickAck)Overrides io. Enable the |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe tracing policy tracingPolicy)Set the tracing policy for the server behavior when Vert.x has tracing enabled. |
| public HttpServerOptions | setTrafficClass(int
the value of traffic class trafficClass)Overrides io. Set the value of traffic class |
| public HttpServerOptions | setTrafficShapingOptions(TrafficShapingOptions
options used by traffic handler trafficShapingOptions)Overrides io. Set traffic shaping options. |
| public HttpServerOptions | setTrustOptions(TrustOptions
the trust options options)Overrides io. Set the trust options. |
| public HttpServerOptions | setTrustStoreOptions(JksOptions
the trust options in jks format options)Overrides io.
Deprecated
Set the trust options in jks format, aka Java truststore |
| public HttpServerOptions | setUseAlpn(boolean
true when Application-Layer Protocol Negotiation should be used useAlpn)Overrides io. Set the ALPN usage. |
| public HttpServerOptions | setUseProxyProtocol(boolean useProxyProtocol)
Overrides io. Set whether the server uses the HA Proxy protocol |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue to accept the server_no_context_takeover parameter when the client offers itSet whether the WebSocket server will accept the |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe timeout is seconds webSocketClosingTimeout)Set the amount of time a server WebSocket will wait until it closes the TCP connection after sending a close frame. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlythe compression level compressionLevel)Set the WebSocket compression level. |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlytrue to accept the client_no_context_takeover parameter when the client offers itSet whether the WebSocket server will accept the |
| public HttpServerOptions | Returns: a reference to this, so the API can be used fluentlycomma separated list of sub-protocols subProtocols)Set the WebSocket list of sub-protocol supported by the server. |
| public HttpServerOptions | setWriteIdleTimeout(int
the write timeout idleTimeout)Overrides io. Set the write idle timeout, default time unit is seconds. |
| public JsonObject | Returns: the JSONOverrides io.
References Deprecated
JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.
Convert to JSON |