ProtonClientOptions

Options for configuring link connect operations.

Name

Type

Description

@connectTimeout

Number (int)

-

@crlPaths

Array of String

-

@crlValues

Array of Buffer

-

@enabledCipherSuites

Array of String

-

@enabledSaslMechanisms

Array of String

Adds a mechanism name that the client may use during SASL negotiation.

@enabledSecureTransportProtocols

Array of String

-

@heartbeat

Number (int)

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

@hostnameVerificationAlgorithm

String

-

@idleTimeout

Number (int)

-

@idleTimeoutUnit

TimeUnit

-

@jdkSslEngineOptions

JdkSSLEngineOptions

-

@keyStoreOptions

JksOptions

-

@localAddress

String

-

@logActivity

Boolean

-

@maxFrameSize

Number (int)

Sets the maximum frame size for the connection.

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.

@metricsName

String

-

@openSslEngineOptions

OpenSSLEngineOptions

-

@pemKeyCertOptions

PemKeyCertOptions

-

@pemTrustOptions

PemTrustOptions

-

@pfxKeyCertOptions

PfxOptions

-

@pfxTrustOptions

PfxOptions

-

@proxyOptions

ProxyOptions

-

@receiveBufferSize

Number (int)

-

@reconnectAttempts

Number (int)

-

@reconnectInterval

Number (long)

-

@reuseAddress

Boolean

-

@reusePort

Boolean

-

@sendBufferSize

Number (int)

-

@sniServerName

String

Explicitly override the hostname to use for the TLS SNI server name.

If neither the link or SNI server name is explicitly overridden, the hostname specified in link will be used, with SNI performed implicitly where a FQDN was specified.

This method should typically only be needed to set different values for the [virtual] hostname and SNI server name.

@soLinger

Number (int)

-

@ssl

Boolean

-

@tcpCork

Boolean

-

@tcpFastOpen

Boolean

-

@tcpKeepAlive

Boolean

-

@tcpNoDelay

Boolean

-

@tcpQuickAck

Boolean

-

@trafficClass

Number (int)

-

@trustAll

Boolean

-

@trustStoreOptions

JksOptions

-

@useAlpn

Boolean

-

@usePooledBuffers

Boolean

-

@virtualHost

String

Override the hostname value used in the connection AMQP Open frame and TLS SNI server name (if TLS is in use). By default, the hostname specified in link will be used for both, with SNI performed implicit where a FQDN was specified.

The SNI server name can also be overridden explicitly using link.

ProtonLinkOptions

Options for configuring link attributes.

Name

Type

Description

@dynamic

Boolean

Sets whether the link remote terminus to be used should indicate it is 'dynamic', requesting the peer names it with a dynamic address. The address provided by the peer can then be inspected using link (or inspecting the remote terminus details directly) after the link has remotely opened.

@linkName

String

-

ProtonServerOptions

Options for configuring link creation.

Name

Type

Description

@acceptBacklog

Number (int)

-

@clientAuth

ClientAuth

-

@clientAuthRequired

Boolean

-

@crlPaths

Array of String

-

@crlValues

Array of Buffer

-

@enabledCipherSuites

Array of String

-

@enabledSecureTransportProtocols

Array of String

-

@heartbeat

Number (int)

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.

@host

String

-

@idleTimeout

Number (int)

-

@idleTimeoutUnit

TimeUnit

-

@jdkSslEngineOptions

JdkSSLEngineOptions

-

@keyStoreOptions

JksOptions

-

@logActivity

Boolean

-

@maxFrameSize

Number (int)

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.

@openSslEngineOptions

OpenSSLEngineOptions

-

@pemKeyCertOptions

PemKeyCertOptions

-

@pemTrustOptions

PemTrustOptions

-

@pfxKeyCertOptions

PfxOptions

-

@pfxTrustOptions

PfxOptions

-

@port

Number (int)

-

@receiveBufferSize

Number (int)

-

@reuseAddress

Boolean

-

@reusePort

Boolean

-

@sendBufferSize

Number (int)

-

@sni

Boolean

-

@soLinger

Number (int)

-

@ssl

Boolean

-

@tcpCork

Boolean

-

@tcpFastOpen

Boolean

-

@tcpKeepAlive

Boolean

-

@tcpNoDelay

Boolean

-

@tcpQuickAck

Boolean

-

@trafficClass

Number (int)

-

@trustStoreOptions

JksOptions

-

@useAlpn

Boolean

-

@usePooledBuffers

Boolean

-

ProtonTransportOptions

Options for configuring transport layer

Name

Type

Description

@heartbeat

Number (int)

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

@maxFrameSize

Number (int)

Sets the maximum frame size for the connection.

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.