Queueable handlers | Laravel Kafka [ Laravel Kafka ](/) Search ⌘K [ Login with GitHub ](https://laravelkafka.com/oauth/github/redirect) Docs for version selected v2.11 v2.10 v2.9 v2.8 v1.13 - - [ Introduction ](/docs/v2.9/introduction) - [ Requirements ](/docs/v2.9/requirements) - [ Installation and Setup ](/docs/v2.9/installation-and-setup) - [ Questions and issues ](/docs/v2.9/questions-and-issues) - [ Changelog ](/docs/v2.9/changelog) - [ Upgrade guide ](/docs/v2.9/upgrade-guide) - [ Example docker-compose file ](/docs/v2.9/example-docker-compose) - Producing messages ------------------ - [ Producing messages ](/docs/v2.9/producing-messages/producing-messages) - [ Configuring your kafka producer ](/docs/v2.9/producing-messages/configuring-producers) - [ Configuring message payload ](/docs/v2.9/producing-messages/configuring-message-payload) - [ Custom serializers ](/docs/v2.9/producing-messages/custom-serializers) - [ Publishing to kafka ](/docs/v2.9/producing-messages/publishing-to-kafka) - Consuming messages ------------------ - [ Creating a kafka consumer ](/docs/v2.9/consuming-messages/creating-consumer) - [ Subscribing to kafka topics ](/docs/v2.9/consuming-messages/subscribing-to-kafka-topics) - [ Using regex to subscribe to kafka topics ](/docs/v2.9/consuming-messages/using-regex-to-subscribe-to-kafka-topics) - [ Assigning consumers to a topic partition ](/docs/v2.9/consuming-messages/assigning-partitions) - [ Consuming messages from specific offsets ](/docs/v2.9/consuming-messages/consuming-from-specific-offsets) - [ Consumer groups ](/docs/v2.9/consuming-messages/consumer-groups) - [ Partition Discovery and Dynamic Assignment ](/docs/v2.9/consuming-messages/partition-discovery) - [ Message handlers ](/docs/v2.9/consuming-messages/message-handlers) - [ Configuring consumer options ](/docs/v2.9/consuming-messages/configuring-consumer-options) - [ Custom deserializers ](/docs/v2.9/consuming-messages/custom-deserializers) - [ Consuming messages ](/docs/v2.9/consuming-messages/consuming-messages) - [ Class structure ](/docs/v2.9/consuming-messages/class-structure) - [ Queueable handlers ](/docs/v2.9/consuming-messages/queueable-handlers) - Advanced usage -------------- - [ Replacing the default serializer/deserializer ](/docs/v2.9/advanced-usage/replacing-default-serializer) - [ Graceful shutdown ](/docs/v2.9/advanced-usage/graceful-shutdown) - [ SASL Authentication ](/docs/v2.9/advanced-usage/sasl-authentication) - [ Custom Committers ](/docs/v2.9/advanced-usage/custom-committers) - [ Manual Commit ](/docs/v2.9/advanced-usage/manual-commit) - [ Middlewares ](/docs/v2.9/advanced-usage/middlewares) - [ Stop consumer after last messages ](/docs/v2.9/advanced-usage/stop-consumer-after-last-message) - [ Stop consumer on demand ](/docs/v2.9/advanced-usage/stopping-a-consumer) - [ Writing custom loggers ](/docs/v2.9/advanced-usage/custom-loggers) - [ Before and after callbacks ](/docs/v2.9/advanced-usage/before-callbacks) - [ Setting global configurations ](/docs/v2.9/advanced-usage/setting-global-configuration) - [ Sending multiple messages with the same producer ](/docs/v2.9/advanced-usage/sending-multiple-messages-with-the-same-producer) - Testing ------- - [ Kafka fake ](/docs/v2.9/testing/fake) - [ Assert Published ](/docs/v2.9/testing/assert-published) - [ Assert published On ](/docs/v2.9/testing/assert-published-on) - [ Assert nothing published ](/docs/v2.9/testing/assert-nothing-published) - [ Assert published times ](/docs/v2.9/testing/assert-published-times) - [ Assert published on times ](/docs/v2.9/testing/assert-published-on-times) - [ Mocking your kafka consumer ](/docs/v2.9/testing/mocking-your-kafka-consumer) Queueable handlers ==================== Queueable handlers allow you to handle your kafka messages in a queue. This will put a job into the Laravel queue system for each message received by your Kafka consumer. Support Laravel Kafka by sponsoring me! Do you find Laravel Kafka valuable and wanna support its development? Laravel Kafka is free and Open Source software, built to empower developers like you. Your support helps maintain and enhance the project. If you find it valuable, please consider sponsoring me on GitHub. Every contribution makes a difference and keeps the development going strong! Thank you! [ Become a Sponsor ](https://github.com/sponsors/mateusjunges) Want to hide this message? Sponsor at any tier of $10/month or more! This only requires you to implements the `Illuminate\Contracts\Queue\ShouldQueue` interface in your Handler. This is how a queueable handler looks like: ``` use Illuminate\Contracts\Queue\ShouldQueue; use Junges\Kafka\Contracts\Handler as HandlerContract; use Junges\Kafka\Contracts\KafkaConsumerMessage; class Handler implements HandlerContract, ShouldQueue { public function __invoke(KafkaConsumerMessage $message): void { // Handle the consumed message. } } ``` As you can see on the `__invoke` method, queued handlers does not have access to a `MessageConsumer` instance when handling the message, because it's running on a laravel queue and there are no actions that can be performed asynchronously on Kafka message consumer. You can specify which queue connection and queue name to use for your handler by implementing the `onConnection` and `onQueue` methods: ``` use Illuminate\Contracts\Queue\ShouldQueue; use Junges\Kafka\Contracts\Handler as HandlerContract; use Junges\Kafka\Contracts\KafkaConsumerMessage; class Handler implements HandlerContract, ShouldQueue { public function __invoke(KafkaConsumerMessage $message): void { // Handle the consumed message. } public function onConnection(): string { return 'sqs'; // Specify your queue connection } public function onQueue(): string { return 'kafka-handlers'; // Specify your queue name } } ``` After creating your handler class, you can use it just as a normal handler, and `laravel-kafka` will know how to handle it under the hoods 😄. Previous [ Class structure ](https://laravelkafka.com/docs/v2.9/consuming-messages/class-structure) Next [ Replacing the default serializer/deserializer ](https://laravelkafka.com/docs/v2.9/advanced-usage/replacing-default-serializer) Sponsors [ version="1.0" encoding="UTF-8"? EasyCal ](https://easycal.app/) [ Search ⌘ K ](https://typesense.org/)