io.vertx.proton

Class ProtonServerOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.NetServerOptions

io.vertx.proton.ProtonServerOptions

public class ProtonServerOptions
extends io.vertx.core.net.NetServerOptions

Options for configuring ProtonServer creation.

Field Summary

Fields inherited from class io.vertx.core.net.NetServerOptions

DEFAULT_ACCEPT_BACKLOG, DEFAULT_CLIENT_AUTH, DEFAULT_HOST, DEFAULT_PORT, DEFAULT_PROXY_PROTOCOL_TIMEOUT, DEFAULT_PROXY_PROTOCOL_TIMEOUT_TIME_UNIT, DEFAULT_REGISTER_WRITE_HANDLER, DEFAULT_SNI, DEFAULT_USE_PROXY_PROTOCOL

Fields inherited from class io.vertx.core.net.TCPSSLOptions

DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, 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_KEEAPLIVE_INTERVAL_SECONDS, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_KEEPALIVE_COUNT, DEFAULT_TCP_KEEPALIVE_IDLE_SECONDS, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_TCP_USER_TIMEOUT, DEFAULT_USE_ALPN, 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 and Description
ProtonServerOptions()
ProtonServerOptions(io.vertx.core.json.JsonObject json) Create options from JSON
ProtonServerOptions(ProtonServerOptions other) Copy constructor

Method Summary

Modifier and Type	Method and Description
ProtonServerOptions	addCrlPath(String crlPath)
ProtonServerOptions	addCrlValue(io.vertx.core.buffer.Buffer crlValue)
ProtonServerOptions	addEnabledCipherSuite(String suite)
ProtonServerOptions	addEnabledSecureTransportProtocol(String protocol)
boolean	equals(Object obj)
int	getHeartbeat() Gets the heart beat (in milliseconds) as maximum delay between sending frames for the remote peers.
int	getMaxFrameSize() Gets the maximum frame size for connections.
int	hashCode()
ProtonServerOptions	removeEnabledSecureTransportProtocol(String protocol)
ProtonServerOptions	setAcceptBacklog(int acceptBacklog)
ProtonServerOptions	setClientAuth(io.vertx.core.http.ClientAuth clientAuth)
ProtonServerOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
ProtonServerOptions	setHeartbeat(int heartbeat) Sets the heart beat (in milliseconds) as maximum delay between sending frames for the remote peers.
ProtonServerOptions	setHost(String host)
ProtonServerOptions	setIdleTimeout(int idleTimeout)
ProtonServerOptions	setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
ProtonServerOptions	setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)
ProtonServerOptions	setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)
ProtonServerOptions	setKeyStoreOptions(io.vertx.core.net.JksOptions options)
ProtonServerOptions	setLogActivity(boolean logEnabled)
ProtonServerOptions	setMaxFrameSize(int maxFrameSize) Sets the maximum frame size for connections.
ProtonServerOptions	setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)
ProtonServerOptions	setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)
ProtonServerOptions	setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)
ProtonServerOptions	setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)
ProtonServerOptions	setPfxTrustOptions(io.vertx.core.net.PfxOptions options)
ProtonServerOptions	setPort(int port)
ProtonServerOptions	setReceiveBufferSize(int receiveBufferSize)
ProtonServerOptions	setReuseAddress(boolean reuseAddress)
ProtonServerOptions	setReusePort(boolean reusePort)
ProtonServerOptions	setSendBufferSize(int sendBufferSize)
ProtonServerOptions	setSni(boolean sni)
ProtonServerOptions	setSoLinger(int soLinger)
ProtonServerOptions	setSsl(boolean ssl)
ProtonServerOptions	setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)
ProtonServerOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)
ProtonServerOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
ProtonServerOptions	setTcpCork(boolean tcpCork)
ProtonServerOptions	setTcpFastOpen(boolean tcpFastOpen)
ProtonServerOptions	setTcpKeepAlive(boolean tcpKeepAlive)
ProtonServerOptions	setTcpNoDelay(boolean tcpNoDelay)
ProtonServerOptions	setTcpQuickAck(boolean tcpQuickAck)
ProtonServerOptions	setTrafficClass(int trafficClass)
ProtonServerOptions	setTrustOptions(io.vertx.core.net.TrustOptions options)
ProtonServerOptions	setTrustStoreOptions(io.vertx.core.net.JksOptions options)
ProtonServerOptions	setUseAlpn(boolean useAlpn)
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class io.vertx.core.net.NetServerOptions

getAcceptBacklog, getClientAuth, getHost, getPort, getProxyProtocolTimeout, getProxyProtocolTimeoutUnit, getTrafficShapingOptions, isRegisterWriteHandler, isSni, isUseProxyProtocol, removeEnabledCipherSuite, setActivityLogDataFormat, setProxyProtocolTimeout, setProxyProtocolTimeoutUnit, setReadIdleTimeout, setRegisterWriteHandler, setTrafficShapingOptions, setUseProxyProtocol, setWriteIdleTimeout

Methods inherited from class io.vertx.core.net.TCPSSLOptions

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getSslOptions, getTcpKeepAliveCount, getTcpKeepAliveIdleSeconds, getTcpKeepAliveIntervalSeconds, getTcpUserTimeout, getTrustOptions, getTrustStoreOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, setTcpKeepAliveCount, setTcpKeepAliveIdleSeconds, setTcpKeepAliveIntervalSeconds, setTcpUserTimeout

Methods inherited from class io.vertx.core.net.NetworkOptions

getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtonServerOptions

public ProtonServerOptions()

ProtonServerOptions

public ProtonServerOptions(ProtonServerOptions other)

Copy constructor

Parameters:

other - the options to copy

ProtonServerOptions

public ProtonServerOptions(io.vertx.core.json.JsonObject json)

Create options from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Overrides:

toJson in class io.vertx.core.net.NetServerOptions

Returns:

the JSON

setSendBufferSize

public ProtonServerOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class io.vertx.core.net.NetServerOptions

setReceiveBufferSize

public ProtonServerOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class io.vertx.core.net.NetServerOptions

setReuseAddress

public ProtonServerOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class io.vertx.core.net.NetServerOptions

setTrafficClass

public ProtonServerOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class io.vertx.core.net.NetServerOptions

setTcpNoDelay

public ProtonServerOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class io.vertx.core.net.NetServerOptions

setTcpKeepAlive

public ProtonServerOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class io.vertx.core.net.NetServerOptions

setSoLinger

public ProtonServerOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class io.vertx.core.net.NetServerOptions

setIdleTimeout

public ProtonServerOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class io.vertx.core.net.NetServerOptions

setIdleTimeoutUnit

public ProtonServerOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Overrides:

setIdleTimeoutUnit in class io.vertx.core.net.NetServerOptions

setSsl

public ProtonServerOptions setSsl(boolean ssl)

Overrides:

setSsl in class io.vertx.core.net.NetServerOptions

setKeyStoreOptions

public ProtonServerOptions setKeyStoreOptions(io.vertx.core.net.JksOptions options)

Overrides:

setKeyStoreOptions in class io.vertx.core.net.NetServerOptions

setPfxKeyCertOptions

public ProtonServerOptions setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)

Overrides:

setPfxKeyCertOptions in class io.vertx.core.net.NetServerOptions

setPemKeyCertOptions

public ProtonServerOptions setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class io.vertx.core.net.NetServerOptions

setTrustStoreOptions

public ProtonServerOptions setTrustStoreOptions(io.vertx.core.net.JksOptions options)

Overrides:

setTrustStoreOptions in class io.vertx.core.net.NetServerOptions

setPfxTrustOptions

public ProtonServerOptions setPfxTrustOptions(io.vertx.core.net.PfxOptions options)

Overrides:

setPfxTrustOptions in class io.vertx.core.net.NetServerOptions

setPemTrustOptions

public ProtonServerOptions setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)

Overrides:

setPemTrustOptions in class io.vertx.core.net.NetServerOptions

addEnabledCipherSuite

public ProtonServerOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class io.vertx.core.net.NetServerOptions

addCrlPath

public ProtonServerOptions addCrlPath(String crlPath)
                               throws NullPointerException

Overrides:

addCrlPath in class io.vertx.core.net.NetServerOptions

Throws:

NullPointerException

addCrlValue

public ProtonServerOptions addCrlValue(io.vertx.core.buffer.Buffer crlValue)
                                throws NullPointerException

Overrides:

addCrlValue in class io.vertx.core.net.NetServerOptions

Throws:

NullPointerException

setAcceptBacklog

public ProtonServerOptions setAcceptBacklog(int acceptBacklog)

Overrides:

setAcceptBacklog in class io.vertx.core.net.NetServerOptions

setPort

public ProtonServerOptions setPort(int port)

Overrides:

setPort in class io.vertx.core.net.NetServerOptions

setHost

public ProtonServerOptions setHost(String host)

Overrides:

setHost in class io.vertx.core.net.NetServerOptions

setClientAuth

public ProtonServerOptions setClientAuth(io.vertx.core.http.ClientAuth clientAuth)

Overrides:

setClientAuth in class io.vertx.core.net.NetServerOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setUseAlpn

public ProtonServerOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class io.vertx.core.net.NetServerOptions

addEnabledSecureTransportProtocol

public ProtonServerOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class io.vertx.core.net.NetServerOptions

removeEnabledSecureTransportProtocol

public ProtonServerOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class io.vertx.core.net.NetServerOptions

setEnabledSecureTransportProtocols

public ProtonServerOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class io.vertx.core.net.NetServerOptions

setJdkSslEngineOptions

public ProtonServerOptions setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class io.vertx.core.net.NetServerOptions

setKeyCertOptions

public ProtonServerOptions setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)

Overrides:

setKeyCertOptions in class io.vertx.core.net.NetServerOptions

setOpenSslEngineOptions

public ProtonServerOptions setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class io.vertx.core.net.NetServerOptions

setSslEngineOptions

public ProtonServerOptions setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class io.vertx.core.net.NetServerOptions

setSslHandshakeTimeout

public ProtonServerOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class io.vertx.core.net.NetServerOptions

setSslHandshakeTimeoutUnit

public ProtonServerOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class io.vertx.core.net.NetServerOptions

setTrustOptions

public ProtonServerOptions setTrustOptions(io.vertx.core.net.TrustOptions options)

Overrides:

setTrustOptions in class io.vertx.core.net.NetServerOptions

setLogActivity

public ProtonServerOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class io.vertx.core.net.NetServerOptions

setSni

public ProtonServerOptions setSni(boolean sni)

Overrides:

setSni in class io.vertx.core.net.NetServerOptions

setReusePort

public ProtonServerOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class io.vertx.core.net.NetServerOptions

setTcpFastOpen

public ProtonServerOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class io.vertx.core.net.NetServerOptions

setTcpCork

public ProtonServerOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class io.vertx.core.net.NetServerOptions

setTcpQuickAck

public ProtonServerOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class io.vertx.core.net.NetServerOptions

setHeartbeat

public ProtonServerOptions setHeartbeat(int heartbeat)

Sets the heart beat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2 * heart beat, the connection is closed.

Parameters:

heartbeat - heart beat maximum delay

Returns:

current ProtonServerOptions instance

getHeartbeat

public int getHeartbeat()

Gets the heart beat (in milliseconds) as maximum delay between sending frames for the remote peers.

Returns:

heart beat maximum delay

setMaxFrameSize

public ProtonServerOptions setMaxFrameSize(int maxFrameSize)

Sets the maximum frame size for connections.

If this property is not set explicitly, a reasonable default value is used.

Setting this property to a negative value will result in no maximum frame size being announced at all.

Parameters:

maxFrameSize - The frame size in bytes.

Returns:

This instance for setter chaining.

getMaxFrameSize

public int getMaxFrameSize()

Gets the maximum frame size for connections.

If this property is not set explicitly, a reasonable default value is used.

Returns:

The frame size in bytes or -1 if no limit is set.