= Cheatsheets

[[AmqpClientOptions]]
== AmqpClientOptions

++++
Configures the AMQP Client.
You can also configure the underlying Proton instance. Refer to  for details.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[connectTimeout]]`@connectTimeout`|`Number (int)`|+++

+++
|[[connectionHostname]]`@connectionHostname`|`String`|+++
Explicitly override the hostname value used for the AMQP Open frame.

The host connected to as per link will be used in the Open frame by default.
+++
|[[containerId]]`@containerId`|`String`|+++
Sets the container id.
+++
|[[crlPaths]]`@crlPaths`|`Array of String`|+++

+++
|[[crlValues]]`@crlValues`|`Array of Buffer`|+++

+++
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|+++

+++
|[[enabledSaslMechanisms]]`@enabledSaslMechanisms`|`Array of String`|+++

+++
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|+++

+++
|[[heartbeat]]`@heartbeat`|`Number (int)`|+++

+++
|[[host]]`@host`|`String`|+++
Sets the host.
+++
|[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|+++

+++
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++

+++
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|+++

+++
|[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++

+++
|[[localAddress]]`@localAddress`|`String`|+++

+++
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[maxFrameSize]]`@maxFrameSize`|`Number (int)`|+++

+++
|[[metricsName]]`@metricsName`|`String`|-
|[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|+++

+++
|[[password]]`@password`|`String`|+++
Sets the password.
+++
|[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|+++

+++
|[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|+++

+++
|[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++

+++
|[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|+++

+++
|[[port]]`@port`|`Number (int)`|+++
Sets the port.
+++
|[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|+++

+++
|[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|+++

+++
|[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|+++

+++
|[[reuseAddress]]`@reuseAddress`|`Boolean`|+++

+++
|[[reusePort]]`@reusePort`|`Boolean`|+++

+++
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|+++

+++
|[[sniServerName]]`@sniServerName`|`String`|+++

+++
|[[soLinger]]`@soLinger`|`Number (int)`|+++

+++
|[[ssl]]`@ssl`|`Boolean`|+++

+++
|[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|-
|[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[tcpCork]]`@tcpCork`|`Boolean`|+++

+++
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|+++

+++
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|+++

+++
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|+++

+++
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|+++

+++
|[[trafficClass]]`@trafficClass`|`Number (int)`|+++

+++
|[[trustAll]]`@trustAll`|`Boolean`|+++

+++
|[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|+++

+++
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|+++

+++
|[[username]]`@username`|`String`|+++
Sets the username.
+++
|[[virtualHost]]`@virtualHost`|`String`|+++

+++
|===

[[AmqpReceiverOptions]]
== AmqpReceiverOptions

++++
Configures the AMQP Receiver.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[autoAcknowledgement]]`@autoAcknowledgement`|`Boolean`|+++
Sets the auto-acknowledgement.
When enabled (default), the messages are automatically acknowledged. If set to <code>false</code>, the messages must
be acknowledged explicitly using link, link and
link.
+++
|[[capabilities]]`@capabilities`|`Array of String`|+++
Sets the list of capabilities to be set on the receiver source terminus.
+++
|[[capabilitys]]`@capabilitys`|`Array of String`|+++
Adds a capability to be set on the receiver source terminus.
+++
|[[durable]]`@durable`|`Boolean`|+++
Sets the durability.
<p>
Passing <code>true</code> sets the expiry policy of the source to <code>NEVER</code> and the durability of the source
to <code>UNSETTLED_STATE</code>.
+++
|[[dynamic]]`@dynamic`|`Boolean`|+++
Sets whether the Source terminus to be used should specify it is 'dynamic',
requesting the peer creates a node and names it with a generated address.
<p>
The address provided by the peer can then be inspected using the
link method on the link received once opened.
+++
|[[linkName]]`@linkName`|`String`|-
|[[maxBufferedMessages]]`@maxBufferedMessages`|`Number (int)`|+++
Sets the max buffered messages. This message can be used to configure the initial credit of a receiver.
+++
|[[qos]]`@qos`|`String`|+++
Sets the local QOS config.
+++
|===

[[AmqpSenderOptions]]
== AmqpSenderOptions

++++
Configures the AMQP Sender.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[autoDrained]]`@autoDrained`|`Boolean`|+++
Sets whether the link is automatically marked drained after the send queue drain handler callback
returns if the receiving peer requested that credit be drained.
<p>
<code>true</code> by default.
+++
|[[capabilities]]`@capabilities`|`Array of String`|+++
Sets the list of capabilities to be set on the sender target terminus.
+++
|[[capabilitys]]`@capabilitys`|`Array of String`|+++
Adds a capability to be set on the sender target terminus.
+++
|[[dynamic]]`@dynamic`|`Boolean`|+++
Sets whether the Target terminus to be used should specify it is 'dynamic',
requesting the peer creates a node and names it with a generated address.
<p>
The address provided by the peer can then be inspected using the
link method on the link received once opened.
+++
|[[linkName]]`@linkName`|`String`|-
|===