public class HttpSenderOptions extends HttpClientOptions
http://localhost:9411/api/v2/spans
.Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_SENDER_ENDPOINT |
DEFAULT_ALPN_VERSIONS, DEFAULT_DECODER_INITIAL_BUFFER_SIZE, DEFAULT_DEFAULT_HOST, DEFAULT_DEFAULT_PORT, DEFAULT_FORCE_SNI, DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE, DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE, DEFAULT_HTTP2_KEEP_ALIVE_TIMEOUT, DEFAULT_HTTP2_MAX_POOL_SIZE, DEFAULT_HTTP2_MULTIPLEXING_LIMIT, DEFAULT_KEEP_ALIVE, DEFAULT_KEEP_ALIVE_TIMEOUT, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_MAX_POOL_SIZE, DEFAULT_MAX_REDIRECTS, DEFAULT_MAX_WAIT_QUEUE_SIZE, DEFAULT_MAX_WEBSOCKET_FRAME_SIZE, DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE, DEFAULT_MAX_WEBSOCKETS, DEFAULT_PIPELINING, DEFAULT_PIPELINING_LIMIT, DEFAULT_POOL_CLEANER_PERIOD, DEFAULT_PROTOCOL_VERSION, DEFAULT_SEND_UNMASKED_FRAMES, DEFAULT_TRACING_POLICY, DEFAULT_TRY_USE_COMPRESSION, DEFAULT_TRY_USE_PER_FRAME_WEBSOCKET_COMPRESSION, DEFAULT_TRY_USE_PER_MESSAGE_WEBSOCKET_COMPRESSION, DEFAULT_VERIFY_HOST, DEFAULT_WEBSOCKET_ALLOW_CLIENT_NO_CONTEXT, DEFAULT_WEBSOCKET_CLOSING_TIMEOUT, DEFAULT_WEBSOCKET_COMPRESSION_LEVEL, DEFAULT_WEBSOCKET_REQUEST_SERVER_NO_CONTEXT
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL
DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_SSL_HANDSHAKE_TIMEOUT, DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_USE_ALPN
DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS
Constructor and Description |
---|
HttpSenderOptions() |
HttpSenderOptions(HttpSenderOptions other) |
HttpSenderOptions(JsonObject json) |
Modifier and Type | Method and Description |
---|---|
HttpSenderOptions |
addCrlPath(String crlPath)
Add a CRL path
|
HttpSenderOptions |
addCrlValue(Buffer crlValue)
Add a CRL value
|
HttpSenderOptions |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite, appended to the ordered suites.
|
HttpSenderOptions |
addEnabledSecureTransportProtocol(String protocol)
Add an enabled SSL/TLS protocols, appended to the ordered protocols.
|
String |
getSenderEndpoint() |
HttpSenderOptions |
removeEnabledSecureTransportProtocol(String protocol)
Removes an enabled SSL/TLS protocol from the ordered protocols.
|
HttpSenderOptions |
setAlpnVersions(List<HttpVersion> alpnVersions)
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
|
HttpSenderOptions |
setConnectTimeout(int connectTimeout)
Set the connect timeout
|
HttpSenderOptions |
setDecoderInitialBufferSize(int decoderInitialBufferSize)
set to
initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder. |
HttpSenderOptions |
setDefaultHost(String defaultHost)
Set the default host name to be used by this client in requests if none is provided when making the request.
|
HttpSenderOptions |
setDefaultPort(int defaultPort)
Set the default port to be used by this client in requests if none is provided when making the request.
|
HttpSenderOptions |
setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
Sets the list of enabled SSL/TLS protocols.
|
HttpSenderOptions |
setForceSni(boolean forceSni)
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to
true forces the server name to be always sent. |
HttpSenderOptions |
setHttp2ClearTextUpgrade(boolean value)
Set to
true when an h2c connection is established using an HTTP/1.1 upgrade request, and false
when an h2c connection is established directly (with prior knowledge). |
HttpSenderOptions |
setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
Set the default HTTP/2 connection window size.
|
HttpSenderOptions |
setHttp2KeepAliveTimeout(int keepAliveTimeout)
Set the keep alive timeout for HTTP/2 connections, in seconds.
|
HttpSenderOptions |
setHttp2MaxPoolSize(int max)
Set the maximum pool size for HTTP/2 connections
|
HttpSenderOptions |
setHttp2MultiplexingLimit(int limit)
Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number
of streams the client can create for a connection.
|
HttpSenderOptions |
setIdleTimeout(int idleTimeout)
Set the idle timeout, default time unit is seconds.
|
HttpSenderOptions |
setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Set the idle timeout unit.
|
HttpSenderOptions |
setInitialSettings(Http2Settings settings)
Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
|
HttpSenderOptions |
setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions) |
HttpSenderOptions |
setKeepAlive(boolean keepAlive)
Set whether keep alive is enabled on the client
|
HttpSenderOptions |
setKeepAliveTimeout(int keepAliveTimeout)
Set the keep alive timeout for HTTP/1.x, in seconds.
|
HttpSenderOptions |
setKeyCertOptions(KeyCertOptions options)
Set the key/cert options.
|
HttpSenderOptions |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
HttpSenderOptions |
setLocalAddress(String localAddress)
Set the local interface to bind for network connections.
|
HttpSenderOptions |
setLogActivity(boolean logEnabled)
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
|
HttpSenderOptions |
setMaxChunkSize(int maxChunkSize)
Set the maximum HTTP chunk size
|
HttpSenderOptions |
setMaxHeaderSize(int maxHeaderSize)
Set the maximum length of all headers for HTTP/1.x .
|
HttpSenderOptions |
setMaxInitialLineLength(int maxInitialLineLength)
Set the maximum length of the initial line for HTTP/1.x (e.g.
|
HttpSenderOptions |
setMaxPoolSize(int maxPoolSize)
Set the maximum pool size for connections
|
HttpSenderOptions |
setMaxRedirects(int maxRedirects)
Set to
maxRedirects the maximum number of redirection a request can follow. |
HttpSenderOptions |
setMaxWaitQueueSize(int maxWaitQueueSize)
Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in
a ConnectionPoolTooBusyException.
|
HttpSenderOptions |
setMaxWebSocketFrameSize(int maxWebsocketFrameSize)
Set the max WebSocket frame size
|
HttpSenderOptions |
setMaxWebSocketMessageSize(int maxWebsocketMessageSize)
Set the max WebSocket message size
|
HttpSenderOptions |
setMetricsName(String metricsName)
Set the metrics name identifying the reported metrics, useful for grouping metrics
with the same name.
|
HttpSenderOptions |
setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions) |
HttpSenderOptions |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
HttpSenderOptions |
setPemTrustOptions(PemTrustOptions options)
Set the trust options in pem format
|
HttpSenderOptions |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
HttpSenderOptions |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
HttpSenderOptions |
setPipelining(boolean pipelining)
Set whether pipe-lining is enabled on the client
|
HttpSenderOptions |
setPipeliningLimit(int limit)
Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
|
HttpSenderOptions |
setPoolCleanerPeriod(int poolCleanerPeriod)
Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections
will remain in the pool until they are closed.
|
HttpSenderOptions |
setProtocolVersion(HttpVersion protocolVersion)
Set the protocol version.
|
HttpSenderOptions |
setProxyOptions(ProxyOptions proxyOptions)
Set proxy options for connections via CONNECT proxy (e.g.
|
HttpSenderOptions |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
HttpSenderOptions |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
HttpSenderOptions |
setReusePort(boolean reusePort)
Set the value of reuse port.
|
HttpSenderOptions |
setSendBufferSize(int sendBufferSize)
Set the TCP send buffer size
|
HttpSenderOptions |
setSenderEndpoint(String endpoint) |
HttpSenderOptions |
setSendUnmaskedFrames(boolean sendUnmaskedFrames)
Set
true when the client wants to skip frame masking. |
HttpSenderOptions |
setSoLinger(int soLinger)
Set whether SO_linger keep alive is enabled
|
HttpSenderOptions |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
HttpSenderOptions |
setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Set to use SSL engine implementation to use.
|
HttpSenderOptions |
setTcpCork(boolean tcpCork)
Enable the
TCP_CORK option - only with linux native transport. |
HttpSenderOptions |
setTcpFastOpen(boolean tcpFastOpen)
Enable the
TCP_FASTOPEN option - only with linux native transport. |
HttpSenderOptions |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
HttpSenderOptions |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
HttpSenderOptions |
setTcpQuickAck(boolean tcpQuickAck)
Enable the
TCP_QUICKACK option - only with linux native transport. |
HttpSenderOptions |
setTrafficClass(int trafficClass)
Set the value of traffic class
|
HttpSenderOptions |
setTrustAll(boolean trustAll)
Set whether all server certificates should be trusted
|
HttpSenderOptions |
setTrustOptions(TrustOptions options)
Set the trust options.
|
HttpSenderOptions |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java truststore
|
HttpSenderOptions |
setTryUseCompression(boolean tryUseCompression)
Set whether compression is enabled
|
HttpSenderOptions |
setTryUsePerFrameWebSocketCompression(boolean offer)
Set whether the client will offer the WebSocket per-frame deflate compression extension.
|
HttpSenderOptions |
setTryUsePerMessageWebSocketCompression(boolean offer)
Set whether the client will offer the WebSocket per-message deflate compression extension.
|
HttpSenderOptions |
setUseAlpn(boolean useAlpn)
Set the ALPN usage.
|
HttpSenderOptions |
setVerifyHost(boolean verifyHost)
Set whether hostname verification is enabled
|
HttpSenderOptions |
setWebSocketCompressionAllowClientNoContext(boolean offer)
Set whether the
client_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered. |
HttpSenderOptions |
setWebSocketCompressionLevel(int compressionLevel)
Set the WebSocket deflate compression level.
|
HttpSenderOptions |
setWebSocketCompressionRequestServerNoContext(boolean offer)
Set whether the
server_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered. |
addNonProxyHost, getAlpnVersions, getDecoderInitialBufferSize, getDefaultHost, getDefaultPort, getHttp2ConnectionWindowSize, getHttp2KeepAliveTimeout, getHttp2MaxPoolSize, getHttp2MultiplexingLimit, getInitialSettings, getKeepAliveTimeout, getMaxChunkSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxPoolSize, getMaxRedirects, getMaxWaitQueueSize, getMaxWebSocketFrameSize, getMaxWebSocketMessageSize, getMaxWebSockets, getPipeliningLimit, getPoolCleanerPeriod, getProtocolVersion, getTracingPolicy, getTryUsePerMessageWebSocketCompression, getTryWebSocketDeflateFrameCompression, getWebSocketClosingTimeout, getWebSocketCompressionAllowClientNoContext, getWebSocketCompressionLevel, getWebSocketCompressionRequestServerNoContext, isForceSni, isHttp2ClearTextUpgrade, isKeepAlive, isPipelining, isSendUnmaskedFrames, isTryUseCompression, isVerifyHost, setMaxWebSockets, setNonProxyHosts, setSslHandshakeTimeout, setSslHandshakeTimeoutUnit, setTracingPolicy, setWebSocketClosingTimeout, toJson
getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getProxyOptions, isTrustAll
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn
getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort
public static final String DEFAULT_SENDER_ENDPOINT
public HttpSenderOptions()
public HttpSenderOptions(HttpSenderOptions other)
public HttpSenderOptions(JsonObject json)
public String getSenderEndpoint()
public HttpSenderOptions setSenderEndpoint(String endpoint)
public HttpSenderOptions setSendBufferSize(int sendBufferSize)
NetworkOptions
setSendBufferSize
in class HttpClientOptions
sendBufferSize
- the buffers size, in bytespublic HttpSenderOptions setReceiveBufferSize(int receiveBufferSize)
NetworkOptions
setReceiveBufferSize
in class HttpClientOptions
receiveBufferSize
- the buffers size, in bytespublic HttpSenderOptions setReuseAddress(boolean reuseAddress)
NetworkOptions
setReuseAddress
in class HttpClientOptions
reuseAddress
- the value of reuse addresspublic HttpSenderOptions setReusePort(boolean reusePort)
NetworkOptions
setReusePort
in class HttpClientOptions
reusePort
- the value of reuse portpublic HttpSenderOptions setTrafficClass(int trafficClass)
NetworkOptions
setTrafficClass
in class HttpClientOptions
trafficClass
- the value of traffic classpublic HttpSenderOptions setTcpNoDelay(boolean tcpNoDelay)
TCPSSLOptions
setTcpNoDelay
in class HttpClientOptions
tcpNoDelay
- true if TCP no delay is enabled (Nagle disabled)public HttpSenderOptions setTcpKeepAlive(boolean tcpKeepAlive)
TCPSSLOptions
setTcpKeepAlive
in class HttpClientOptions
tcpKeepAlive
- true if TCP keep alive is enabledpublic HttpSenderOptions setSoLinger(int soLinger)
TCPSSLOptions
setSoLinger
in class HttpClientOptions
soLinger
- true if SO_linger is enabledpublic HttpSenderOptions setIdleTimeout(int idleTimeout)
TCPSSLOptions
TCPSSLOptions.setIdleTimeoutUnit(TimeUnit)
setIdleTimeout
in class HttpClientOptions
idleTimeout
- the timeout, in secondspublic HttpSenderOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
TCPSSLOptions
setIdleTimeoutUnit
in class HttpClientOptions
idleTimeoutUnit
- specify time unit.public HttpSenderOptions setSsl(boolean ssl)
TCPSSLOptions
setSsl
in class HttpClientOptions
ssl
- true if enabledpublic HttpSenderOptions setKeyCertOptions(KeyCertOptions options)
TCPSSLOptions
setKeyCertOptions
in class HttpClientOptions
options
- the key store optionspublic HttpSenderOptions setKeyStoreOptions(JksOptions options)
TCPSSLOptions
setKeyStoreOptions
in class HttpClientOptions
options
- the key store in jks formatpublic HttpSenderOptions setPfxKeyCertOptions(PfxOptions options)
TCPSSLOptions
setPfxKeyCertOptions
in class HttpClientOptions
options
- the key cert options in pfx formatpublic HttpSenderOptions setTrustOptions(TrustOptions options)
TCPSSLOptions
setTrustOptions
in class HttpClientOptions
options
- the trust optionspublic HttpSenderOptions setPemKeyCertOptions(PemKeyCertOptions options)
TCPSSLOptions
setPemKeyCertOptions
in class HttpClientOptions
options
- the options in pem formatpublic HttpSenderOptions setTrustStoreOptions(JksOptions options)
TCPSSLOptions
setTrustStoreOptions
in class HttpClientOptions
options
- the trust options in jks formatpublic HttpSenderOptions setPfxTrustOptions(PfxOptions options)
TCPSSLOptions
setPfxTrustOptions
in class HttpClientOptions
options
- the trust options in pfx formatpublic HttpSenderOptions setPemTrustOptions(PemTrustOptions options)
TCPSSLOptions
setPemTrustOptions
in class HttpClientOptions
options
- the trust options in pem formatpublic HttpSenderOptions addEnabledCipherSuite(String suite)
TCPSSLOptions
addEnabledCipherSuite
in class HttpClientOptions
suite
- the suiteTCPSSLOptions.getEnabledCipherSuites()
public HttpSenderOptions addEnabledSecureTransportProtocol(String protocol)
TCPSSLOptions
addEnabledSecureTransportProtocol
in class HttpClientOptions
protocol
- the SSL/TLS protocol to enablepublic HttpSenderOptions removeEnabledSecureTransportProtocol(String protocol)
TCPSSLOptions
removeEnabledSecureTransportProtocol
in class HttpClientOptions
protocol
- the SSL/TLS protocol to disablepublic HttpSenderOptions setTcpFastOpen(boolean tcpFastOpen)
TCPSSLOptions
TCP_FASTOPEN
option - only with linux native transport.setTcpFastOpen
in class HttpClientOptions
tcpFastOpen
- the fast open valuepublic HttpSenderOptions setTcpCork(boolean tcpCork)
TCPSSLOptions
TCP_CORK
option - only with linux native transport.setTcpCork
in class HttpClientOptions
tcpCork
- the cork valuepublic HttpSenderOptions setTcpQuickAck(boolean tcpQuickAck)
TCPSSLOptions
TCP_QUICKACK
option - only with linux native transport.setTcpQuickAck
in class HttpClientOptions
tcpQuickAck
- the quick ack valuepublic HttpSenderOptions addCrlPath(String crlPath) throws NullPointerException
TCPSSLOptions
addCrlPath
in class HttpClientOptions
crlPath
- the pathNullPointerException
public HttpSenderOptions addCrlValue(Buffer crlValue) throws NullPointerException
TCPSSLOptions
addCrlValue
in class HttpClientOptions
crlValue
- the valueNullPointerException
public HttpSenderOptions setConnectTimeout(int connectTimeout)
ClientOptionsBase
setConnectTimeout
in class HttpClientOptions
connectTimeout
- connect timeout, in mspublic HttpSenderOptions setTrustAll(boolean trustAll)
ClientOptionsBase
setTrustAll
in class HttpClientOptions
trustAll
- true if all should be trustedpublic HttpSenderOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
TCPSSLOptions
setEnabledSecureTransportProtocols
in class HttpClientOptions
enabledSecureTransportProtocols
- the SSL/TLS protocols to enablepublic HttpSenderOptions setMaxPoolSize(int maxPoolSize)
HttpClientOptions
setMaxPoolSize
in class HttpClientOptions
maxPoolSize
- the maximum pool sizepublic HttpSenderOptions setHttp2MultiplexingLimit(int limit)
HttpClientOptions
-1
means to use the value sent by the server's initial settings.
-1
is the default value.setHttp2MultiplexingLimit
in class HttpClientOptions
limit
- the maximum concurrent for an HTTP/2 connectionpublic HttpSenderOptions setHttp2MaxPoolSize(int max)
HttpClientOptions
setHttp2MaxPoolSize
in class HttpClientOptions
max
- the maximum pool sizepublic HttpSenderOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
HttpClientOptions
Http2Settings.getInitialWindowSize()
, so the connection window size
is greater than for its streams, in order the data throughput.
A value of -1
reuses the initial window size setting.setHttp2ConnectionWindowSize
in class HttpClientOptions
http2ConnectionWindowSize
- the window size applied to the connectionpublic HttpSenderOptions setHttp2KeepAliveTimeout(int keepAliveTimeout)
HttpClientOptions
0
means there is no timeout.setHttp2KeepAliveTimeout
in class HttpClientOptions
keepAliveTimeout
- the timeout, in secondspublic HttpSenderOptions setKeepAlive(boolean keepAlive)
HttpClientOptions
setKeepAlive
in class HttpClientOptions
keepAlive
- true
if enabledpublic HttpSenderOptions setKeepAliveTimeout(int keepAliveTimeout)
HttpClientOptions
0
means there is no timeout.setKeepAliveTimeout
in class HttpClientOptions
keepAliveTimeout
- the timeout, in secondspublic HttpSenderOptions setPipelining(boolean pipelining)
HttpClientOptions
setPipelining
in class HttpClientOptions
pipelining
- true
if enabledpublic HttpSenderOptions setPipeliningLimit(int limit)
HttpClientOptions
setPipeliningLimit
in class HttpClientOptions
limit
- the limit of pending requestspublic HttpSenderOptions setVerifyHost(boolean verifyHost)
HttpClientOptions
setVerifyHost
in class HttpClientOptions
verifyHost
- true
if enabledpublic HttpSenderOptions setTryUseCompression(boolean tryUseCompression)
HttpClientOptions
setTryUseCompression
in class HttpClientOptions
tryUseCompression
- true
if enabledpublic HttpSenderOptions setSendUnmaskedFrames(boolean sendUnmaskedFrames)
HttpClientOptions
true
when the client wants to skip frame masking.
You may want to set it true
on server by server WebSocket communication: in this case you are by passing
RFC6455 protocol.
It's false
as default.
setSendUnmaskedFrames
in class HttpClientOptions
sendUnmaskedFrames
- true if enabledpublic HttpSenderOptions setMaxWebSocketFrameSize(int maxWebsocketFrameSize)
HttpClientOptions
setMaxWebSocketFrameSize
in class HttpClientOptions
maxWebsocketFrameSize
- the max frame size, in bytespublic HttpSenderOptions setMaxWebSocketMessageSize(int maxWebsocketMessageSize)
HttpClientOptions
setMaxWebSocketMessageSize
in class HttpClientOptions
maxWebsocketMessageSize
- the max message size, in bytespublic HttpSenderOptions setDefaultHost(String defaultHost)
HttpClientOptions
setDefaultHost
in class HttpClientOptions
public HttpSenderOptions setDefaultPort(int defaultPort)
HttpClientOptions
setDefaultPort
in class HttpClientOptions
public HttpSenderOptions setProtocolVersion(HttpVersion protocolVersion)
HttpClientOptions
setProtocolVersion
in class HttpClientOptions
protocolVersion
- the protocol versionpublic HttpSenderOptions setMaxChunkSize(int maxChunkSize)
HttpClientOptions
setMaxChunkSize
in class HttpClientOptions
maxChunkSize
- the maximum chunk sizepublic HttpSenderOptions setMaxInitialLineLength(int maxInitialLineLength)
HttpClientOptions
"HTTP/1.1 200 OK"
)setMaxInitialLineLength
in class HttpClientOptions
maxInitialLineLength
- the new maximum initial lengthpublic HttpSenderOptions setMaxHeaderSize(int maxHeaderSize)
HttpClientOptions
setMaxHeaderSize
in class HttpClientOptions
maxHeaderSize
- the new maximum lengthpublic HttpSenderOptions setMaxWaitQueueSize(int maxWaitQueueSize)
HttpClientOptions
setMaxWaitQueueSize
in class HttpClientOptions
maxWaitQueueSize
- the maximum number of waiting requestspublic HttpSenderOptions setInitialSettings(Http2Settings settings)
HttpClientOptions
setInitialSettings
in class HttpClientOptions
settings
- the settings valuepublic HttpSenderOptions setUseAlpn(boolean useAlpn)
TCPSSLOptions
setUseAlpn
in class HttpClientOptions
useAlpn
- true when Application-Layer Protocol Negotiation should be usedpublic HttpSenderOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
TCPSSLOptions
setSslEngineOptions
in class HttpClientOptions
sslEngineOptions
- the ssl engine to usepublic HttpSenderOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions
in class HttpClientOptions
public HttpSenderOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions
in class HttpClientOptions
public HttpSenderOptions setAlpnVersions(List<HttpVersion> alpnVersions)
HttpClientOptions
HttpClientOptions.setProtocolVersion(io.vertx.core.http.HttpVersion)
:
HttpVersion.HTTP_2
: [ "h2", "http/1.1" ]HttpClientOptions.getProtocolVersion()
]setAlpnVersions
in class HttpClientOptions
alpnVersions
- the versionspublic HttpSenderOptions setHttp2ClearTextUpgrade(boolean value)
HttpClientOptions
true
when an h2c connection is established using an HTTP/1.1 upgrade request, and false
when an h2c connection is established directly (with prior knowledge).setHttp2ClearTextUpgrade
in class HttpClientOptions
value
- the upgrade valuepublic HttpSenderOptions setMaxRedirects(int maxRedirects)
HttpClientOptions
maxRedirects
the maximum number of redirection a request can follow.setMaxRedirects
in class HttpClientOptions
maxRedirects
- the maximum number of redirectionpublic HttpSenderOptions setForceSni(boolean forceSni)
HttpClientOptions
true
forces the server name to be always sent.setForceSni
in class HttpClientOptions
forceSni
- true
when the client should always use SNI on TLS/SSL connectionspublic HttpSenderOptions setMetricsName(String metricsName)
ClientOptionsBase
setMetricsName
in class HttpClientOptions
metricsName
- the metrics namepublic HttpSenderOptions setProxyOptions(ProxyOptions proxyOptions)
ClientOptionsBase
setProxyOptions
in class HttpClientOptions
proxyOptions
- proxy options objectpublic HttpSenderOptions setLocalAddress(String localAddress)
ClientOptionsBase
setLocalAddress
in class HttpClientOptions
localAddress
- the local addresspublic HttpSenderOptions setLogActivity(boolean logEnabled)
NetworkOptions
setLogActivity
in class HttpClientOptions
logEnabled
- true for logging the network activitypublic HttpSenderOptions setTryUsePerFrameWebSocketCompression(boolean offer)
HttpClientOptions
setTryUsePerFrameWebSocketCompression
in class HttpClientOptions
offer
- true
to offer the per-frame deflate compression extensionpublic HttpSenderOptions setTryUsePerMessageWebSocketCompression(boolean offer)
HttpClientOptions
setTryUsePerMessageWebSocketCompression
in class HttpClientOptions
offer
- true
to offer the per-message deflate compression extensionpublic HttpSenderOptions setWebSocketCompressionLevel(int compressionLevel)
HttpClientOptions
setWebSocketCompressionLevel
in class HttpClientOptions
compressionLevel
- the WebSocket deflate compression levelpublic HttpSenderOptions setWebSocketCompressionAllowClientNoContext(boolean offer)
HttpClientOptions
client_no_context_takeover
parameter of the WebSocket per-message
deflate compression extension will be offered.setWebSocketCompressionAllowClientNoContext
in class HttpClientOptions
offer
- true
to offer the client_no_context_takeover
parameterpublic HttpSenderOptions setWebSocketCompressionRequestServerNoContext(boolean offer)
HttpClientOptions
server_no_context_takeover
parameter of the WebSocket per-message
deflate compression extension will be offered.setWebSocketCompressionRequestServerNoContext
in class HttpClientOptions
offer
- true
to offer the server_no_context_takeover
parameterpublic HttpSenderOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)
HttpClientOptions
initialBufferSizeHttpDecoder
the initial buffer of the HttpDecoder.setDecoderInitialBufferSize
in class HttpClientOptions
decoderInitialBufferSize
- the initial buffer sizepublic HttpSenderOptions setPoolCleanerPeriod(int poolCleanerPeriod)
HttpClientOptions
setPoolCleanerPeriod
in class HttpClientOptions
poolCleanerPeriod
- the pool cleaner periodCopyright © 2021 Eclipse. All rights reserved.