Shuttle.Hopper.AzureEventHubs 21.0.0-alpha

Prefix Reserved

This is a prerelease version of Shuttle.Hopper.AzureEventHubs.

dotnet add package Shuttle.Hopper.AzureEventHubs --version 21.0.0-alpha

NuGet\Install-Package Shuttle.Hopper.AzureEventHubs -Version 21.0.0-alpha

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Shuttle.Hopper.AzureEventHubs" Version="21.0.0-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Shuttle.Hopper.AzureEventHubs" Version="21.0.0-alpha" />
                    

                            Directory.Packages.props

<PackageReference Include="Shuttle.Hopper.AzureEventHubs" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Shuttle.Hopper.AzureEventHubs --version 21.0.0-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Shuttle.Hopper.AzureEventHubs, 21.0.0-alpha"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Shuttle.Hopper.AzureEventHubs@21.0.0-alpha

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Shuttle.Hopper.AzureEventHubs&version=21.0.0-alpha&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Shuttle.Hopper.AzureEventHubs&version=21.0.0-alpha&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

AzureEventHubs

PM> Install-Package Shuttle.Hopper.AzureEventHubs

Configuration

The URI structure is azureeh://configuration-name/queue-name.

services.AddAzureEventHubs(builder =>
{
    var eventHubQueueOptions = new EventHubQueueOptions
    {
        ConnectionString = "UseDevelopmentStorage=true",
        ProcessEvents = false,
        ConsumerGroup = EventHubConsumerClient.DefaultConsumerGroupName,
        BlobStorageConnectionString = "{BlobStorageConnectionString}",
        BlobContainerName = "{BlobContainerName}",
        OperationTimeout = TimeSpan.FromSeconds(30),
        ConsumeTimeout = TimeSpan.FromSeconds(30),
        DefaultStartingPosition = EventPosition.Latest
    };

    eventHubQueueOptions.ConfigureProducer += (sender, args) =>
    {
        Console.WriteLine($"[event] : ConfigureProducer / Uri = '{((IQueue)sender).Uri}'");
    };

    eventHubQueueOptions.ConfigureBlobStorage += (sender, args) =>
    {
        Console.WriteLine($"[event] : ConfigureBlobStorage / Uri = '{((IQueue)sender).Uri}'");
    };

    eventHubQueueOptions.ConfigureConsumer += (sender, args) =>
    {
        Console.WriteLine($"[event] : ConfigureConsumer / Uri = '{((IQueue)sender).Uri}'");
    };

    builder.AddOptions("azure", eventHubQueueOptions);
});

In the Configure events the args arugment exposes the relevant client options directly should you need to set an values explicitly.

The default JSON settings structure is as follows:

{
  "Shuttle": {
    "AzureEventHubs": {
      "azure": {
        "ConnectionString": "UseDevelopmentStorage=true",
        "ProcessEvents": false,
        "ConsumerGroup": "$Default",
        "BlobStorageConnectionString": "{BlobStorageConnectionString}",
        "BlobContainerName": "{BlobContainerName}",
        "OperationTimeout": "00:00:30",
        "ConsumeTimeout": "00:00:30",
        "DefaultStartingPosition": "Latest"
      }
    }
  }
}

Options

Segment / Argument	Default	Description
`ConnectionString`		The Azure Event Hubs endpoint to connect to.
`ProcessEvents`	`false`	Indicates whether the endpoint will process messages. If `true`, an `EventProcessorClient` is instanced and configured.
`ConsumerGroup`	"$Default"	The consumer group to use when processing events.
`BlobStorageConnectionString`		The Azure Storage Account endpoint to connect to in order to perform checkpoints.
`BlobContainerName`		The blob container name where checkpoints will be stored.
`OperationTimeout`	"00:00:30"	The duration to wait for relevant `async` methods to complete before timing out.
`ConsumeTimeout`	"00:00:30"	The duration to poll for messages before returning `null`.
`DefaultStartingPosition`		The default starting position to use when no checkpoint exists.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Azure.Messaging.EventHubs (>= 5.12.2)
- Azure.Messaging.EventHubs.Processor (>= 5.12.2)
- Shuttle.Hopper (>= 21.0.0-alpha)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.