Class EventProcessorOptions

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Defines the runtime options when registering an IEventProcessor interface with an EventHubConsumerGroup. This is also the mechanism for catching exceptions from an IEventProcessor instance used by an Microsoft.ServiceBus.Messaging.EventProcessorHost object.

public class EventProcessorOptions

Inheritance

object

EventProcessorOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventProcessorOptions()

public EventProcessorOptions()

Properties

DefaultOptions

Gets the default options, which is 10 for the MaxBatchSize, and 1 minute for the ReceiveTimeOut property.

public static EventProcessorOptions DefaultOptions { get; }

Property Value

EventProcessorOptions

Returns EventProcessorOptions.

InitialOffsetProvider

Gets or sets the initial offset for the event processor.

public Func<string, object> InitialOffsetProvider { get; set; }

Property Value

Func<string, object>

Returns Func<T, TResult>.

InvokeProcessorAfterReceiveTimeout

public bool InvokeProcessorAfterReceiveTimeout { get; set; }

Property Value

bool

Returns bool.

MaxBatchSize

Gets or sets the maximum event count that a user is willing to accept for processing per receive loop. This count is on a per-Event Hub partition level.

public int MaxBatchSize { get; set; }

Property Value

int

Returns int.

PrefetchCount

Gets or sets the number of events that any receiver in the currently owned partition will actively cache. The default value for this property is 300.

public int PrefetchCount { get; set; }

Property Value

int

Returns int.

ReceiveTimeOut

Gets or sets the timespan in which the user is willing to wait when the event processor is performing a receive operation.

public TimeSpan ReceiveTimeOut { get; set; }

Property Value

TimeSpan

Returns TimeSpan.

Events

ExceptionReceived

Event that fires when an exception is encountered during event processing. You can register a handler to this event for getting the exception notification.

public event EventHandler<ExceptionReceivedEventArgs> ExceptionReceived

Event Type

EventHandler<ExceptionReceivedEventArgs>