SessionManagerOptions | @azure/service-bus

internal: Describes the options for creating a Session Manager.

Hierarchy

SessionMessageHandlerOptions
- SessionManagerOptions

Index

Properties

Optional autoComplete

autoComplete: undefined | false | true

property

Indicates whether the complete() method on the message should automatically be called by the sdk after the user provided onMessage handler has been executed. Calling complete() on a message removes it from the Queue/Subscription.

Default: true.

Optional maxConcurrentCalls

maxConcurrentCalls: undefined | number

property

The maximum number of concurrent calls that the library can make to the user's message handler. Once this limit has been reached, more messages will not be received until atleast one of the calls to the user's message handler has completed.

Default: 1.

Optional maxConcurrentSessions

maxConcurrentSessions: undefined | number

property

{number} [maxConcurrentSessions] The maximum number of sessions that the user wants to handle concurrently.

Default: 2000.

Optional newMessageWaitTimeoutInMs

newMessageWaitTimeoutInMs: undefined | number

property

The maximum amount of time the receiver will wait to receive a new message. If no new message is received in this time, then the receiver will be closed.

If this option is not provided, then receiver link will stay open until manually closed.

Caution: When setting this value, take into account the time taken to process messages. Once the receiver is closed, operations like complete()/abandon()/defer()/deadletter() cannot be invoked on messages.