-
Notifications
You must be signed in to change notification settings - Fork 876
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
47 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,41 +43,41 @@ confluent-kafka-dotnet is distributed via NuGet. We provide five packages: | |
To install Confluent.Kafka from within Visual Studio, search for Confluent.Kafka in the NuGet Package Manager UI, or run the following command in the Package Manager Console: | ||
|
||
``` | ||
Install-Package Confluent.Kafka -Version 2.3.0-RC3 | ||
Install-Package Confluent.Kafka -Version 2.3.0-RC4 | ||
``` | ||
|
||
To add a reference to a dotnet core project, execute the following at the command line: | ||
|
||
``` | ||
dotnet add package -v 2.3.0-RC3 Confluent.Kafka | ||
dotnet add package -v 2.3.0-RC4 Confluent.Kafka | ||
``` | ||
|
||
Note: `Confluent.Kafka` depends on the `librdkafka.redist` package which provides a number of different builds of `librdkafka` that are compatible with [common platforms](https://github.com/edenhill/librdkafka/wiki/librdkafka.redist-NuGet-package-runtime-libraries). If you are on one of these platforms this will all work seamlessly (and you don't need to explicitly reference `librdkafka.redist`). If you are on a different platform, you may need to [build librdkafka](https://github.com/edenhill/librdkafka#building) manually (or acquire it via other means) and load it using the [Library.Load](https://docs.confluent.io/current/clients/confluent-kafka-dotnet/api/Confluent.Kafka.Library.html#Confluent_Kafka_Library_Load_System_String_) method. | ||
|
||
### Branch builds | ||
|
||
Nuget packages corresponding to all commits to release branches are available from the following nuget package source (Note: this is not a web URL - you | ||
Nuget packages corresponding to all commits to release branches are available from the following nuget package source (Note: this is not a web URL - you | ||
should specify it in the nuget package manager): | ||
[https://ci.appveyor.com/nuget/confluent-kafka-dotnet](https://ci.appveyor.com/nuget/confluent-kafka-dotnet). The version suffix of these nuget packages | ||
matches the appveyor build number. You can see which commit a particular build number corresponds to by looking at the | ||
[https://ci.appveyor.com/nuget/confluent-kafka-dotnet](https://ci.appveyor.com/nuget/confluent-kafka-dotnet). The version suffix of these nuget packages | ||
matches the appveyor build number. You can see which commit a particular build number corresponds to by looking at the | ||
[AppVeyor build history](https://ci.appveyor.com/project/ConfluentClientEngineering/confluent-kafka-dotnet/history) | ||
|
||
|
||
## Usage | ||
|
||
For a step-by-step guide and code samples, see [Getting Started with Apache Kafka and .NET](https://developer.confluent.io/get-started/dotnet/) on [Confluent Developer](https://developer.confluent.io/). | ||
For a step-by-step guide and code samples, see [Getting Started with Apache Kafka and .NET](https://developer.confluent.io/get-started/dotnet/) on [Confluent Developer](https://developer.confluent.io/). | ||
|
||
You can also take the free self-paced training course [Apache Kafka for .NET Developers](https://developer.confluent.io/learn-kafka/apache-kafka-for-dotnet/) on [Confluent Developer](https://developer.confluent.io/). | ||
You can also take the free self-paced training course [Apache Kafka for .NET Developers](https://developer.confluent.io/learn-kafka/apache-kafka-for-dotnet/) on [Confluent Developer](https://developer.confluent.io/). | ||
|
||
Take a look in the [examples](examples) directory and at the [integration tests](test/Confluent.Kafka.IntegrationTests/Tests) for further examples. | ||
Take a look in the [examples](examples) directory and at the [integration tests](test/Confluent.Kafka.IntegrationTests/Tests) for further examples. | ||
|
||
For an overview of configuration properties, refer to the [librdkafka documentation](https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md). | ||
For an overview of configuration properties, refer to the [librdkafka documentation](https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md). | ||
|
||
### Basic Producer Examples | ||
|
||
You should use the `ProduceAsync` method if you would like to wait for the result of your produce | ||
requests before proceeding. You might typically want to do this in highly concurrent scenarios, | ||
for example in the context of handling web requests. Behind the scenes, the client will manage | ||
for example in the context of handling web requests. Behind the scenes, the client will manage | ||
optimizing communication with the Kafka brokers for you, batching requests as appropriate. | ||
|
||
```csharp | ||
|
@@ -111,8 +111,8 @@ class Program | |
``` | ||
|
||
Note that a server round-trip is slow (3ms at a minimum; actual latency depends on many factors). | ||
In highly concurrent scenarios you will achieve high overall throughput out of the producer using | ||
the above approach, but there will be a delay on each `await` call. In stream processing | ||
In highly concurrent scenarios you will achieve high overall throughput out of the producer using | ||
the above approach, but there will be a delay on each `await` call. In stream processing | ||
applications, where you would like to process many messages in rapid succession, you would typically | ||
use the `Produce` method instead: | ||
|
||
|
@@ -126,7 +126,7 @@ class Program | |
{ | ||
var conf = new ProducerConfig { BootstrapServers = "localhost:9092" }; | ||
|
||
Action<DeliveryReport<Null, string>> handler = r => | ||
Action<DeliveryReport<Null, string>> handler = r => | ||
Console.WriteLine(!r.Error.IsError | ||
? $"Delivered message to {r.TopicPartitionOffset}" | ||
: $"Delivery Error: {r.Error.Reason}"); | ||
|
@@ -157,7 +157,7 @@ class Program | |
public static void Main(string[] args) | ||
{ | ||
var conf = new ConsumerConfig | ||
{ | ||
{ | ||
GroupId = "test-consumer-group", | ||
BootstrapServers = "localhost:9092", | ||
// Note: The AutoOffsetReset property determines the start offset in the event | ||
|
@@ -258,7 +258,7 @@ to integrate with Kafka. For more information, refer to the [3rd Party Libraries | |
|
||
### Confluent Cloud | ||
|
||
For a step-by-step guide on using the .NET client with Confluent Cloud see [Getting Started with Apache Kafka and .NET](https://developer.confluent.io/get-started/dotnet/) on [Confluent Developer](https://developer.confluent.io/). | ||
For a step-by-step guide on using the .NET client with Confluent Cloud see [Getting Started with Apache Kafka and .NET](https://developer.confluent.io/get-started/dotnet/) on [Confluent Developer](https://developer.confluent.io/). | ||
|
||
You can also refer to the [Confluent Cloud example](examples/ConfluentCloud) which demonstrates how to configure the .NET client for use with | ||
[Confluent Cloud](https://www.confluent.io/confluent-cloud/). | ||
|
@@ -267,7 +267,7 @@ You can also refer to the [Confluent Cloud example](examples/ConfluentCloud) whi | |
|
||
Instructions on building and testing confluent-kafka-dotnet can be found [here](DEVELOPER.md). | ||
|
||
Copyright (c) | ||
Copyright (c) | ||
2016-2019 [Confluent Inc.](https://www.confluent.io) | ||
2015-2016 [Andreas Heider](mailto:[email protected]) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters