DotPulsar .NET Client for Apache Pulsar

DotPulsar targets .NET Standard 2.0 to ensure broad compatibility across different .NET runtimes.

By targeting .NET Standard 2.0, DotPulsar can be used in:

• .NET Framework applications (version 4.6.2 and up).
• .NET Core and modern .NET (5, 6, 7, 8+) applications.

Note that while .NET Standard 2.1 is a newer version, it is not supported by .NET Framework, so DotPulsar uses 2.0 to maintain support for legacy Windows-based software.

DotPulsar is designed to be compatible with both Visual Studio and JetBrains Rider. To ensure consistent code formatting and warning behavior across these different IDEs, the project uses a .editorconfig file and *.DotSettings files.

When working on the codebase, you should use these configuration files to ensure that your IDE's auto-formatting and warning settings align with the project standards. This prevents conflicts when multiple developers use different IDEs.

To automatically enforce the DotPulsar coding style on file save using ReSharper in Visual Studio:

1. Navigate to Extensions > ReSharper > Options...
2. Under Code Editing, select Code Cleanup and click General.
3. Check the option: Automatically run cleanup when saving a file (not supported for shared/linked files).
4. Navigate to Profiles and ensure the DotPulsar: Full Cleanup profile is selected as the default.
5. Click Save.

To enable automatic code style enforcement on file save using native Visual Studio features:

1. Navigate to Tools > Options...
2. Expand Text Editor and select Code Cleanup.
3. Check the box: Run Code Cleanup profile on Save.
4. Click OK.

To ensure your IDE is correctly applying the project's formatting and cleanup rules, perform a solution-wide cleanup. The end result should be identical regardless of whether you use Visual Studio or Rider.

In Visual Studio: Open the solution and run a solution-wide "Analyze and Code Cleanup".

In Rider: Open the solution and run "Reformat and Cleanup".

To use DotPulsar in your .NET project, install the official NuGet package. This library is a pure C# implementation of the Apache Pulsar binary protocol.

# Use your preferred NuGet client to install DotPulsar
dotnet add package DotPulsar

To ensure code consistency when committing changes in Rider, configure the commit process to use the project's specific cleanup profile:

1. Open the Commit window.
2. Click the gear icon (settings).
3. Ensure that only the Cleanup 'DotPulsar: Full Cleanup' profile is checked. You may leave Check TODO enabled or disabled based on your preference.

// No code snippet available for this setup task

To interact with Apache Pulsar, you must first instantiate a PulsarClient using the PulsarClient.Builder. By default, calling .Build() without additional configuration attempts to connect to pulsar://localhost:6650.

using DotPulsar;
using DotPulsar.Extensions;

await using var client = PulsarClient.Builder().Build();

You can consume messages by creating a consumer from the client. You must specify a Schema, a SubscriptionName, and a Topic. You can also set the InitialPosition (e.g., SubscriptionInitialPosition.Earliest).

Messages are retrieved by iterating over the consumer.Messages() stream. After processing a message, you should call consumer.Acknowledge(message) to confirm receipt.

await using var consumer = client.NewConsumer(Schema.String)
    .SubscriptionName("MySubscription")
    .Topic("persistent://public/default/mytopic")
    .InitialPosition(SubscriptionInitialPosition.Earliest)
    .Create();

await foreach (var message in consumer.Messages())
{
    Console.WriteLine($"Received: {message.Value()}");
    await consumer.Acknowledge(message);
}

To send data, create a producer using client.NewProducer(Schema). You must specify the target Topic. The Send method returns a messageId upon successful delivery.

await using var producer = client.NewProducer(Schema.String)
    .Topic("persistent://public/default/mytopic")
    .Create();

var messageId = await producer.Send("Hello World");