Package io.vertx.core.http
Class WebSocketClientOptions
- java.lang.Object
-
- io.vertx.core.net.NetworkOptions
-
- io.vertx.core.net.TCPSSLOptions
-
- io.vertx.core.net.ClientOptionsBase
-
- io.vertx.core.http.WebSocketClientOptions
-
public class WebSocketClientOptions extends ClientOptionsBase
-
-
Field Summary
Fields Modifier and Type Field Description static booleanDEFAULT_ALLOW_CLIENT_NO_CONTEXTDefault offering of theserver_no_context_takeoverWebSocket parameter deflate compression extension =falsestatic intDEFAULT_CLOSING_TIMEOUTDefault WebSocket closing timeout = 10 secondstatic intDEFAULT_COMPRESSION_LEVELDefault WebSocket deflate compression level = 6static StringDEFAULT_DEFAULT_HOSTThe default value for host name = "localhost"static intDEFAULT_DEFAULT_PORTThe default value for port = 80static intDEFAULT_MAX_CONNECTIONSThe default value for the maximum number of WebSocket = 50static intDEFAULT_MAX_FRAME_SIZEThe default value for maximum WebSocket frame size = 65536 bytesstatic intDEFAULT_MAX_MESSAGE_SIZEThe default value for maximum WebSocket messages (could be assembled from multiple frames) is 4 full frames worth of datastatic booleanDEFAULT_REQUEST_SERVER_NO_CONTEXTDefault offering of theclient_no_context_takeoverWebSocket parameter deflate compression extension =falsestatic booleanDEFAULT_SEND_UNMASKED_FRAMESDefault WebSocket masked bit is true as depicted by RFC =falsestatic booleanDEFAULT_TRY_USE_PER_FRAME_COMPRESSIONDefault offer WebSocket per-frame deflate compression extension =falsestatic booleanDEFAULT_TRY_USE_PER_MESSAGE_COMPRESSIONDefault offer WebSocket per-message deflate compression extension =false-
Fields inherited from class io.vertx.core.net.ClientOptionsBase
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME
-
Fields inherited from class io.vertx.core.net.TCPSSLOptions
DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_TCP_USER_TIMEOUT, DEFAULT_WRITE_IDLE_TIMEOUT
-
Fields inherited from class io.vertx.core.net.NetworkOptions
DEFAULT_LOG_ACTIVITY_FORMAT, DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS
-
-
Constructor Summary
Constructors Constructor Description WebSocketClientOptions()Default constructorWebSocketClientOptions(WebSocketClientOptions other)Copy constructorWebSocketClientOptions(JsonObject json)Constructor to create an options from JSON
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebSocketClientOptionsaddCrlPath(String crlPath)Add a CRL pathWebSocketClientOptionsaddCrlValue(Buffer crlValue)Add a CRL valueWebSocketClientOptionsaddEnabledCipherSuite(String suite)Add an enabled cipher suite, appended to the ordered suites.WebSocketClientOptionsaddEnabledSecureTransportProtocol(String protocol)Add an enabled SSL/TLS protocols, appended to the ordered protocols.WebSocketClientOptionsaddNonProxyHost(String host)Add ahostto theClientOptionsBase.getNonProxyHosts()list.intgetClosingTimeout()booleangetCompressionAllowClientNoContext()intgetCompressionLevel()booleangetCompressionRequestServerNoContext()StringgetDefaultHost()Get the default host name to be used by this client in requests if none is provided when making the request.intgetDefaultPort()Get the default port to be used by this client in requests if none is provided when making the request.intgetMaxConnections()Get the maximum of WebSockets per endpoint.intgetMaxFrameSize()Get the maximum WebSocket frame size to useintgetMaxMessageSize()Get the maximum WebSocket message size to useStringgetName()booleangetTryUsePerFrameCompression()booleangetTryUsePerMessageCompression()booleanisSendUnmaskedFrames()booleanisShared()booleanisVerifyHost()Is hostname verification (for SSL/TLS) enabled?WebSocketClientOptionsremoveEnabledCipherSuite(String suite)Removes an enabled cipher suite from the ordered suites.WebSocketClientOptionssetActivityLogDataFormat(ByteBufFormat activityLogDataFormat)Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.WebSocketClientOptionssetClosingTimeout(int closingTimeout)Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.WebSocketClientOptionssetCompressionAllowClientNoContext(boolean offer)Set whether theclient_no_context_takeoverparameter of the WebSocket per-message deflate compression extension will be offered.WebSocketClientOptionssetCompressionLevel(int compressionLevel)Set the WebSocket deflate compression level.WebSocketClientOptionssetCompressionRequestServerNoContext(boolean offer)Set whether theserver_no_context_takeoverparameter of the WebSocket per-message deflate compression extension will be offered.WebSocketClientOptionssetConnectTimeout(int connectTimeout)Set the connect timeoutWebSocketClientOptionssetDefaultHost(String defaultHost)Set the default host name to be used by this client in requests if none is provided when making the request.WebSocketClientOptionssetDefaultPort(int defaultPort)Set the default port to be used by this client in requests if none is provided when making the request.WebSocketClientOptionssetEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)Sets the list of enabled SSL/TLS protocols.WebSocketClientOptionssetIdleTimeout(int idleTimeout)Set the idle timeout, default time unit is seconds.WebSocketClientOptionssetIdleTimeoutUnit(TimeUnit idleTimeoutUnit)Set the idle timeout unit.WebSocketClientOptionssetKeyCertOptions(KeyCertOptions options)Set the key/cert options.WebSocketClientOptionssetLocalAddress(String localAddress)Set the local interface to bind for network connections.WebSocketClientOptionssetLogActivity(boolean logEnabled)Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.WebSocketClientOptionssetMaxConnections(int maxConnections)Set the max number of WebSockets per endpoint.WebSocketClientOptionssetMaxFrameSize(int maxFrameSize)Set the max WebSocket frame sizeWebSocketClientOptionssetMaxMessageSize(int maxMessageSize)Set the max WebSocket message sizeWebSocketClientOptionssetMetricsName(String metricsName)Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.WebSocketClientOptionssetName(String name)Set the client name, used when the client is shared, otherwise ignored.WebSocketClientOptionssetNonProxyHosts(List<String> nonProxyHosts)Set a list of remote hosts that are not proxied when the client is configured to use a proxy.WebSocketClientOptionssetProxyOptions(ProxyOptions proxyOptions)Set proxy options for connections via CONNECT proxy (e.g.WebSocketClientOptionssetReadIdleTimeout(int idleTimeout)Set the read idle timeout, default time unit is seconds.WebSocketClientOptionssetReceiveBufferSize(int receiveBufferSize)Set the TCP receive buffer sizeWebSocketClientOptionssetReuseAddress(boolean reuseAddress)Set the value of reuse addressWebSocketClientOptionssetReusePort(boolean reusePort)Set the value of reuse port.WebSocketClientOptionssetSendBufferSize(int sendBufferSize)Set the TCP send buffer sizeWebSocketClientOptionssetSendUnmaskedFrames(boolean sendUnmaskedFrames)Settruewhen the client wants to skip frame masking.WebSocketClientOptionssetShared(boolean shared)Set totrueto share the client.WebSocketClientOptionssetSoLinger(int soLinger)Set whether SO_linger keep alive is enabledWebSocketClientOptionssetSsl(boolean ssl)Set whether SSL/TLS is enabledWebSocketClientOptionssetSslEngineOptions(SSLEngineOptions sslEngineOptions)Set to use SSL engine implementation to use.WebSocketClientOptionssetSslHandshakeTimeout(long sslHandshakeTimeout)Set the SSL handshake timeout, default time unit is seconds.WebSocketClientOptionssetSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)Set the SSL handshake timeout unit.WebSocketClientOptionssetTcpCork(boolean tcpCork)Enable theTCP_CORKoption - only with linux native transport.WebSocketClientOptionssetTcpFastOpen(boolean tcpFastOpen)Enable theTCP_FASTOPENoption - only with linux native transport.WebSocketClientOptionssetTcpKeepAlive(boolean tcpKeepAlive)Set whether TCP keep alive is enabledWebSocketClientOptionssetTcpNoDelay(boolean tcpNoDelay)Set whether TCP no delay is enabledWebSocketClientOptionssetTcpQuickAck(boolean tcpQuickAck)Enable theTCP_QUICKACKoption - only with linux native transport.WebSocketClientOptionssetTcpUserTimeout(int tcpUserTimeout)Sets theTCP_USER_TIMEOUToption - only with linux native transport.WebSocketClientOptionssetTrafficClass(int trafficClass)Set the value of traffic classWebSocketClientOptionssetTrustAll(boolean trustAll)Set whether all server certificates should be trustedWebSocketClientOptionssetTrustOptions(TrustOptions options)Set the trust options.WebSocketClientOptionssetTryUsePerFrameCompression(boolean offer)Set whether the client will offer the WebSocket per-frame deflate compression extension.WebSocketClientOptionssetTryUsePerMessageCompression(boolean offer)Set whether the client will offer the WebSocket per-message deflate compression extension.WebSocketClientOptionssetUseAlpn(boolean useAlpn)Set the ALPN usage.WebSocketClientOptionssetVerifyHost(boolean verifyHost)Set whether hostname verification is enabledWebSocketClientOptionssetWriteIdleTimeout(int idleTimeout)Set the write idle timeout, default time unit is seconds.JsonObjecttoJson()Convert to JSON-
Methods inherited from class io.vertx.core.net.ClientOptionsBase
getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getOrCreateSSLOptions, getProxyOptions, getSslOptions, isTrustAll, removeEnabledSecureTransportProtocol
-
Methods inherited from class io.vertx.core.net.TCPSSLOptions
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getKeyCertOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTcpUserTimeout, getTrustOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn
-
Methods inherited from class io.vertx.core.net.NetworkOptions
getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort
-
-
-
-
Field Detail
-
DEFAULT_MAX_MESSAGE_SIZE
public static final int DEFAULT_MAX_MESSAGE_SIZE
The default value for maximum WebSocket messages (could be assembled from multiple frames) is 4 full frames worth of data- See Also:
- Constant Field Values
-
DEFAULT_MAX_CONNECTIONS
public static final int DEFAULT_MAX_CONNECTIONS
The default value for the maximum number of WebSocket = 50- See Also:
- Constant Field Values
-
DEFAULT_SEND_UNMASKED_FRAMES
public static final boolean DEFAULT_SEND_UNMASKED_FRAMES
Default WebSocket masked bit is true as depicted by RFC =false- See Also:
- Constant Field Values
-
DEFAULT_TRY_USE_PER_FRAME_COMPRESSION
public static final boolean DEFAULT_TRY_USE_PER_FRAME_COMPRESSION
Default offer WebSocket per-frame deflate compression extension =false- See Also:
- Constant Field Values
-
DEFAULT_TRY_USE_PER_MESSAGE_COMPRESSION
public static final boolean DEFAULT_TRY_USE_PER_MESSAGE_COMPRESSION
Default offer WebSocket per-message deflate compression extension =false- See Also:
- Constant Field Values
-
DEFAULT_COMPRESSION_LEVEL
public static final int DEFAULT_COMPRESSION_LEVEL
Default WebSocket deflate compression level = 6- See Also:
- Constant Field Values
-
DEFAULT_ALLOW_CLIENT_NO_CONTEXT
public static final boolean DEFAULT_ALLOW_CLIENT_NO_CONTEXT
Default offering of theserver_no_context_takeoverWebSocket parameter deflate compression extension =false- See Also:
- Constant Field Values
-
DEFAULT_REQUEST_SERVER_NO_CONTEXT
public static final boolean DEFAULT_REQUEST_SERVER_NO_CONTEXT
Default offering of theclient_no_context_takeoverWebSocket parameter deflate compression extension =false- See Also:
- Constant Field Values
-
DEFAULT_CLOSING_TIMEOUT
public static final int DEFAULT_CLOSING_TIMEOUT
Default WebSocket closing timeout = 10 second- See Also:
- Constant Field Values
-
DEFAULT_MAX_FRAME_SIZE
public static final int DEFAULT_MAX_FRAME_SIZE
The default value for maximum WebSocket frame size = 65536 bytes- See Also:
- Constant Field Values
-
DEFAULT_DEFAULT_HOST
public static final String DEFAULT_DEFAULT_HOST
The default value for host name = "localhost"- See Also:
- Constant Field Values
-
DEFAULT_DEFAULT_PORT
public static final int DEFAULT_DEFAULT_PORT
The default value for port = 80- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WebSocketClientOptions
public WebSocketClientOptions()
Default constructor
-
WebSocketClientOptions
public WebSocketClientOptions(WebSocketClientOptions other)
Copy constructor- Parameters:
other- the options to copy
-
WebSocketClientOptions
public WebSocketClientOptions(JsonObject json)
Constructor to create an options from JSON- Parameters:
json- the JSON
-
-
Method Detail
-
getDefaultHost
public String getDefaultHost()
Get the default host name to be used by this client in requests if none is provided when making the request.- Returns:
- the default host name
-
setDefaultHost
public WebSocketClientOptions setDefaultHost(String defaultHost)
Set the default host name to be used by this client in requests if none is provided when making the request.- Returns:
- a reference to this, so the API can be used fluently
-
getDefaultPort
public int getDefaultPort()
Get the default port to be used by this client in requests if none is provided when making the request.- Returns:
- the default port
-
setDefaultPort
public WebSocketClientOptions setDefaultPort(int defaultPort)
Set the default port to be used by this client in requests if none is provided when making the request.- Returns:
- a reference to this, so the API can be used fluently
-
isVerifyHost
public boolean isVerifyHost()
Is hostname verification (for SSL/TLS) enabled?- Returns:
trueif enabled
-
setVerifyHost
public WebSocketClientOptions setVerifyHost(boolean verifyHost)
Set whether hostname verification is enabled- Parameters:
verifyHost-trueif enabled- Returns:
- a reference to this, so the API can be used fluently
-
isSendUnmaskedFrames
public boolean isSendUnmaskedFrames()
- Returns:
truewhen frame masking is skipped
-
setSendUnmaskedFrames
public WebSocketClientOptions setSendUnmaskedFrames(boolean sendUnmaskedFrames)
Settruewhen the client wants to skip frame masking.You may want to set it
trueon server by server WebSocket communication: in this case you are by passing RFC6455 protocol.It's
falseas default.- Parameters:
sendUnmaskedFrames- true if enabled- Returns:
- a reference to this, so the API can be used fluently
-
getMaxFrameSize
public int getMaxFrameSize()
Get the maximum WebSocket frame size to use- Returns:
- the max WebSocket frame size
-
setMaxFrameSize
public WebSocketClientOptions setMaxFrameSize(int maxFrameSize)
Set the max WebSocket frame size- Parameters:
maxFrameSize- the max frame size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
getMaxMessageSize
public int getMaxMessageSize()
Get the maximum WebSocket message size to use- Returns:
- the max WebSocket message size
-
setMaxMessageSize
public WebSocketClientOptions setMaxMessageSize(int maxMessageSize)
Set the max WebSocket message size- Parameters:
maxMessageSize- the max message size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
getMaxConnections
public int getMaxConnections()
Get the maximum of WebSockets per endpoint.- Returns:
- the max number of WebSockets
-
setMaxConnections
public WebSocketClientOptions setMaxConnections(int maxConnections)
Set the max number of WebSockets per endpoint.- Parameters:
maxConnections- the max value- Returns:
- a reference to this, so the API can be used fluently
-
setTryUsePerFrameCompression
public WebSocketClientOptions setTryUsePerFrameCompression(boolean offer)
Set whether the client will offer the WebSocket per-frame deflate compression extension.- Parameters:
offer-trueto offer the per-frame deflate compression extension- Returns:
- a reference to this, so the API can be used fluently
-
getTryUsePerFrameCompression
public boolean getTryUsePerFrameCompression()
- Returns:
truewhen the WebSocket per-frame deflate compression extension will be offered
-
setTryUsePerMessageCompression
public WebSocketClientOptions setTryUsePerMessageCompression(boolean offer)
Set whether the client will offer the WebSocket per-message deflate compression extension.- Parameters:
offer-trueto offer the per-message deflate compression extension- Returns:
- a reference to this, so the API can be used fluently
-
getTryUsePerMessageCompression
public boolean getTryUsePerMessageCompression()
- Returns:
truewhen the WebSocket per-message deflate compression extension will be offered
-
setCompressionLevel
public WebSocketClientOptions setCompressionLevel(int compressionLevel)
Set the WebSocket deflate compression level.- Parameters:
compressionLevel- the WebSocket deflate compression level- Returns:
- a reference to this, so the API can be used fluently
-
getCompressionLevel
public int getCompressionLevel()
- Returns:
- the WebSocket deflate compression level
-
setCompressionAllowClientNoContext
public WebSocketClientOptions setCompressionAllowClientNoContext(boolean offer)
Set whether theclient_no_context_takeoverparameter of the WebSocket per-message deflate compression extension will be offered.- Parameters:
offer-trueto offer theclient_no_context_takeoverparameter- Returns:
- a reference to this, so the API can be used fluently
-
getCompressionAllowClientNoContext
public boolean getCompressionAllowClientNoContext()
- Returns:
truewhen theclient_no_context_takeoverparameter for the WebSocket per-message deflate compression extension will be offered
-
setCompressionRequestServerNoContext
public WebSocketClientOptions setCompressionRequestServerNoContext(boolean offer)
Set whether theserver_no_context_takeoverparameter of the WebSocket per-message deflate compression extension will be offered.- Parameters:
offer-trueto offer theserver_no_context_takeoverparameter- Returns:
- a reference to this, so the API can be used fluently
-
getCompressionRequestServerNoContext
public boolean getCompressionRequestServerNoContext()
- Returns:
truewhen theserver_no_context_takeoverparameter for the WebSocket per-message deflate compression extension will be offered
-
getClosingTimeout
public int getClosingTimeout()
- Returns:
- the amount of time (in seconds) a client WebSocket will wait until it closes TCP connection after receiving a close frame
-
setClosingTimeout
public WebSocketClientOptions setClosingTimeout(int closingTimeout)
Set the amount of time a client WebSocket will wait until it closes the TCP connection after receiving a close frame.When a WebSocket is closed, the server should close the TCP connection. This timeout will close the TCP connection on the client when it expires.
Set to
0Lcloses the TCP connection immediately after receiving the close frame.Set to a negative value to disable it.
- Parameters:
closingTimeout- the timeout is seconds- Returns:
- a reference to this, so the API can be used fluently
-
isShared
public boolean isShared()
- Returns:
- whether the pool is shared
-
setShared
public WebSocketClientOptions setShared(boolean shared)
Set totrueto share the client.There can be multiple shared clients distinguished by
getName(), when no specific name is set, theHttpClientOptions.DEFAULT_NAMEis used.- Parameters:
shared-trueto use a shared client- Returns:
- a reference to this, so the API can be used fluently
-
getName
public String getName()
- Returns:
- the client name used for sharing
-
setName
public WebSocketClientOptions setName(String name)
Set the client name, used when the client is shared, otherwise ignored.- Parameters:
name- the new name- Returns:
- a reference to this, so the API can be used fluently
-
toJson
public JsonObject toJson()
Convert to JSON- Overrides:
toJsonin classClientOptionsBase- Returns:
- the JSON
-
setTrustAll
public WebSocketClientOptions setTrustAll(boolean trustAll)
Description copied from class:ClientOptionsBaseSet whether all server certificates should be trusted- Overrides:
setTrustAllin classClientOptionsBase- Parameters:
trustAll- true if all should be trusted- Returns:
- a reference to this, so the API can be used fluently
-
setConnectTimeout
public WebSocketClientOptions setConnectTimeout(int connectTimeout)
Description copied from class:ClientOptionsBaseSet the connect timeout- Overrides:
setConnectTimeoutin classClientOptionsBase- Parameters:
connectTimeout- connect timeout, in ms- Returns:
- a reference to this, so the API can be used fluently
-
setMetricsName
public WebSocketClientOptions setMetricsName(String metricsName)
Description copied from class:ClientOptionsBaseSet the metrics name identifying the reported metrics, useful for grouping metrics with the same name.- Overrides:
setMetricsNamein classClientOptionsBase- Parameters:
metricsName- the metrics name- Returns:
- a reference to this, so the API can be used fluently
-
setProxyOptions
public WebSocketClientOptions setProxyOptions(ProxyOptions proxyOptions)
Description copied from class:ClientOptionsBaseSet proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.- Overrides:
setProxyOptionsin classClientOptionsBase- Parameters:
proxyOptions- proxy options object- Returns:
- a reference to this, so the API can be used fluently
-
setNonProxyHosts
public WebSocketClientOptions setNonProxyHosts(List<String> nonProxyHosts)
Description copied from class:ClientOptionsBaseSet a list of remote hosts that are not proxied when the client is configured to use a proxy. This list serves the same purpose than the JVMnonProxyHostsconfiguration.Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.
- Overrides:
setNonProxyHostsin classClientOptionsBase- Parameters:
nonProxyHosts- the list of non proxies hosts- Returns:
- a reference to this, so the API can be used fluently
-
setLocalAddress
public WebSocketClientOptions setLocalAddress(String localAddress)
Description copied from class:ClientOptionsBaseSet the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.- Overrides:
setLocalAddressin classClientOptionsBase- Parameters:
localAddress- the local address- Returns:
- a reference to this, so the API can be used fluently
-
setLogActivity
public WebSocketClientOptions setLogActivity(boolean logEnabled)
Description copied from class:NetworkOptionsSet to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.- Overrides:
setLogActivityin classClientOptionsBase- Parameters:
logEnabled- true for logging the network activity- Returns:
- a reference to this, so the API can be used fluently
-
setActivityLogDataFormat
public WebSocketClientOptions setActivityLogDataFormat(ByteBufFormat activityLogDataFormat)
Description copied from class:NetworkOptionsSet the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.- Overrides:
setActivityLogDataFormatin classClientOptionsBase- Parameters:
activityLogDataFormat- the format to use- Returns:
- a reference to this, so the API can be used fluently
-
setTcpNoDelay
public WebSocketClientOptions setTcpNoDelay(boolean tcpNoDelay)
Description copied from class:TCPSSLOptionsSet whether TCP no delay is enabled- Overrides:
setTcpNoDelayin classClientOptionsBase- Parameters:
tcpNoDelay- true if TCP no delay is enabled (Nagle disabled)- Returns:
- a reference to this, so the API can be used fluently
-
setTcpKeepAlive
public WebSocketClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
Description copied from class:TCPSSLOptionsSet whether TCP keep alive is enabled- Overrides:
setTcpKeepAlivein classClientOptionsBase- Parameters:
tcpKeepAlive- true if TCP keep alive is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setSoLinger
public WebSocketClientOptions setSoLinger(int soLinger)
Description copied from class:TCPSSLOptionsSet whether SO_linger keep alive is enabled- Overrides:
setSoLingerin classClientOptionsBase- Parameters:
soLinger- true if SO_linger is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeout
public WebSocketClientOptions setIdleTimeout(int idleTimeout)
Description copied from class:TCPSSLOptionsSet the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout. If you want change default time unit, useTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)- Overrides:
setIdleTimeoutin classClientOptionsBase- Parameters:
idleTimeout- the timeout- Returns:
- a reference to this, so the API can be used fluently
-
setReadIdleTimeout
public WebSocketClientOptions setReadIdleTimeout(int idleTimeout)
Description copied from class:TCPSSLOptionsSet the read idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout. If you want change default time unit, useTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)- Overrides:
setReadIdleTimeoutin classClientOptionsBase- Parameters:
idleTimeout- the read timeout- Returns:
- a reference to this, so the API can be used fluently
-
setWriteIdleTimeout
public WebSocketClientOptions setWriteIdleTimeout(int idleTimeout)
Description copied from class:TCPSSLOptionsSet the write idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is sent within the timeout. If you want change default time unit, useTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)- Overrides:
setWriteIdleTimeoutin classClientOptionsBase- Parameters:
idleTimeout- the write timeout- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeoutUnit
public WebSocketClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Description copied from class:TCPSSLOptionsSet the idle timeout unit. If not specified, default is seconds.- Overrides:
setIdleTimeoutUnitin classClientOptionsBase- Parameters:
idleTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
setSsl
public WebSocketClientOptions setSsl(boolean ssl)
Description copied from class:TCPSSLOptionsSet whether SSL/TLS is enabled- Overrides:
setSslin classClientOptionsBase- Parameters:
ssl- true if enabled- Returns:
- a reference to this, so the API can be used fluently
-
setKeyCertOptions
public WebSocketClientOptions setKeyCertOptions(KeyCertOptions options)
Description copied from class:TCPSSLOptionsSet the key/cert options.- Overrides:
setKeyCertOptionsin classClientOptionsBase- Parameters:
options- the key store options- Returns:
- a reference to this, so the API can be used fluently
-
setTrustOptions
public WebSocketClientOptions setTrustOptions(TrustOptions options)
Description copied from class:TCPSSLOptionsSet the trust options.- Overrides:
setTrustOptionsin classClientOptionsBase- Parameters:
options- the trust options- Returns:
- a reference to this, so the API can be used fluently
-
setUseAlpn
public WebSocketClientOptions setUseAlpn(boolean useAlpn)
Description copied from class:TCPSSLOptionsSet the ALPN usage.- Overrides:
setUseAlpnin classClientOptionsBase- Parameters:
useAlpn- true when Application-Layer Protocol Negotiation should be used
-
setSslEngineOptions
public WebSocketClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Description copied from class:TCPSSLOptionsSet to use SSL engine implementation to use.- Overrides:
setSslEngineOptionsin classClientOptionsBase- Parameters:
sslEngineOptions- the ssl engine to use- Returns:
- a reference to this, so the API can be used fluently
-
setSendBufferSize
public WebSocketClientOptions setSendBufferSize(int sendBufferSize)
Description copied from class:NetworkOptionsSet the TCP send buffer size- Overrides:
setSendBufferSizein classClientOptionsBase- Parameters:
sendBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReceiveBufferSize
public WebSocketClientOptions setReceiveBufferSize(int receiveBufferSize)
Description copied from class:NetworkOptionsSet the TCP receive buffer size- Overrides:
setReceiveBufferSizein classClientOptionsBase- Parameters:
receiveBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReuseAddress
public WebSocketClientOptions setReuseAddress(boolean reuseAddress)
Description copied from class:NetworkOptionsSet the value of reuse address- Overrides:
setReuseAddressin classClientOptionsBase- Parameters:
reuseAddress- the value of reuse address- Returns:
- a reference to this, so the API can be used fluently
-
setReusePort
public WebSocketClientOptions setReusePort(boolean reusePort)
Description copied from class:NetworkOptionsSet the value of reuse port. This is only supported by native transports.- Overrides:
setReusePortin classClientOptionsBase- Parameters:
reusePort- the value of reuse port- Returns:
- a reference to this, so the API can be used fluently
-
setTrafficClass
public WebSocketClientOptions setTrafficClass(int trafficClass)
Description copied from class:NetworkOptionsSet the value of traffic class- Overrides:
setTrafficClassin classClientOptionsBase- Parameters:
trafficClass- the value of traffic class- Returns:
- a reference to this, so the API can be used fluently
-
setTcpFastOpen
public WebSocketClientOptions setTcpFastOpen(boolean tcpFastOpen)
Description copied from class:TCPSSLOptionsEnable theTCP_FASTOPENoption - only with linux native transport.- Overrides:
setTcpFastOpenin classClientOptionsBase- Parameters:
tcpFastOpen- the fast open value
-
setTcpCork
public WebSocketClientOptions setTcpCork(boolean tcpCork)
Description copied from class:TCPSSLOptionsEnable theTCP_CORKoption - only with linux native transport.- Overrides:
setTcpCorkin classClientOptionsBase- Parameters:
tcpCork- the cork value
-
setTcpQuickAck
public WebSocketClientOptions setTcpQuickAck(boolean tcpQuickAck)
Description copied from class:TCPSSLOptionsEnable theTCP_QUICKACKoption - only with linux native transport.- Overrides:
setTcpQuickAckin classClientOptionsBase- Parameters:
tcpQuickAck- the quick ack value
-
setTcpUserTimeout
public WebSocketClientOptions setTcpUserTimeout(int tcpUserTimeout)
Description copied from class:TCPSSLOptionsSets theTCP_USER_TIMEOUToption - only with linux native transport.- Overrides:
setTcpUserTimeoutin classClientOptionsBase- Parameters:
tcpUserTimeout- the tcp user timeout value
-
setEnabledSecureTransportProtocols
public WebSocketClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
Description copied from class:TCPSSLOptionsSets the list of enabled SSL/TLS protocols.- Overrides:
setEnabledSecureTransportProtocolsin classTCPSSLOptions- Parameters:
enabledSecureTransportProtocols- the SSL/TLS protocols to enable- Returns:
- a reference to this, so the API can be used fluently
-
setSslHandshakeTimeout
public WebSocketClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)
Description copied from class:TCPSSLOptionsSet the SSL handshake timeout, default time unit is seconds.- Overrides:
setSslHandshakeTimeoutin classTCPSSLOptions- Parameters:
sslHandshakeTimeout- the SSL handshake timeout to set, in milliseconds- Returns:
- a reference to this, so the API can be used fluently
-
setSslHandshakeTimeoutUnit
public WebSocketClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
Description copied from class:TCPSSLOptionsSet the SSL handshake timeout unit. If not specified, default is seconds.- Overrides:
setSslHandshakeTimeoutUnitin classTCPSSLOptions- Parameters:
sslHandshakeTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
addNonProxyHost
public WebSocketClientOptions addNonProxyHost(String host)
Description copied from class:ClientOptionsBaseAdd ahostto theClientOptionsBase.getNonProxyHosts()list.- Overrides:
addNonProxyHostin classClientOptionsBase- Parameters:
host- the added host- Returns:
- a reference to this, so the API can be used fluently
-
addEnabledCipherSuite
public WebSocketClientOptions addEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsAdd an enabled cipher suite, appended to the ordered suites.- Overrides:
addEnabledCipherSuitein classClientOptionsBase- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
- See Also:
TCPSSLOptions.getEnabledCipherSuites()
-
removeEnabledCipherSuite
public WebSocketClientOptions removeEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsRemoves an enabled cipher suite from the ordered suites.- Overrides:
removeEnabledCipherSuitein classClientOptionsBase- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
-
addCrlPath
public WebSocketClientOptions addCrlPath(String crlPath) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL path- Overrides:
addCrlPathin classClientOptionsBase- Parameters:
crlPath- the path- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
addCrlValue
public WebSocketClientOptions addCrlValue(Buffer crlValue) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL value- Overrides:
addCrlValuein classClientOptionsBase- Parameters:
crlValue- the value- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
addEnabledSecureTransportProtocol
public WebSocketClientOptions addEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsAdd an enabled SSL/TLS protocols, appended to the ordered protocols.- Overrides:
addEnabledSecureTransportProtocolin classClientOptionsBase- Parameters:
protocol- the SSL/TLS protocol to enable- Returns:
- a reference to this, so the API can be used fluently
-
-