AmqpClientOptions

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

Name

Type

Description

@connectTimeout

Number (int)

@containerId

String

Sets the container id.

@crlPaths

Array of String

@crlValues

Array of Buffer

@enabledCipherSuites

Array of String

@enabledSaslMechanisms

Array of String

@enabledSecureTransportProtocols

Array of String

@heartbeat

Number (int)

@host

String

Sets the host.

@hostnameVerificationAlgorithm

String

@idleTimeout

Number (int)

@idleTimeoutUnit

TimeUnit

-

@localAddress

String

@logActivity

Boolean

-

@maxFrameSize

Number (int)

@metricsName

String

-

@password

String

Sets the password.

@port

Number (int)

Sets the port.

@receiveBufferSize

Number (int)

@reconnectAttempts

Number (int)

@reconnectInterval

Number (long)

@reuseAddress

Boolean

@reusePort

Boolean

@sendBufferSize

Number (int)

@sniServerName

String

@soLinger

Number (int)

@ssl

Boolean

@sslHandshakeTimeout

Number (long)

-

@sslHandshakeTimeoutUnit

TimeUnit

-

@tcpCork

Boolean

@tcpFastOpen

Boolean

@tcpKeepAlive

Boolean

@tcpNoDelay

Boolean

@tcpQuickAck

Boolean

@trafficClass

Number (int)

@trustAll

Boolean

@useAlpn

Boolean

-

@username

String

Sets the username.

@virtualHost

String

AmqpReceiverOptions

Configures the AMQP Receiver.

Name

Type

Description

@autoAcknowledgement

Boolean

Sets the auto-acknowledgement. When enabled (default), the messages are automatically acknowledged. If set to false, the messages must be acknowledged explicitly using link, link and link.

@capabilities

Array of String

Sets the list of capabilities to be set on the receiver source terminus.

@capabilitys

Array of String

Adds a capability to be set on the receiver source terminus.

@durable

Boolean

Sets the durability.

Passing true sets the expiry policy of the source to NEVER and the durability of the source to UNSETTLED_STATE.

@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.

The address provided by the peer can then be inspected using the link method on the link received once opened.

@linkName

String

-

@maxBufferedMessages

Number (int)

Sets the max buffered messages. This message can be used to configure the initial credit of a receiver.

@qos

String

Sets the local QOS config.

AmqpSenderOptions

Configures the AMQP Sender.

Name

Type

Description

@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.

true by default.

@capabilities

Array of String

Sets the list of capabilities to be set on the sender target terminus.

@capabilitys

Array of String

Adds a capability to be set on the sender target terminus.

@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.

The address provided by the peer can then be inspected using the link method on the link received once opened.

@linkName

String

-