ServiceBusSessionReceiverOptions Class

  • Reference

Definition

Namespace:
Azure.Messaging.ServiceBus
Assembly:
Azure.Messaging.ServiceBus.dll
Package:
Azure.Messaging.ServiceBus v7.18.2
Package:
Azure.Messaging.ServiceBus v7.18.0-beta.1
Source:
ServiceBusSessionReceiverOptions.cs
Source:
ServiceBusSessionReceiverOptions.cs

The set of options that can be specified when creating a ServiceBusSessionReceiver to configure its behavior.

public class ServiceBusSessionReceiverOptions
type ServiceBusSessionReceiverOptions = class
Public Class ServiceBusSessionReceiverOptions
Inheritance
Object
ServiceBusSessionReceiverOptions

Constructors

ServiceBusSessionReceiverOptions()

Properties

Identifier

A property used to set the ServiceBusReceiver ID to identify the client. This can be used to correlate logs and exceptions. If null or empty, a random unique value will be used.
PrefetchCount

Gets or sets the number of messages that will be eagerly requested from Queues or Subscriptions and queued locally without regard to whether the receiver is actively receiving, intended to help maximize throughput by allowing the receiver to receive from a local cache rather than waiting on a service request.
ReceiveMode

Gets or sets the ReceiveMode used to specify how messages are received. Defaults to PeekLock mode.

Applies to