EventProcessorHost Constructors

Definition

Namespace:

Microsoft.Azure.EventHubs.Processor

Assembly:

Microsoft.Azure.EventHubs.Processor.dll

Package:

Microsoft.Azure.EventHubs.Processor v4.3.2

Overloads

EventProcessorHost(String, String, String, String, String)	Create a new host to process events from an Event Hub. Since Event Hubs are frequently used for scale-out, high-traffic scenarios, generally there will be only one host per process, and the processes will be run on separate machines. However, it is supported to run multiple hosts on one machine, or even within one process, if throughput is not a concern. This overload of the constructor uses the default, built-in lease and checkpoint managers. The Azure Storage account specified by the storageConnectionString parameter is used by the built-in managers to record leases and checkpoints.
EventProcessorHost(String, String, String, String, ICheckpointManager, ILeaseManager)	Create a new host to process events from an Event Hub. This overload of the constructor allows maximum flexibility. This one allows the caller to specify the name of the processor host as well. The overload also allows the caller to provide their own lease and checkpoint managers to replace the built-in ones based on Azure Storage.
EventProcessorHost(Uri, String, String, ITokenProvider, CloudStorageAccount, String)	Create a new host to process events from an Event Hub with provided TokenProvider
EventProcessorHost(String, String, String, String, String, String, String)	Create a new host to process events from an Event Hub. This overload of the constructor uses the default, built-in lease and checkpoint managers.
EventProcessorHost(String, Uri, String, String, ITokenProvider, ICheckpointManager, ILeaseManager, Nullable<TimeSpan>, TransportType)	Create a new host to process events from an Event Hub with provided TokenProvider
EventProcessorHost(Uri, String, String, ITokenProvider, CloudStorageAccount, String, String, Nullable<TimeSpan>, TransportType)	Create a new host to process events from an Event Hub with provided TokenProvider
EventProcessorHost(String, Uri, String, String, ITokenProvider, CloudStorageAccount, String, String, Nullable<TimeSpan>, TransportType)	Create a new host to process events from an Event Hub with provided TokenProvider

EventProcessorHost(String, String, String, String, String)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub.

Since Event Hubs are frequently used for scale-out, high-traffic scenarios, generally there will be only one host per process, and the processes will be run on separate machines. However, it is supported to run multiple hosts on one machine, or even within one process, if throughput is not a concern.

This overload of the constructor uses the default, built-in lease and checkpoint managers. The Azure Storage account specified by the storageConnectionString parameter is used by the built-in managers to record leases and checkpoints.

public EventProcessorHost (string eventHubPath, string consumerGroupName, string eventHubConnectionString, string storageConnectionString, string leaseContainerName);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : string * string * string * string * string -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (eventHubPath As String, consumerGroupName As String, eventHubConnectionString As String, storageConnectionString As String, leaseContainerName As String)

Parameters

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

eventHubConnectionString

String

Connection string for the Event Hub to receive from.

storageConnectionString

String

Connection string to Azure Storage account used for leases and checkpointing.

leaseContainerName

String

Azure Storage container name for use by built-in lease and checkpoint manager.

EventProcessorHost(String, String, String, String, ICheckpointManager, ILeaseManager)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub.

This overload of the constructor allows maximum flexibility. This one allows the caller to specify the name of the processor host as well. The overload also allows the caller to provide their own lease and checkpoint managers to replace the built-in ones based on Azure Storage.

public EventProcessorHost (string hostName, string eventHubPath, string consumerGroupName, string eventHubConnectionString, Microsoft.Azure.EventHubs.Processor.ICheckpointManager checkpointManager, Microsoft.Azure.EventHubs.Processor.ILeaseManager leaseManager);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : string * string * string * string * Microsoft.Azure.EventHubs.Processor.ICheckpointManager * Microsoft.Azure.EventHubs.Processor.ILeaseManager -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (hostName As String, eventHubPath As String, consumerGroupName As String, eventHubConnectionString As String, checkpointManager As ICheckpointManager, leaseManager As ILeaseManager)

Parameters

hostName

String

Name of the processor host. MUST BE UNIQUE. Strongly recommend including a Guid to ensure uniqueness.

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

eventHubConnectionString

String

Connection string for the Event Hub to receive from.

checkpointManager

ICheckpointManager

Object implementing ICheckpointManager which handles partition checkpointing.

leaseManager

ILeaseManager

Object implementing ILeaseManager which handles leases for partitions.

EventProcessorHost(Uri, String, String, ITokenProvider, CloudStorageAccount, String)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub with provided TokenProvider

public EventProcessorHost (Uri endpointAddress, string eventHubPath, string consumerGroupName, Microsoft.Azure.EventHubs.ITokenProvider tokenProvider, Microsoft.Azure.Storage.CloudStorageAccount cloudStorageAccount, string leaseContainerName);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : Uri * string * string * Microsoft.Azure.EventHubs.ITokenProvider * Microsoft.Azure.Storage.CloudStorageAccount * string -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (endpointAddress As Uri, eventHubPath As String, consumerGroupName As String, tokenProvider As ITokenProvider, cloudStorageAccount As CloudStorageAccount, leaseContainerName As String)

Parameters

endpointAddress

Uri

Fully qualified domain name for Event Hubs. Most likely, {yournamespace}.servicebus.windows.net

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

tokenProvider

ITokenProvider

Token provider which will generate security tokens for authorization.

cloudStorageAccount

CloudStorageAccount

Azure Storage account used for leases and checkpointing.

leaseContainerName

String

Azure Storage container name for use by built-in lease and checkpoint manager.

EventProcessorHost(String, String, String, String, String, String, String)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub.

This overload of the constructor uses the default, built-in lease and checkpoint managers.

public EventProcessorHost (string hostName, string eventHubPath, string consumerGroupName, string eventHubConnectionString, string storageConnectionString, string leaseContainerName, string storageBlobPrefix = default);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : string * string * string * string * string * string * string -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (hostName As String, eventHubPath As String, consumerGroupName As String, eventHubConnectionString As String, storageConnectionString As String, leaseContainerName As String, Optional storageBlobPrefix As String = Nothing)

Parameters

hostName

String

Name of the processor host. MUST BE UNIQUE. Strongly recommend including a Guid to ensure uniqueness.

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

eventHubConnectionString

String

Connection string for the Event Hub to receive from.

storageConnectionString

String

Connection string to Azure Storage account used for leases and checkpointing.

leaseContainerName

String

Azure Storage container name for use by built-in lease and checkpoint manager.

storageBlobPrefix

String

Prefix used when naming blobs within the storage container.

EventProcessorHost(String, Uri, String, String, ITokenProvider, ICheckpointManager, ILeaseManager, Nullable<TimeSpan>, TransportType)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub with provided TokenProvider

public EventProcessorHost (string hostName, Uri endpointAddress, string eventHubPath, string consumerGroupName, Microsoft.Azure.EventHubs.ITokenProvider tokenProvider, Microsoft.Azure.EventHubs.Processor.ICheckpointManager checkpointManager, Microsoft.Azure.EventHubs.Processor.ILeaseManager leaseManager, TimeSpan? operationTimeout = default, Microsoft.Azure.EventHubs.TransportType transportType = Microsoft.Azure.EventHubs.TransportType.Amqp);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : string * Uri * string * string * Microsoft.Azure.EventHubs.ITokenProvider * Microsoft.Azure.EventHubs.Processor.ICheckpointManager * Microsoft.Azure.EventHubs.Processor.ILeaseManager * Nullable<TimeSpan> * Microsoft.Azure.EventHubs.TransportType -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (hostName As String, endpointAddress As Uri, eventHubPath As String, consumerGroupName As String, tokenProvider As ITokenProvider, checkpointManager As ICheckpointManager, leaseManager As ILeaseManager, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.Azure.EventHubs.TransportType.Amqp)

Parameters

hostName

String

Name of the processor host. MUST BE UNIQUE. Strongly recommend including a Guid to ensure uniqueness.

endpointAddress

Uri

Fully qualified domain name for Event Hubs. Most likely, {yournamespace}.servicebus.windows.net

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

tokenProvider

ITokenProvider

Token provider which will generate security tokens for authorization.

checkpointManager

ICheckpointManager

Object implementing ICheckpointManager which handles partition checkpointing.

leaseManager

ILeaseManager

Object implementing ILeaseManager which handles leases for partitions.

operationTimeout

Nullable<TimeSpan>

Operation timeout for Event Hubs operations.

transportType

TransportType

Transport type on connection.

EventProcessorHost(Uri, String, String, ITokenProvider, CloudStorageAccount, String, String, Nullable<TimeSpan>, TransportType)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub with provided TokenProvider

public EventProcessorHost (Uri endpointAddress, string eventHubPath, string consumerGroupName, Microsoft.Azure.EventHubs.ITokenProvider tokenProvider, Microsoft.Azure.Storage.CloudStorageAccount cloudStorageAccount, string leaseContainerName, string storageBlobPrefix = default, TimeSpan? operationTimeout = default, Microsoft.Azure.EventHubs.TransportType transportType = Microsoft.Azure.EventHubs.TransportType.Amqp);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : Uri * string * string * Microsoft.Azure.EventHubs.ITokenProvider * Microsoft.Azure.Storage.CloudStorageAccount * string * string * Nullable<TimeSpan> * Microsoft.Azure.EventHubs.TransportType -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (endpointAddress As Uri, eventHubPath As String, consumerGroupName As String, tokenProvider As ITokenProvider, cloudStorageAccount As CloudStorageAccount, leaseContainerName As String, Optional storageBlobPrefix As String = Nothing, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.Azure.EventHubs.TransportType.Amqp)

Parameters

endpointAddress

Uri

Fully qualified domain name for Event Hubs. Most likely, {yournamespace}.servicebus.windows.net

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

tokenProvider

ITokenProvider

Token provider which will generate security tokens for authorization.

cloudStorageAccount

CloudStorageAccount

Azure Storage account used for leases and checkpointing.

leaseContainerName

String

Azure Storage container name for use by built-in lease and checkpoint manager.

storageBlobPrefix

String

Prefix used when naming blobs within the storage container.

operationTimeout

Nullable<TimeSpan>

Operation timeout for Event Hubs operations.

transportType

TransportType

Transport type on connection.

EventProcessorHost(String, Uri, String, String, ITokenProvider, CloudStorageAccount, String, String, Nullable<TimeSpan>, TransportType)

Source:

EventProcessorHost.cs

Create a new host to process events from an Event Hub with provided TokenProvider

public EventProcessorHost (string hostName, Uri endpointAddress, string eventHubPath, string consumerGroupName, Microsoft.Azure.EventHubs.ITokenProvider tokenProvider, Microsoft.Azure.Storage.CloudStorageAccount cloudStorageAccount, string leaseContainerName, string storageBlobPrefix = default, TimeSpan? operationTimeout = default, Microsoft.Azure.EventHubs.TransportType transportType = Microsoft.Azure.EventHubs.TransportType.Amqp);

new Microsoft.Azure.EventHubs.Processor.EventProcessorHost : string * Uri * string * string * Microsoft.Azure.EventHubs.ITokenProvider * Microsoft.Azure.Storage.CloudStorageAccount * string * string * Nullable<TimeSpan> * Microsoft.Azure.EventHubs.TransportType -> Microsoft.Azure.EventHubs.Processor.EventProcessorHost

Public Sub New (hostName As String, endpointAddress As Uri, eventHubPath As String, consumerGroupName As String, tokenProvider As ITokenProvider, cloudStorageAccount As CloudStorageAccount, leaseContainerName As String, Optional storageBlobPrefix As String = Nothing, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.Azure.EventHubs.TransportType.Amqp)

Parameters

hostName

String

Name of the processor host. MUST BE UNIQUE. Strongly recommend including a Guid to ensure uniqueness.

endpointAddress

Uri

Fully qualified domain name for Event Hubs. Most likely, {yournamespace}.servicebus.windows.net

eventHubPath

String

The name of the EventHub.

consumerGroupName

String

The name of the consumer group within the Event Hub.

tokenProvider

ITokenProvider

Token provider which will generate security tokens for authorization.

cloudStorageAccount

CloudStorageAccount

Azure Storage account used for leases and checkpointing.

leaseContainerName

String

Azure Storage container name for use by built-in lease and checkpoint manager.

storageBlobPrefix

String

Prefix used when naming blobs within the storage container.

operationTimeout

Nullable<TimeSpan>

Operation timeout for Event Hubs operations.

transportType

TransportType

Transport type on connection.