Package io.vertx.core.net
Class NetServerOptions
- java.lang.Object
-
- io.vertx.core.net.NetworkOptions
-
- io.vertx.core.net.TCPSSLOptions
-
- io.vertx.core.net.NetServerOptions
-
- Direct Known Subclasses:
HttpServerOptions,MqttServerOptions,StompServerOptions,TelnetTermOptions
public class NetServerOptions extends TCPSSLOptions
Options for configuring aNetServer.- Author:
- Tim Fox
-
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_ACCEPT_BACKLOGThe default accept backlog = 1024static StringDEFAULT_HOSTThe default host to listen on = "0.0.0.0" (meaning listen on all available interfaces).static intDEFAULT_PORTThe default port to listen on = 0 (meaning a random ephemeral free port will be chosen)static longDEFAULT_PROXY_PROTOCOL_TIMEOUTThe default value of HA PROXY protocol timeout = 10static TimeUnitDEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNITDefault HA PROXY protocol time unit = SECONDSstatic booleanDEFAULT_REGISTER_WRITE_HANDLERWhether a write-handler should be registered by default = false.static booleanDEFAULT_USE_PROXY_PROTOCOLDefault value of whether the server supports HA PROXY protocol = false-
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 NetServerOptions()Default constructorNetServerOptions(JsonObject json)Create some options from JSONNetServerOptions(NetServerOptions other)Copy constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NetServerOptionsaddCrlPath(String crlPath)Add a CRL pathNetServerOptionsaddCrlValue(Buffer crlValue)Add a CRL valueNetServerOptionsaddEnabledCipherSuite(String suite)Add an enabled cipher suite, appended to the ordered suites.NetServerOptionsaddEnabledSecureTransportProtocol(String protocol)Add an enabled SSL/TLS protocols, appended to the ordered protocols.NetServerOptionscopy()Copy these options.intgetAcceptBacklog()ClientAuthgetClientAuth()StringgetHost()protected ServerSSLOptionsgetOrCreateSSLOptions()intgetPort()longgetProxyProtocolTimeout()TimeUnitgetProxyProtocolTimeoutUnit()ServerSSLOptionsgetSslOptions()TrafficShapingOptionsgetTrafficShapingOptions()booleanisFileRegionEnabled()booleanisRegisterWriteHandler()booleanisSni()booleanisUseProxyProtocol()NetServerOptionsremoveEnabledCipherSuite(String suite)Removes an enabled cipher suite from the ordered suites.NetServerOptionsremoveEnabledSecureTransportProtocol(String protocol)Removes an enabled SSL/TLS protocol from the ordered protocols.NetServerOptionssetAcceptBacklog(int acceptBacklog)Set the accept back logNetServerOptionssetActivityLogDataFormat(ByteBufFormat activityLogDataFormat)Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.NetServerOptionssetClientAuth(ClientAuth clientAuth)Set whether client auth is requiredNetServerOptionssetEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)Sets the list of enabled SSL/TLS protocols.NetServerOptionssetHost(String host)Set the hostNetServerOptionssetIdleTimeout(int idleTimeout)Set the idle timeout, default time unit is seconds.NetServerOptionssetIdleTimeoutUnit(TimeUnit idleTimeoutUnit)Set the idle timeout unit.NetServerOptionssetKeyCertOptions(KeyCertOptions options)Set the key/cert options.NetServerOptionssetLogActivity(boolean logEnabled)Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.NetServerOptionssetPort(int port)Set the portNetServerOptionssetProxyProtocolTimeout(long proxyProtocolTimeout)Set the Proxy protocol timeout, default time unit is seconds.NetServerOptionssetProxyProtocolTimeoutUnit(TimeUnit proxyProtocolTimeoutUnit)Set the Proxy protocol timeout unit.NetServerOptionssetReadIdleTimeout(int idleTimeout)Set the read idle timeout, default time unit is seconds.NetServerOptionssetReceiveBufferSize(int receiveBufferSize)Set the TCP receive buffer sizeNetServerOptionssetRegisterWriteHandler(boolean registerWriteHandler)Whether a write-handler should be registered on theEventBus.NetServerOptionssetReuseAddress(boolean reuseAddress)Set the value of reuse addressNetServerOptionssetReusePort(boolean reusePort)Set the value of reuse port.NetServerOptionssetSendBufferSize(int sendBufferSize)Set the TCP send buffer sizeNetServerOptionssetSni(boolean sni)Set whether the server supports Server Name IndiciationNetServerOptionssetSoLinger(int soLinger)Set whether SO_linger keep alive is enabledNetServerOptionssetSsl(boolean ssl)Set whether SSL/TLS is enabledNetServerOptionssetSslEngineOptions(SSLEngineOptions sslEngineOptions)Set to use SSL engine implementation to use.NetServerOptionssetSslHandshakeTimeout(long sslHandshakeTimeout)Set the SSL handshake timeout, default time unit is seconds.NetServerOptionssetSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)Set the SSL handshake timeout unit.NetServerOptionssetTcpCork(boolean tcpCork)Enable theTCP_CORKoption - only with linux native transport.NetServerOptionssetTcpFastOpen(boolean tcpFastOpen)Enable theTCP_FASTOPENoption - only with linux native transport.NetServerOptionssetTcpKeepAlive(boolean tcpKeepAlive)Set whether TCP keep alive is enabledNetServerOptionssetTcpNoDelay(boolean tcpNoDelay)Set whether TCP no delay is enabledNetServerOptionssetTcpQuickAck(boolean tcpQuickAck)Enable theTCP_QUICKACKoption - only with linux native transport.NetServerOptionssetTrafficClass(int trafficClass)Set the value of traffic classNetServerOptionssetTrafficShapingOptions(TrafficShapingOptions trafficShapingOptions)Set traffic shaping options.NetServerOptionssetTrustOptions(TrustOptions options)Set the trust options.NetServerOptionssetUseAlpn(boolean useAlpn)Set the ALPN usage.NetServerOptionssetUseProxyProtocol(boolean useProxyProtocol)Set whether the server uses the HA Proxy protocolNetServerOptionssetWriteIdleTimeout(int idleTimeout)Set the write idle timeout, default time unit is seconds.JsonObjecttoJson()Convert to JSON-
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, setTcpUserTimeout
-
Methods inherited from class io.vertx.core.net.NetworkOptions
getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort
-
-
-
-
Field Detail
-
DEFAULT_PORT
public static final int DEFAULT_PORT
The default port to listen on = 0 (meaning a random ephemeral free port will be chosen)- See Also:
- Constant Field Values
-
DEFAULT_HOST
public static final String DEFAULT_HOST
The default host to listen on = "0.0.0.0" (meaning listen on all available interfaces).- See Also:
- Constant Field Values
-
DEFAULT_ACCEPT_BACKLOG
public static final int DEFAULT_ACCEPT_BACKLOG
The default accept backlog = 1024- See Also:
- Constant Field Values
-
DEFAULT_USE_PROXY_PROTOCOL
public static final boolean DEFAULT_USE_PROXY_PROTOCOL
Default value of whether the server supports HA PROXY protocol = false- See Also:
- Constant Field Values
-
DEFAULT_PROXY_PROTOCOL_TIMEOUT
public static final long DEFAULT_PROXY_PROTOCOL_TIMEOUT
The default value of HA PROXY protocol timeout = 10- See Also:
- Constant Field Values
-
DEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNIT
public static final TimeUnit DEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNIT
Default HA PROXY protocol time unit = SECONDS
-
DEFAULT_REGISTER_WRITE_HANDLER
public static final boolean DEFAULT_REGISTER_WRITE_HANDLER
Whether a write-handler should be registered by default = false.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NetServerOptions
public NetServerOptions()
Default constructor
-
NetServerOptions
public NetServerOptions(NetServerOptions other)
Copy constructor- Parameters:
other- the options to copy
-
NetServerOptions
public NetServerOptions(JsonObject json)
Create some options from JSON- Parameters:
json- the JSON
-
-
Method Detail
-
copy
public NetServerOptions copy()
Copy these options.- Returns:
- a copy of this
-
toJson
public JsonObject toJson()
Convert to JSON- Overrides:
toJsonin classTCPSSLOptions- Returns:
- the JSON
-
getSslOptions
public ServerSSLOptions getSslOptions()
- Overrides:
getSslOptionsin classTCPSSLOptions
-
getOrCreateSSLOptions
protected ServerSSLOptions getOrCreateSSLOptions()
- Overrides:
getOrCreateSSLOptionsin classTCPSSLOptions
-
setSendBufferSize
public NetServerOptions setSendBufferSize(int sendBufferSize)
Description copied from class:NetworkOptionsSet the TCP send buffer size- Overrides:
setSendBufferSizein classTCPSSLOptions- Parameters:
sendBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReceiveBufferSize
public NetServerOptions setReceiveBufferSize(int receiveBufferSize)
Description copied from class:NetworkOptionsSet the TCP receive buffer size- Overrides:
setReceiveBufferSizein classTCPSSLOptions- Parameters:
receiveBufferSize- the buffers size, in bytes- Returns:
- a reference to this, so the API can be used fluently
-
setReuseAddress
public NetServerOptions setReuseAddress(boolean reuseAddress)
Description copied from class:NetworkOptionsSet the value of reuse address- Overrides:
setReuseAddressin classTCPSSLOptions- Parameters:
reuseAddress- the value of reuse address- Returns:
- a reference to this, so the API can be used fluently
-
setReusePort
public NetServerOptions setReusePort(boolean reusePort)
Description copied from class:NetworkOptionsSet the value of reuse port. This is only supported by native transports.- Overrides:
setReusePortin classTCPSSLOptions- Parameters:
reusePort- the value of reuse port- Returns:
- a reference to this, so the API can be used fluently
-
setTrafficClass
public NetServerOptions setTrafficClass(int trafficClass)
Description copied from class:NetworkOptionsSet the value of traffic class- Overrides:
setTrafficClassin classTCPSSLOptions- Parameters:
trafficClass- the value of traffic class- Returns:
- a reference to this, so the API can be used fluently
-
setTcpNoDelay
public NetServerOptions setTcpNoDelay(boolean tcpNoDelay)
Description copied from class:TCPSSLOptionsSet whether TCP no delay is enabled- Overrides:
setTcpNoDelayin classTCPSSLOptions- 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 NetServerOptions setTcpKeepAlive(boolean tcpKeepAlive)
Description copied from class:TCPSSLOptionsSet whether TCP keep alive is enabled- Overrides:
setTcpKeepAlivein classTCPSSLOptions- Parameters:
tcpKeepAlive- true if TCP keep alive is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setSoLinger
public NetServerOptions setSoLinger(int soLinger)
Description copied from class:TCPSSLOptionsSet whether SO_linger keep alive is enabled- Overrides:
setSoLingerin classTCPSSLOptions- Parameters:
soLinger- true if SO_linger is enabled- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeout
public NetServerOptions 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 classTCPSSLOptions- Parameters:
idleTimeout- the timeout- Returns:
- a reference to this, so the API can be used fluently
-
setReadIdleTimeout
public NetServerOptions 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 classTCPSSLOptions- Parameters:
idleTimeout- the read timeout- Returns:
- a reference to this, so the API can be used fluently
-
setWriteIdleTimeout
public NetServerOptions 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 classTCPSSLOptions- Parameters:
idleTimeout- the write timeout- Returns:
- a reference to this, so the API can be used fluently
-
setIdleTimeoutUnit
public NetServerOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Description copied from class:TCPSSLOptionsSet the idle timeout unit. If not specified, default is seconds.- Overrides:
setIdleTimeoutUnitin classTCPSSLOptions- Parameters:
idleTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
setSsl
public NetServerOptions setSsl(boolean ssl)
Description copied from class:TCPSSLOptionsSet whether SSL/TLS is enabled- Overrides:
setSslin classTCPSSLOptions- Parameters:
ssl- true if enabled- Returns:
- a reference to this, so the API can be used fluently
-
setUseAlpn
public NetServerOptions setUseAlpn(boolean useAlpn)
Description copied from class:TCPSSLOptionsSet the ALPN usage.- Overrides:
setUseAlpnin classTCPSSLOptions- Parameters:
useAlpn- true when Application-Layer Protocol Negotiation should be used
-
setSslEngineOptions
public NetServerOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Description copied from class:TCPSSLOptionsSet to use SSL engine implementation to use.- Overrides:
setSslEngineOptionsin classTCPSSLOptions- Parameters:
sslEngineOptions- the ssl engine to use- Returns:
- a reference to this, so the API can be used fluently
-
setKeyCertOptions
public NetServerOptions setKeyCertOptions(KeyCertOptions options)
Description copied from class:TCPSSLOptionsSet the key/cert options.- Overrides:
setKeyCertOptionsin classTCPSSLOptions- Parameters:
options- the key store options- Returns:
- a reference to this, so the API can be used fluently
-
setTrustOptions
public NetServerOptions setTrustOptions(TrustOptions options)
Description copied from class:TCPSSLOptionsSet the trust options.- Overrides:
setTrustOptionsin classTCPSSLOptions- Parameters:
options- the trust options- Returns:
- a reference to this, so the API can be used fluently
-
addEnabledCipherSuite
public NetServerOptions addEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsAdd an enabled cipher suite, appended to the ordered suites.- Overrides:
addEnabledCipherSuitein classTCPSSLOptions- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
- See Also:
TCPSSLOptions.getEnabledCipherSuites()
-
removeEnabledCipherSuite
public NetServerOptions removeEnabledCipherSuite(String suite)
Description copied from class:TCPSSLOptionsRemoves an enabled cipher suite from the ordered suites.- Overrides:
removeEnabledCipherSuitein classTCPSSLOptions- Parameters:
suite- the suite- Returns:
- a reference to this, so the API can be used fluently
-
addEnabledSecureTransportProtocol
public NetServerOptions addEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsAdd an enabled SSL/TLS protocols, appended to the ordered protocols.- Overrides:
addEnabledSecureTransportProtocolin classTCPSSLOptions- Parameters:
protocol- the SSL/TLS protocol to enable- Returns:
- a reference to this, so the API can be used fluently
-
removeEnabledSecureTransportProtocol
public NetServerOptions removeEnabledSecureTransportProtocol(String protocol)
Description copied from class:TCPSSLOptionsRemoves an enabled SSL/TLS protocol from the ordered protocols.- Overrides:
removeEnabledSecureTransportProtocolin classTCPSSLOptions- Parameters:
protocol- the SSL/TLS protocol to disable- Returns:
- a reference to this, so the API can be used fluently
-
setTcpFastOpen
public NetServerOptions setTcpFastOpen(boolean tcpFastOpen)
Description copied from class:TCPSSLOptionsEnable theTCP_FASTOPENoption - only with linux native transport.- Overrides:
setTcpFastOpenin classTCPSSLOptions- Parameters:
tcpFastOpen- the fast open value
-
setTcpCork
public NetServerOptions setTcpCork(boolean tcpCork)
Description copied from class:TCPSSLOptionsEnable theTCP_CORKoption - only with linux native transport.- Overrides:
setTcpCorkin classTCPSSLOptions- Parameters:
tcpCork- the cork value
-
setTcpQuickAck
public NetServerOptions setTcpQuickAck(boolean tcpQuickAck)
Description copied from class:TCPSSLOptionsEnable theTCP_QUICKACKoption - only with linux native transport.- Overrides:
setTcpQuickAckin classTCPSSLOptions- Parameters:
tcpQuickAck- the quick ack value
-
addCrlPath
public NetServerOptions addCrlPath(String crlPath) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL path- Overrides:
addCrlPathin classTCPSSLOptions- Parameters:
crlPath- the path- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
addCrlValue
public NetServerOptions addCrlValue(Buffer crlValue) throws NullPointerException
Description copied from class:TCPSSLOptionsAdd a CRL value- Overrides:
addCrlValuein classTCPSSLOptions- Parameters:
crlValue- the value- Returns:
- a reference to this, so the API can be used fluently
- Throws:
NullPointerException
-
setEnabledSecureTransportProtocols
public NetServerOptions 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 NetServerOptions 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 NetServerOptions 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
-
getAcceptBacklog
public int getAcceptBacklog()
- Returns:
- the value of accept backlog
-
setAcceptBacklog
public NetServerOptions setAcceptBacklog(int acceptBacklog)
Set the accept back log- Parameters:
acceptBacklog- accept backlog- Returns:
- a reference to this, so the API can be used fluently
-
getPort
public int getPort()
- Returns:
- the port
-
setPort
public NetServerOptions setPort(int port)
Set the port- Parameters:
port- the port- Returns:
- a reference to this, so the API can be used fluently
-
getHost
public String getHost()
- Returns:
- the host
-
setHost
public NetServerOptions setHost(String host)
Set the host- Parameters:
host- the host- Returns:
- a reference to this, so the API can be used fluently
-
getClientAuth
public ClientAuth getClientAuth()
-
setClientAuth
public NetServerOptions setClientAuth(ClientAuth clientAuth)
Set whether client auth is required- Parameters:
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.- Returns:
- a reference to this, so the API can be used fluently
-
setLogActivity
public NetServerOptions 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 classTCPSSLOptions- Parameters:
logEnabled- true for logging the network activity- Returns:
- a reference to this, so the API can be used fluently
-
setActivityLogDataFormat
public NetServerOptions 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 classTCPSSLOptions- Parameters:
activityLogDataFormat- the format to use- Returns:
- a reference to this, so the API can be used fluently
-
isSni
public boolean isSni()
- Returns:
- whether the server supports Server Name Indication
-
setSni
public NetServerOptions setSni(boolean sni)
Set whether the server supports Server Name Indiciation- Returns:
- a reference to this, so the API can be used fluently
-
isUseProxyProtocol
public boolean isUseProxyProtocol()
- Returns:
- whether the server uses the HA Proxy protocol
-
setUseProxyProtocol
public NetServerOptions setUseProxyProtocol(boolean useProxyProtocol)
Set whether the server uses the HA Proxy protocol- Returns:
- a reference to this, so the API can be used fluently
-
getProxyProtocolTimeout
public long getProxyProtocolTimeout()
- Returns:
- the Proxy protocol timeout, in time unit specified by
getProxyProtocolTimeoutUnit().
-
setProxyProtocolTimeout
public NetServerOptions setProxyProtocolTimeout(long proxyProtocolTimeout)
Set the Proxy protocol timeout, default time unit is seconds.- Parameters:
proxyProtocolTimeout- the Proxy protocol timeout to set- Returns:
- a reference to this, so the API can be used fluently
-
setProxyProtocolTimeoutUnit
public NetServerOptions setProxyProtocolTimeoutUnit(TimeUnit proxyProtocolTimeoutUnit)
Set the Proxy protocol timeout unit. If not specified, default is seconds.- Parameters:
proxyProtocolTimeoutUnit- specify time unit.- Returns:
- a reference to this, so the API can be used fluently
-
getProxyProtocolTimeoutUnit
public TimeUnit getProxyProtocolTimeoutUnit()
- Returns:
- the Proxy protocol timeout unit.
-
getTrafficShapingOptions
public TrafficShapingOptions getTrafficShapingOptions()
- Returns:
- traffic shaping options used by Net server.
-
setTrafficShapingOptions
public NetServerOptions setTrafficShapingOptions(TrafficShapingOptions trafficShapingOptions)
Set traffic shaping options. If not specified, traffic is unthrottled.- Parameters:
trafficShapingOptions- options used by traffic handler- Returns:
- a reference to this, so the API can be used fluently
-
isRegisterWriteHandler
public boolean isRegisterWriteHandler()
- Returns:
trueif a write-handler should be registered on theEventBus, otherwisefalse
-
setRegisterWriteHandler
public NetServerOptions setRegisterWriteHandler(boolean registerWriteHandler)
Whether a write-handler should be registered on theEventBus.Defaults to
false.- Parameters:
registerWriteHandler- true to register a write-handler- Returns:
- a reference to this, so the API can be used fluently
- See Also:
NetSocket.writeHandlerID()
-
isFileRegionEnabled
public boolean isFileRegionEnabled()
- Returns:
- whether the server should use file region
-
-