-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README
: improve KafkaProducer
examples
#76
Closed
felixschlegel
wants to merge
5
commits into
swift-server:main
from
felixschlegel:fs-readme-fix-producer-example
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
82e183a
Refactor `KafkaProducer`
felixschlegel 07bda4b
* rename KafkaProducer.StateMachine.State.shutDown to .finished
felixschlegel 83d7077
Remove unused awaits
felixschlegel ec17d1c
KafkaProducer: move logger out of state
felixschlegel 406b36f
`README`: improve `KafkaProducer` examples
felixschlegel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
|
@@ -25,12 +25,46 @@ Finally, add `import SwiftKafka` to your source code. | |
|
||
### Producer API | ||
|
||
After creating the `KafkaProducer`, messages can be sent to a `topic` using the `send(_:)` method. | ||
|
||
```swift | ||
let config = KafkaProducerConfiguration(bootstrapServers: ["localhost:9092"]) | ||
|
||
let producer = try KafkaProducer.makeProducer( | ||
config: config, | ||
logger: .kafkaTest // Your logger here | ||
) | ||
|
||
await withThrowingTaskGroup(of: Void.self) { group in | ||
|
||
// Run Task | ||
group.addTask { | ||
try await producer.run() | ||
} | ||
|
||
// Task sending messages | ||
group.addTask { | ||
try producer.send( | ||
KafkaProducerMessage( | ||
topic: "topic-name", | ||
value: "Hello, World!" | ||
) | ||
) | ||
|
||
// Required | ||
await producer.shutdownGracefully() | ||
Comment on lines
+54
to
+55
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We really want to get rid of this by folding it into the |
||
} | ||
} | ||
``` | ||
|
||
#### Acknowledgements | ||
|
||
The `send(_:)` method of `KafkaProducer` returns a message-id that can later be used to identify the corresponding acknowledgement. Acknowledgements are received through the `acknowledgements` [`AsyncSequence`](https://developer.apple.com/documentation/swift/asyncsequence). Each acknowledgement indicates that producing a message was successful or returns an error. | ||
|
||
```swift | ||
let config = KafkaProducerConfiguration(bootstrapServers: ["localhost:9092"]) | ||
|
||
let (producer, acknowledgements) = try await KafkaProducer.makeProducerWithAcknowledgements( | ||
let (producer, acknowledgements) = try KafkaProducer.makeProducerWithAcknowledgements( | ||
config: config, | ||
logger: .kafkaTest // Your logger here | ||
) | ||
|
@@ -42,9 +76,9 @@ await withThrowingTaskGroup(of: Void.self) { group in | |
try await producer.run() | ||
} | ||
|
||
// Task receiving acknowledgements | ||
// Task sending messages and receiving acknowledgements | ||
group.addTask { | ||
let messageID = try await producer.send( | ||
let messageID = try producer.send( | ||
KafkaProducerMessage( | ||
topic: "topic-name", | ||
value: "Hello, World!" | ||
|
@@ -55,8 +89,7 @@ await withThrowingTaskGroup(of: Void.self) { group in | |
// Check if acknowledgement belongs to the sent message | ||
} | ||
|
||
// Required | ||
await producer.shutdownGracefully() | ||
// The producer shuts down automatically after consuming the acknowledgements | ||
} | ||
} | ||
``` | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We normally just do this