ServiceBusSessionReceiver Class

Initializes a new instance of the ServiceBusSessionReceiver class for mocking.

The path of the Service Bus entity that the receiver is connected to, specific to the Service Bus namespace that contains it.

The fully qualified Service Bus namespace that the receiver is associated with. This is likely to be similar to {yournamespace}.servicebus.windows.net.

A name used to identify the receiver client. If null or empty, a random unique value will be will be used.

Indicates whether or not this ServiceBusSessionReceiver has been closed by the user, or whether the underlying session link was closed due to either losing the session lock or having the link disconnected. If this is true, the receiver cannot be used for any more operations. If this is false, it is still possible that the session lock has been lost so it is important to still handle ServiceBusException with Reason equal to SessionLockLost.

The number of messages that will be eagerly requested from Queues or Subscriptions and queued locally without regard to whether a processing is currently active, intended to help maximize throughput by allowing the receiver to receive from a local cache rather than waiting on a service request

The ReceiveMode used to specify how messages are received.

The Session Id associated with the receiver.

Gets the DateTimeOffset that the receiver's session is locked until.

Abandons a ServiceBusReceivedMessage.This will make the message available again for immediate processing as the lock on the message held by the receiver will be released.

Performs the task needed to clean up resources used by the ServiceBusReceiver.

Completes a ServiceBusReceivedMessage. This will delete the message from the service.

Moves a message to the dead-letter subqueue.

Moves a message to the dead-letter subqueue.

Moves a message to the dead-letter subqueue.

Indicates that the receiver wants to defer the processing for the message.

Deletes up to messageCount messages from the entity. The actual number of deleted messages may be less if there are fewer eligible messages in the entity.

Performs the task needed to clean up resources used by the ServiceBusReceiver. This is equivalent to calling CloseAsync(CancellationToken).

Gets the session state.

Fetches the next active ServiceBusReceivedMessage without changing the state of the receiver or the message source.

Fetches a list of active messages without changing the state of the receiver or the message source.

Attempts to purge all messages from an entity. Locked messages are not eligible for removal and will remain in the entity.

Receives a deferred message identified by sequenceNumber.

Receives a list of deferred messages identified by sequenceNumbers.

Receives a ServiceBusReceivedMessage from the entity using ReceiveMode mode. ReceiveMode defaults to PeekLock mode.

Receives messages as an asynchronous enumerable from the entity using ReceiveMode mode. ReceiveMode defaults to PeekLock mode. Messages will be received from the entity as the IAsyncEnumerable is iterated. If no messages are available, this method will continue polling until messages are available, i.e. it will never return null.

Receives a list of ServiceBusReceivedMessage from the entity using ReceiveMode mode. ReceiveMode defaults to PeekLock mode. This method doesn't guarantee to return exact maxMessages messages, even if there are maxMessages messages available in the queue or topic.

Renews the lock on the message. The lock will be renewed based on the setting specified on the queue.

Renews the lock on the session specified by the SessionId. The lock will be renewed based on the setting specified on the entity.

Set a custom state on the session which can be later retrieved using GetSessionStateAsync(CancellationToken)