@ConfigurationProperties(prefix="vertx.http.client") public class HttpClientProperties extends Object
If any of the ignored properties is required, please use HttpClientOptionsCustomizer.
| Constructor and Description |
|---|
HttpClientProperties() |
| Modifier and Type | Method and Description |
|---|---|
List<io.vertx.core.http.HttpVersion> |
getAlpnVersions() |
int |
getConnectTimeout() |
int |
getDecoderInitialBufferSize() |
String |
getDefaultHost()
Get the default host name to be used by this client in requests if none is provided when making the request.
|
int |
getDefaultPort()
Get the default port to be used by this client in requests if none is provided when making the request.
|
Set<String> |
getEnabledCipherSuites() |
Set<String> |
getEnabledSecureTransportProtocols()
Returns the enabled SSL/TLS protocols
|
long |
getHeaderTableSize() |
int |
getHttp2ConnectionWindowSize() |
Map<Integer,Long> |
getHttp2ExtraSettings() |
int |
getHttp2KeepAliveTimeout() |
int |
getHttp2MaxPoolSize()
Get the maximum pool size for HTTP/2 connections
|
int |
getHttp2MultiplexingLimit() |
io.vertx.core.http.HttpClientOptions |
getHttpClientOptions() |
int |
getIdleTimeout() |
TimeUnit |
getIdleTimeoutUnit() |
int |
getInitialWindowSize() |
int |
getKeepAliveTimeout() |
String |
getLocalAddress() |
boolean |
getLogActivity() |
int |
getMaxChunkSize()
Returns the maximum HTTP chunk size
|
long |
getMaxConcurrentStreams() |
int |
getMaxFrameSize() |
long |
getMaxHeaderListSize() |
int |
getMaxHeaderSize() |
int |
getMaxInitialLineLength() |
int |
getMaxPoolSize()
Get the maximum pool size for connections
|
int |
getMaxRedirects() |
int |
getMaxWaitQueueSize()
Returns the maximum wait queue size
|
int |
getMaxWebsocketFrameSize()
Get the maximum WebSocket frame size to use
|
int |
getMaxWebsocketMessageSize()
Get the maximum WebSocket message size to use
|
String |
getMetricsName() |
int |
getPipeliningLimit() |
int |
getPoolCleanerPeriod() |
io.vertx.core.http.HttpVersion |
getProtocolVersion()
Get the protocol version.
|
int |
getReceiveBufferSize()
Return the TCP receive buffer size, in bytes
|
int |
getSendBufferSize()
Return the TCP send buffer size, in bytes.
|
int |
getSoLinger() |
int |
getTrafficClass() |
int |
getWebsocketCompressionLevel() |
boolean |
isForceSni() |
boolean |
isHttp2ClearTextUpgrade() |
boolean |
isKeepAlive()
Is keep alive enabled on the client?
|
boolean |
isPipelining()
Is pipe-lining enabled on the client
|
boolean |
isPushEnabled() |
boolean |
isReuseAddress() |
boolean |
isReusePort() |
boolean |
isSendUnmaskedFrames() |
boolean |
isSsl() |
boolean |
isTcpCork() |
boolean |
isTcpFastOpen() |
boolean |
isTcpKeepAlive() |
boolean |
isTcpNoDelay() |
boolean |
isTcpQuickAck() |
boolean |
isTrustAll() |
boolean |
isTryUseCompression()
Is compression enabled on the client?
|
boolean |
isTryUsePerMessageWebsocketCompression() |
boolean |
isTryWebsocketDeflateFrameCompression() |
boolean |
isUseAlpn() |
boolean |
isVerifyHost()
Is hostname verification (for SSL/TLS) enabled?
|
boolean |
isWebsocketCompressionAllowClientNoContext() |
boolean |
isWebsocketCompressionRequestServerNoContext() |
void |
setAlpnVersions(List<io.vertx.core.http.HttpVersion> alpnVersions) |
void |
setConnectTimeout(int connectTimeout) |
void |
setDecoderInitialBufferSize(int decoderInitialBufferSize) |
void |
setDefaultHost(String defaultHost) |
void |
setDefaultPort(int defaultPort) |
void |
setEnabledCipherSuites(Set<String> enabledCipherSuites) |
void |
setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols) |
void |
setForceSni(boolean forceSni) |
void |
setHeaderTableSize(long headerTableSize) |
void |
setHttp2ClearTextUpgrade(boolean value) |
void |
setHttp2ConnectionWindowSize(int http2ConnectionWindowSize) |
void |
setHttp2ExtraSettings(Map<Integer,Long> http2ExtraSettings) |
void |
setHttp2KeepAliveTimeout(int keepAliveTimeout) |
void |
setHttp2MaxPoolSize(int max) |
void |
setHttp2MultiplexingLimit(int limit) |
void |
setIdleTimeout(int idleTimeout) |
void |
setIdleTimeoutUnit(TimeUnit idleTimeoutUnit) |
void |
setInitialWindowSize(int initialWindowSize) |
void |
setKeepAlive(boolean keepAlive) |
void |
setKeepAliveTimeout(int keepAliveTimeout) |
void |
setLocalAddress(String localAddress) |
void |
setLogActivity(boolean logEnabled) |
void |
setMaxChunkSize(int maxChunkSize) |
void |
setMaxConcurrentStreams(long maxConcurrentStreams) |
void |
setMaxFrameSize(int maxFrameSize) |
void |
setMaxHeaderListSize(long maxHeaderListSize) |
void |
setMaxHeaderSize(int maxHeaderSize) |
void |
setMaxInitialLineLength(int maxInitialLineLength) |
void |
setMaxPoolSize(int maxPoolSize) |
void |
setMaxRedirects(int maxRedirects) |
void |
setMaxWaitQueueSize(int maxWaitQueueSize) |
void |
setMaxWebsocketFrameSize(int maxWebsocketFrameSize) |
void |
setMaxWebsocketMessageSize(int maxWebsocketMessageSize) |
void |
setMetricsName(String metricsName) |
void |
setPipelining(boolean pipelining) |
void |
setPipeliningLimit(int limit) |
void |
setPoolCleanerPeriod(int poolCleanerPeriod) |
void |
setProtocolVersion(io.vertx.core.http.HttpVersion protocolVersion) |
void |
setPushEnabled(boolean pushEnabled) |
void |
setReceiveBufferSize(int receiveBufferSize) |
void |
setReuseAddress(boolean reuseAddress) |
void |
setReusePort(boolean reusePort) |
void |
setSendBufferSize(int sendBufferSize) |
void |
setSendUnmaskedFrames(boolean sendUnmaskedFrames) |
void |
setSoLinger(int soLinger) |
void |
setSsl(boolean ssl) |
void |
setTcpCork(boolean tcpCork) |
void |
setTcpFastOpen(boolean tcpFastOpen) |
void |
setTcpKeepAlive(boolean tcpKeepAlive) |
void |
setTcpNoDelay(boolean tcpNoDelay) |
void |
setTcpQuickAck(boolean tcpQuickAck) |
void |
setTrafficClass(int trafficClass) |
void |
setTrustAll(boolean trustAll) |
void |
setTryUseCompression(boolean tryUseCompression) |
void |
setTryUsePerFrameWebsocketCompression(boolean tryWebsocketDeflateFrameCompression) |
void |
setTryUsePerMessageWebsocketCompression(boolean tryUsePerMessageWebsocketCompression) |
void |
setUseAlpn(boolean useAlpn) |
void |
setVerifyHost(boolean verifyHost) |
void |
setWebsocketCompressionAllowClientNoContext(boolean websocketCompressionAllowClientNoContext) |
void |
setWebsocketCompressionLevel(int websocketCompressionLevel) |
void |
setWebsocketCompressionRequestServerNoContext(boolean websocketCompressionRequestServerNoContext) |
public io.vertx.core.http.HttpClientOptions getHttpClientOptions()
public int getSendBufferSize()
NetworkOptions.getSendBufferSize()public void setSendBufferSize(int sendBufferSize)
public int getReceiveBufferSize()
NetworkOptions.getReceiveBufferSize()public void setReceiveBufferSize(int receiveBufferSize)
public boolean isReuseAddress()
NetworkOptions.isReuseAddress()public void setReuseAddress(boolean reuseAddress)
public boolean isReusePort()
NetworkOptions.isReusePort()public void setReusePort(boolean reusePort)
public int getTrafficClass()
NetworkOptions.getTrafficClass()public void setTrafficClass(int trafficClass)
public boolean getLogActivity()
NetworkOptions.getLogActivity()public void setLogActivity(boolean logEnabled)
public boolean isTcpNoDelay()
TCPSSLOptions.isTcpNoDelay()public void setTcpNoDelay(boolean tcpNoDelay)
public boolean isTcpKeepAlive()
TCPSSLOptions.isTcpKeepAlive()public void setTcpKeepAlive(boolean tcpKeepAlive)
public int getSoLinger()
TCPSSLOptions.getSoLinger()public void setSoLinger(int soLinger)
public int getIdleTimeout()
getIdleTimeoutUnit().TCPSSLOptions.getIdleTimeout()public void setIdleTimeout(int idleTimeout)
public TimeUnit getIdleTimeoutUnit()
TCPSSLOptions.getIdleTimeoutUnit()public void setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
public boolean isSsl()
TCPSSLOptions.isSsl()public void setSsl(boolean ssl)
public Set<String> getEnabledCipherSuites()
TCPSSLOptions.getEnabledCipherSuites()public boolean isUseAlpn()
TCPSSLOptions.isUseAlpn()public void setUseAlpn(boolean useAlpn)
public Set<String> getEnabledSecureTransportProtocols()
TCPSSLOptions.getEnabledSecureTransportProtocols()public void setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
public boolean isTcpFastOpen()
TCP_FASTOPEN option is enabledTCPSSLOptions.isTcpFastOpen()public void setTcpFastOpen(boolean tcpFastOpen)
public boolean isTcpCork()
TCP_CORK option is enabledTCPSSLOptions.isTcpCork()public void setTcpCork(boolean tcpCork)
public boolean isTcpQuickAck()
TCP_QUICKACK option is enabledTCPSSLOptions.isTcpQuickAck()public void setTcpQuickAck(boolean tcpQuickAck)
public int getConnectTimeout()
ClientOptionsBase.getConnectTimeout()public void setConnectTimeout(int connectTimeout)
public boolean isTrustAll()
ClientOptionsBase.isTrustAll()public void setTrustAll(boolean trustAll)
public String getMetricsName()
ClientOptionsBase.getMetricsName()public void setMetricsName(String metricsName)
public String getLocalAddress()
ClientOptionsBase.getLocalAddress()public void setLocalAddress(String localAddress)
public boolean isVerifyHost()
true if enabledHttpClientOptions.isVerifyHost()public void setVerifyHost(boolean verifyHost)
public int getMaxPoolSize()
HttpClientOptions.getMaxPoolSize()public void setMaxPoolSize(int maxPoolSize)
public boolean isKeepAlive()
true if enabledHttpClientOptions.isKeepAlive()public void setKeepAlive(boolean keepAlive)
public int getKeepAliveTimeout()
HttpClientOptions.getKeepAliveTimeout()public void setKeepAliveTimeout(int keepAliveTimeout)
public int getPipeliningLimit()
HttpClientOptions.getPipeliningLimit()public void setPipeliningLimit(int limit)
public boolean isPipelining()
true if pipe-lining is enabledHttpClientOptions.isPipelining()public void setPipelining(boolean pipelining)
public int getHttp2MaxPoolSize()
HttpClientOptions.getHttp2MaxPoolSize()public void setHttp2MaxPoolSize(int max)
public int getHttp2MultiplexingLimit()
-1 means
the value sent by the serverHttpClientOptions.getHttp2MultiplexingLimit()public void setHttp2MultiplexingLimit(int limit)
public int getHttp2ConnectionWindowSize()
HttpClientOptions.getHttp2ConnectionWindowSize()public void setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
public int getHttp2KeepAliveTimeout()
HttpClientOptions.getHttp2KeepAliveTimeout()public void setHttp2KeepAliveTimeout(int keepAliveTimeout)
public int getPoolCleanerPeriod()
HttpClientOptions.getPoolCleanerPeriod()public void setPoolCleanerPeriod(int poolCleanerPeriod)
public boolean isTryUseCompression()
true if enabledHttpClientOptions.isTryUseCompression()public void setTryUseCompression(boolean tryUseCompression)
public int getMaxWebsocketFrameSize()
HttpClientOptions.getMaxWebsocketFrameSize()public void setMaxWebsocketFrameSize(int maxWebsocketFrameSize)
public int getMaxWebsocketMessageSize()
HttpClientOptions.getMaxWebsocketMessageSize()public void setMaxWebsocketMessageSize(int maxWebsocketMessageSize)
public String getDefaultHost()
HttpClientOptions.getDefaultHost()public void setDefaultHost(String defaultHost)
public int getDefaultPort()
HttpClientOptions.getDefaultPort()public void setDefaultPort(int defaultPort)
public io.vertx.core.http.HttpVersion getProtocolVersion()
HttpClientOptions.getProtocolVersion()public void setProtocolVersion(io.vertx.core.http.HttpVersion protocolVersion)
public int getMaxChunkSize()
HttpClientOptions.getMaxChunkSize()public void setMaxChunkSize(int maxChunkSize)
public int getMaxInitialLineLength()
"GET / HTTP/1.0")HttpClientOptions.getMaxInitialLineLength()public void setMaxInitialLineLength(int maxInitialLineLength)
public int getMaxHeaderSize()
HttpClientOptions.getMaxHeaderSize()public void setMaxHeaderSize(int maxHeaderSize)
public int getMaxWaitQueueSize()
HttpClientOptions.getMaxWaitQueueSize()public void setMaxWaitQueueSize(int maxWaitQueueSize)
public long getHeaderTableSize()
Http2Settings.getHeaderTableSize()public void setHeaderTableSize(long headerTableSize)
public boolean isPushEnabled()
Http2Settings.isPushEnabled()public void setPushEnabled(boolean pushEnabled)
public long getMaxConcurrentStreams()
Http2Settings.getMaxConcurrentStreams()public void setMaxConcurrentStreams(long maxConcurrentStreams)
public int getInitialWindowSize()
Http2Settings.getInitialWindowSize()public void setInitialWindowSize(int initialWindowSize)
public int getMaxFrameSize()
Http2Settings.getMaxFrameSize()public void setMaxFrameSize(int maxFrameSize)
public long getMaxHeaderListSize()
Http2Settings.getMaxHeaderListSize()public void setMaxHeaderListSize(long maxHeaderListSize)
public Map<Integer,Long> getHttp2ExtraSettings()
Http2Settings.getExtraSettings()public List<io.vertx.core.http.HttpVersion> getAlpnVersions()
setProtocolVersion(io.vertx.core.http.HttpVersion)HttpClientOptions.getAlpnVersions()public void setAlpnVersions(List<io.vertx.core.http.HttpVersion> alpnVersions)
public boolean isHttp2ClearTextUpgrade()
true when an h2c connection is established using an HTTP/1.1 upgrade request, false when directlyHttpClientOptions.isHttp2ClearTextUpgrade()public void setHttp2ClearTextUpgrade(boolean value)
public boolean isSendUnmaskedFrames()
true when frame masking is skippedHttpClientOptions.isSendUnmaskedFrames()public void setSendUnmaskedFrames(boolean sendUnmaskedFrames)
public int getMaxRedirects()
HttpClientOptions.getMaxRedirects()public void setMaxRedirects(int maxRedirects)
public boolean isForceSni()
HttpClientOptions.isForceSni()public void setForceSni(boolean forceSni)
public int getDecoderInitialBufferSize()
HttpClientOptions.getDecoderInitialBufferSize()public void setDecoderInitialBufferSize(int decoderInitialBufferSize)
public boolean isTryWebsocketDeflateFrameCompression()
true when the WebSocket per-frame deflate compression extension will be offeredHttpClientOptions.getTryWebsocketDeflateFrameCompression()public void setTryUsePerFrameWebsocketCompression(boolean tryWebsocketDeflateFrameCompression)
public boolean isTryUsePerMessageWebsocketCompression()
true when the WebSocket per-message deflate compression extension will be offeredHttpClientOptions.getTryUsePerMessageWebsocketCompression()public void setTryUsePerMessageWebsocketCompression(boolean tryUsePerMessageWebsocketCompression)
public int getWebsocketCompressionLevel()
HttpClientOptions.getWebsocketCompressionLevel()public void setWebsocketCompressionLevel(int websocketCompressionLevel)
public boolean isWebsocketCompressionAllowClientNoContext()
true when the client_no_context_takeover parameter for the WebSocket per-message
deflate compression extension will be offeredHttpClientOptions.getWebsocketCompressionAllowClientNoContext()public void setWebsocketCompressionAllowClientNoContext(boolean websocketCompressionAllowClientNoContext)
public boolean isWebsocketCompressionRequestServerNoContext()
true when the server_no_context_takeover parameter for the Websocket per-message
deflate compression extension will be offeredHttpClientOptions.getWebsocketCompressionRequestServerNoContext()public void setWebsocketCompressionRequestServerNoContext(boolean websocketCompressionRequestServerNoContext)
Copyright © 2020. All rights reserved.