Add support for gracefully stopping a consumer that uses Consumer#each#7
Merged
Add support for gracefully stopping a consumer that uses Consumer#each#7
Conversation
024ae23 to
13e6580
Compare
Previously if the `Consumer#each` method was called it would loop
indefinitely with no way of gracefully stopping it. Calling
`Consumer#close` would close and destroy the kafka handle, but would
then crash the app with an "Invalid memory access" inside the each loop
the next time it called `poll`.
This commit adds an internal flag to keep track of whether the each loop
is running, and adds a `Consumer#stop` method to stop it. This can be
called from, for example, a signal handler to gracefully stop the
consumer. E.g.:
```
require "crafka"
consumer = Kafka::Consumer.new({
"bootstrap.servers" => "localhost:9092",
"client.id" => "test",
"group.id" => "test",
"broker.address.family" => "v4",
})
Signal::INT.trap do
Log.info { "Received SIGINT" }
consumer.stop
end
Log.info { "Subscribing to topic..." }
consumer.subscribe("test-topic")
Log.info { "Starting consumer loop..." }
consumer.each do |kafka_event|
payload = String.new(kafka_event.payload)
Log.info { "Consumed event: #{payload}" }
end
Log.info { "Exited consumer loop" }
Log.info { "Closing consumer..." }
consumer.close
Log.info { "Bye" }
```
13e6580 to
5bd1221
Compare
jphaward
approved these changes
Jun 26, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently if the
Consumer#eachmethod is called it will loop indefinitely with no way of gracefully stopping it. CallingConsumer#closecloses and destroys the kafka handle, but then causes the app to crash an "Invalid memory access" inside theeachloop the next time it callspoll.This PR adds an internal flag to keep track of whether the each loop is running, and adds a
Consumer#stopmethod to stop it. This can be called from, for example, a signal handler to gracefully stop the consumer.This PR also adds some extra safety by raising an error if an attempt is made to use the consumer after it has been closed instead of crashing with an "Invalid memory access" error.