EventHubConsumerGroup EventHubConsumerGroup Class

Represents the consumer group within an Event Hub. This class creates receivers for a specific consumer group within an Event Hub. This can be the default consumer group or another user-created consumer group.

Syntax

Declaration

public sealed class EventHubConsumerGroup : ClientEntity, IMessageClientEntity, ICloseablePublic NotInheritable Class EventHubConsumerGroup
    Inherits ClientEntity
    Implements IMessageClientEntity, ICloseable

Inheritance Hierarchy

Fields summary

The name of the default ConsumerGroup that is pre-created when creating EventHub.

The constant that denotes the end of a stream. This can be used as an offset argument in receiver creation to start receiving from the latest event, instead of a specific point in time/offset value.

The constant that denotes the start of a stream. This can be used as an offset argument in receiver creation.

Properties summary

Gets the event hub path.

Gets the name of the consumer group.

Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from EventHubClient. The default value is 10,000.

Gets or sets the maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the SerializedSizeInBytes property.

Methods summary

Creates a new Event Hubs receiver in the specified partition. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, and the specified epoch value. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

Creates a new Event Hubs receiver in the specified partition, at the specified starting offset.

Asynchronous version of CreateReceiver(String).

Asynchronous version of CreateReceiver(String, DateTime).

Asynchronous version of CreateReceiver(String, DateTime, Int64).

Asynchronous version of CreateReceiver(String, Int64).

Asynchronous version of CreateReceiver(String, String).

Asynchronous version of CreateReceiver(String, String, Boolean).

Asynchronous version of CreateReceiver(String, String, Boolean, Int64).

Asynchronous version of CreateReceiver(String, String, Int64).

Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager).

Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions).

Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory).

Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions).

Unregisters IEventProcessor for the partition specified by PartitionId. This results in CloseAsync(PartitionContext, CloseReason) being called on the underlying event processor.

Asynchronous version of UnregisterProcessor(Lease, CloseReason).

Events summary

Fields

  • DefaultGroupName
    DefaultGroupName

    The name of the default ConsumerGroup that is pre-created when creating EventHub.

    public const string DefaultGroupName = "$Default"Public Const DefaultGroupName As String = "$Default"
  • EndOfStream
    EndOfStream

    The constant that denotes the end of a stream. This can be used as an offset argument in receiver creation to start receiving from the latest event, instead of a specific point in time/offset value.

    public const string EndOfStream = "@latest"Public Const EndOfStream As String = "@latest"
  • StartOfStream
    StartOfStream

    The constant that denotes the start of a stream. This can be used as an offset argument in receiver creation.

    public const string StartOfStream = "-1"Public Const StartOfStream As String = "-1"

Properties

  • EventHubPath
    EventHubPath

    Gets the event hub path.

    public string EventHubPath { get; }Public ReadOnly Property EventHubPath As String

    Property Value

  • GroupName
    GroupName

    Gets the name of the consumer group.

    public string GroupName { get; }Public ReadOnly Property GroupName As String

    Property Value

  • PrefetchCount
    PrefetchCount

    Gets or sets the number of events that any receive operation will actively cache. By default, this value is inherited from EventHubClient. The default value is 10,000.

    public int PrefetchCount { get; set; }Public Property PrefetchCount As Integer

    Property Value

    • The number of events that the receiver can cache.

    Exceptions

    Remarks

    Any EventHubReceiver created from this instance will inherit this value by default. Changes to this value will not be propagate to already created receiver, but will be used by new EventHubReceiver created after the change. Also setting this property to non-zero will set PrefetchSizeInBytes to null. Note that setting the count too low will affect the effective performance of the event hub receive call.

  • PrefetchSizeInBytes
    PrefetchSizeInBytes

    Gets or sets the maximum size (in bytes) in total that any receive operation will actively cache. The size of each event data is determined by the SerializedSizeInBytes property.

    public long ? PrefetchSizeInBytes { get; set; }Public Property PrefetchSizeInBytes As Long?

    Property Value

    Exceptions

    Remarks

    The size limit is not an absolute limit. the size might go over by at least one event data worth of size. Any EventHubReceiver created from this instance will inherit this value by default. Changes to this value will not be propagate to already created receiver, but will be used by new EventHubReceiver created after the change. Also, setting this property to non-null value will set PrefetchCount to zero. Note that setting the size too low will affect the effective performance of the Event Hub receive call.

Methods

  • CreateReceiver(String)
    CreateReceiver(String)

    Creates a new Event Hubs receiver in the specified partition. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId)Public Function CreateReceiver(partitionId As String) As EventHubReceiver

    Parameters

    Returns

    Exceptions

    Remarks

    If the EventHubConsumerGroup has checkpoint enabled, this overload will always throw InvalidOperationException because checkpoint enabled ConsumerGroup requires epoch to work (please use the overload that supply epoch as input argument). If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the Event Hub.

  • CreateReceiver(String, DateTime)
    CreateReceiver(String, DateTime)

    Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId, DateTime startingDateTimeUtc)Public Function CreateReceiver(partitionId As String, startingDateTimeUtc As Date) As EventHubReceiver

    Parameters

    Returns

    Exceptions

    Remarks

    Service only uses this startingDateTimeUtc as an approximation when determining next event to deliver.

    Keep in mind that there can be clock skew between client time and service time, so user application should be designed to handle duplication in event delivery.

  • CreateReceiver(String, DateTime, Int64)
    CreateReceiver(String, DateTime, Int64)

    Creates a new Event Hubs receiver in the specified partition, starting at the specified date and time. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId, DateTime startingDateTimeUtc, long epoch)Public Function CreateReceiver(partitionId As String, startingDateTimeUtc As Date, epoch As Long) As EventHubReceiver

    Parameters

    • partitionId

      The ID of the partition.

    • startingDateTimeUtc

      The starting UTC time for receiving messages.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

    Exceptions

    Remarks

    Service only uses this startingDateTimeUtc as an approximation when determining next event to deliver.

    Keep in mind that there can be clock skew between client time and service time, so user application should be designed to handle duplication in event delivery.

  • CreateReceiver(String, Int64)
    CreateReceiver(String, Int64)

    Creates a new Event Hubs receiver in the specified partition, and the specified epoch value. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId, long epoch)Public Function CreateReceiver(partitionId As String, epoch As Long) As EventHubReceiver

    Parameters

    • partitionId

      The ID of the partition.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

    Exceptions

    Remarks

    If the EventHubConsumerGroup has checkpoint enabled, then the receiver will get next message from the checkpoint offset. If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the event hub.

  • CreateReceiver(String, String)
    CreateReceiver(String, String)

    Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId, string startingOffset)Public Function CreateReceiver(partitionId As String, startingOffset As String) As EventHubReceiver

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages.

    Returns

    Exceptions

  • CreateReceiver(String, String, Boolean)
    CreateReceiver(String, String, Boolean)

    Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, bool offsetInclusive)Public Function CreateReceiver(partitionId As String, startingOffset As String, offsetInclusive As Boolean) As EventHubReceiver

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages.

    • offsetInclusive

      A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

    Returns

  • CreateReceiver(String, String, Boolean, Int64)
    CreateReceiver(String, String, Boolean, Int64)

    Creates a new Event Hubs receiver in the specified partition, at the specified starting offset. You can use the created receiver to receive events for one Event Hubs partition, specified by partitionId.

    public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, bool offsetInclusive, long epoch)Public Function CreateReceiver(partitionId As String, startingOffset As String, offsetInclusive As Boolean, epoch As Long) As EventHubReceiver

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages.

    • offsetInclusive

      A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

  • CreateReceiver(String, String, Int64)
    CreateReceiver(String, String, Int64)

    Creates a new Event Hubs receiver in the specified partition, at the specified starting offset.

    public EventHubReceiver CreateReceiver(string partitionId, string startingOffset, long epoch)Public Function CreateReceiver(partitionId As String, startingOffset As String, epoch As Long) As EventHubReceiver

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages. To specify the start of the stream, see StartOfStream.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

    Exceptions

  • CreateReceiverAsync(String)
    CreateReceiverAsync(String)

    Asynchronous version of CreateReceiver(String).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId)Public Function CreateReceiverAsync(partitionId As String) As Task(Of EventHubReceiver)

    Parameters

    Returns

    Remarks

    If the EventHubConsumerGroup has checkpoint enabled, this overload will always throw InvalidOperationException because checkpoint enabled ConsumerGroup requires epoch to work (please use the overload that supply epoch as input argument). If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the Event Hub.

  • CreateReceiverAsync(String, DateTime)
    CreateReceiverAsync(String, DateTime)

    Asynchronous version of CreateReceiver(String, DateTime).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, DateTime startingDateTimeUtc)Public Function CreateReceiverAsync(partitionId As String, startingDateTimeUtc As Date) As Task(Of EventHubReceiver)

    Parameters

    Returns

    Remarks

    Service only use this startingDateTimeUtc as an approximation when determining next event to deliver.

    Keep in mind that there can be clock skew between client time and service time, so user application should be designed to handle duplication in event delivery.

  • CreateReceiverAsync(String, DateTime, Int64)
    CreateReceiverAsync(String, DateTime, Int64)

    Asynchronous version of CreateReceiver(String, DateTime, Int64).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, DateTime startingDateTimeUtc, long epoch)Public Function CreateReceiverAsync(partitionId As String, startingDateTimeUtc As Date, epoch As Long) As Task(Of EventHubReceiver)

    Parameters

    • partitionId

      The ID of the partition.

    • startingDateTimeUtc

      The starting UTC time for receiving messages.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

    Remarks

    Service only uses this startingDateTimeUtc as an approximation when determining next event to deliver.

    Keep in mind that there can be clock skew between client time and service time, so user application should be designed to handle duplication in event delivery.

  • CreateReceiverAsync(String, Int64)
    CreateReceiverAsync(String, Int64)

    Asynchronous version of CreateReceiver(String, Int64).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, long epoch)Public Function CreateReceiverAsync(partitionId As String, epoch As Long) As Task(Of EventHubReceiver)

    Parameters

    • partitionId

      The ID of the partition.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

    Remarks

    If the EventHubConsumerGroup has checkpoint enabled, then the receiver will get next message from the checkpoint offset. If checkpoint is disabled, then receiver will get message from the start of the event stream, as determined by the message retention policy of the Event Hub.

  • CreateReceiverAsync(String, String)
    CreateReceiverAsync(String, String)

    Asynchronous version of CreateReceiver(String, String).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset)Public Function CreateReceiverAsync(partitionId As String, startingOffset As String) As Task(Of EventHubReceiver)

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages.

    Returns

  • CreateReceiverAsync(String, String, Boolean)
    CreateReceiverAsync(String, String, Boolean)

    Asynchronous version of CreateReceiver(String, String, Boolean).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, bool offsetInclusive)Public Function CreateReceiverAsync(partitionId As String, startingOffset As String, offsetInclusive As Boolean) As Task(Of EventHubReceiver)

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages.

    • offsetInclusive

      A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

    Returns

  • CreateReceiverAsync(String, String, Boolean, Int64)
    CreateReceiverAsync(String, String, Boolean, Int64)

    Asynchronous version of CreateReceiver(String, String, Boolean, Int64).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, bool offsetInclusive, long epoch)Public Function CreateReceiverAsync(partitionId As String, startingOffset As String, offsetInclusive As Boolean, epoch As Long) As Task(Of EventHubReceiver)

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages.

    • offsetInclusive

      A Boolean value that indicates whether startingOffset is treated as an inclusive offset, meaning that the first event returned is the event that contains the starting offset. Normally, the first event returned is the event after the starting offset.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

  • CreateReceiverAsync(String, String, Int64)
    CreateReceiverAsync(String, String, Int64)

    Asynchronous version of CreateReceiver(String, String, Int64).

    public Task<EventHubReceiver> CreateReceiverAsync(string partitionId, string startingOffset, long epoch)Public Function CreateReceiverAsync(partitionId As String, startingOffset As String, epoch As Long) As Task(Of EventHubReceiver)

    Parameters

    • partitionId

      The ID of the partition.

    • startingOffset

      The starting offset at which to start receiving messages. To specify the start of the stream, see StartOfStream.

    • epoch

      The epoch value. The service uses this value to enforce partition/lease ownership.

    Returns

  • OnAbort()
    OnAbort()
    protected override void OnAbort()Protected Overrides Sub OnAbort

    Overrides

  • OnBeginClose(TimeSpan, AsyncCallback, Object)
    OnBeginClose(TimeSpan, AsyncCallback, Object)
    protected override IAsyncResult OnBeginClose(TimeSpan timeout, AsyncCallback callback, object state)Protected Overrides Function OnBeginClose(timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

    Overrides

  • OnBeginOpen(TimeSpan, AsyncCallback, Object)
    OnBeginOpen(TimeSpan, AsyncCallback, Object)
    protected override IAsyncResult OnBeginOpen(TimeSpan timeout, AsyncCallback callback, object state)Protected Overrides Function OnBeginOpen(timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

    Parameters

    Returns

    Overrides

  • OnClose(TimeSpan)
    OnClose(TimeSpan)
    protected override void OnClose(TimeSpan timeout)Protected Overrides Sub OnClose(timeout As TimeSpan)

    Parameters

    Overrides

  • OnEndClose(IAsyncResult)
    OnEndClose(IAsyncResult)
    protected override void OnEndClose(IAsyncResult result)Protected Overrides Sub OnEndClose(result As IAsyncResult)

    Parameters

    Overrides

  • OnEndOpen(IAsyncResult)
    OnEndOpen(IAsyncResult)
    protected override void OnEndOpen(IAsyncResult result)Protected Overrides Sub OnEndOpen(result As IAsyncResult)

    Parameters

    Overrides

  • RegisterProcessor<T>(Lease, ICheckpointManager)
    RegisterProcessor(Of T)(Lease, ICheckpointManager)

    Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

    public void RegisterProcessor<T>(Lease lease, ICheckpointManager checkpointManager)where T : IEventProcessorPublic Sub RegisterProcessor(Of T As IEventProcessor)(lease As Lease, checkpointManager As ICheckpointManager)

    Parameters

    Remarks

    To perform more advanced IEventProcessor creation, implement an IEventProcessorFactory class which allows you to control how event processors are created.

  • RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions)
    RegisterProcessor(Of T)(Lease, ICheckpointManager, EventProcessorOptions)

    Registers an implementation of IEventProcessor in order to start consuming events from Event Hubs for the specified PartitionId starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

    public void RegisterProcessor<T>(Lease lease, ICheckpointManager checkpointManager, EventProcessorOptions processorOptions)where T : IEventProcessorPublic Sub RegisterProcessor(Of T As IEventProcessor)(lease As Lease, checkpointManager As ICheckpointManager, processorOptions As EventProcessorOptions)

    Parameters

    Remarks

    To perform more advanced IEventProcessor creation, implement an IEventProcessorFactory class which allows you to control how event processors are created.

  • RegisterProcessorAsync<T>(Lease, ICheckpointManager)
    RegisterProcessorAsync(Of T)(Lease, ICheckpointManager)

    Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager).

    public Task RegisterProcessorAsync<T>(Lease lease, ICheckpointManager checkpointManager)where T : IEventProcessorPublic Function RegisterProcessorAsync(Of T As IEventProcessor)(lease As Lease, checkpointManager As ICheckpointManager) As Task

    Parameters

    Returns

    • A task instance that represents the asynchronous operation.

  • RegisterProcessorAsync<T>(Lease, ICheckpointManager, EventProcessorOptions)
    RegisterProcessorAsync(Of T)(Lease, ICheckpointManager, EventProcessorOptions)

    Asynchronous version of RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions).

    public Task RegisterProcessorAsync<T>(Lease lease, ICheckpointManager checkpointManager, EventProcessorOptions processorOptions)where T : IEventProcessorPublic Function RegisterProcessorAsync(Of T As IEventProcessor)(lease As Lease, checkpointManager As ICheckpointManager, processorOptions As EventProcessorOptions) As Task

    Parameters

    Returns

    Remarks

    To perform more advanced IEventProcessor creation, implement an IEventProcessorFactory class which allows you to control how event processors are created.

  • RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory)
    RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory)

    Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

    public void RegisterProcessorFactory(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory)Public Sub RegisterProcessorFactory(lease As Lease, checkpointManager As ICheckpointManager, eventProcessorFactory As IEventProcessorFactory)

    Parameters

  • RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)
    RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

    Registers the IEventProcessorFactory object used to create an instance of IEventProcessor in order to start consuming events for the partition specified by PartitionId, starting from Offset. Use this overload to create an event processor that checkpoints the message offset using a custom implementation of ICheckpointManager.

    public void RegisterProcessorFactory(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory, EventProcessorOptions processorOptions)Public Sub RegisterProcessorFactory(lease As Lease, checkpointManager As ICheckpointManager, eventProcessorFactory As IEventProcessorFactory, processorOptions As EventProcessorOptions)

    Parameters

  • RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory)
    RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory)

    Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory).

    public Task RegisterProcessorFactoryAsync(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory)Public Function RegisterProcessorFactoryAsync(lease As Lease, checkpointManager As ICheckpointManager, eventProcessorFactory As IEventProcessorFactory) As Task

    Parameters

    Returns

    • A task instance that represents the asynchronous operation.

  • RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)
    RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

    Asynchronous version of RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions).

    public Task RegisterProcessorFactoryAsync(Lease lease, ICheckpointManager checkpointManager, IEventProcessorFactory eventProcessorFactory, EventProcessorOptions processorOptions)Public Function RegisterProcessorFactoryAsync(lease As Lease, checkpointManager As ICheckpointManager, eventProcessorFactory As IEventProcessorFactory, processorOptions As EventProcessorOptions) As Task

    Parameters

    Returns

  • UnregisterProcessor(Lease, CloseReason)
    UnregisterProcessor(Lease, CloseReason)

    Unregisters IEventProcessor for the partition specified by PartitionId. This results in CloseAsync(PartitionContext, CloseReason) being called on the underlying event processor.

    public void UnregisterProcessor(Lease lease, CloseReason reason)Public Sub UnregisterProcessor(lease As Lease, reason As CloseReason)

    Parameters

  • UnregisterProcessorAsync(Lease, CloseReason)
    UnregisterProcessorAsync(Lease, CloseReason)

    Asynchronous version of UnregisterProcessor(Lease, CloseReason).

    public Task UnregisterProcessorAsync(Lease lease, CloseReason reason)Public Function UnregisterProcessorAsync(lease As Lease, reason As CloseReason) As Task

    Parameters

    Returns

    • A task instance that represents the asynchronous operation.

Events

  • EventProcessorLifeCycleManagerFaulted
    EventProcessorLifeCycleManagerFaulted
    public event EventHandler<EventProcessorFaultedEventArgs> EventProcessorLifeCycleManagerFaultedPublic Event EventProcessorLifeCycleManagerFaulted As EventHandler(Of EventProcessorFaultedEventArgs)

Details

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll