Skip to content

Commit d26a6f2

Browse files
committed
[kafka] add docs
1 parent ee89d29 commit d26a6f2

3 files changed

Lines changed: 104 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,17 @@ Features:
99

1010
* [Feature rich](docs/quick_tour.md).
1111
* Implements [JMS](https://docs.oracle.com/javaee/7/api/javax/jms/package-summary.html) like transports based on a[queue-interop](https://github.com/queue-interop/queue-interop) interfaces.
12-
* Supported transports [AMQP](docs/transport/amqp.md) (RabbitMQ, ActiveMQ), [Beanstalk](docs/transport/pheanstalk.md), [STOMP](docs/transport/stomp.md), [Amazon SQS](docs/transport/sqs.md), [Redis](docs/transport/redis.md), [Gearman](docs/transport/gearman.md), [Doctrine DBAL](docs/transport/dbal.md), [Filesystem](docs/transport/filesystem.md), [Null](docs/transport/null.md).
12+
* Supported transports
13+
* [AMQP](docs/transport/amqp.md) (RabbitMQ, ActiveMQ)
14+
* [Beanstalk](docs/transport/pheanstalk.md)
15+
* [STOMP](docs/transport/stomp.md)
16+
* [Amazon SQS](docs/transport/sqs.md)
17+
* [Kafka](docs/transport/kafka.md)
18+
* [Redis](docs/transport/redis.md)
19+
* [Gearman](docs/transport/gearman.md)
20+
* [Doctrine DBAL](docs/transport/dbal.md)
21+
* [Filesystem](docs/transport/filesystem.md)
22+
* [Null](docs/transport/null.md).
1323
* [Symfony bundle](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/bundle/quick_tour.md)
1424
* [Magento1 extension](https://github.com/php-enqueue/enqueue-dev/blob/master/docs/magento/quick_tour.md)
1525
* [Message bus](http://www.enterpriseintegrationpatterns.com/patterns/messaging/MessageBus.html) support.

‎docs/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
- [Amqp (RabbitMQ, ActiveMQ)](transport/amqp.md)
66
- [Amazon SQS](transport/sqs.md)
77
- [Beanstalk (Pheanstalk)](transport/pheanstalk.md)
8+
- [Gearman](transport/gearman.md)
9+
- [Kafka](transport/kafka.md)
810
- [Stomp](transport/stomp.md)
911
- [Redis](transport/redis.md)
1012
- [Doctrine DBAL](transport/dbal.md)

‎docs/transport/kafka.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Kafka transport
2+
3+
The transport uses [Kafka](https://kafka.apache.org/) streaming platform as a MQ broker.
4+
5+
* [Installation](#installation)
6+
* [Create context](#create-context)
7+
* [Send message to topic](#send-message-to-topic)
8+
* [Send message to queue](#send-message-to-queue)
9+
* [Consume message](#consume-message)
10+
11+
## Installation
12+
13+
```bash
14+
$ composer require enqueue/rdkafka
15+
```
16+
17+
## Create context
18+
19+
```php
20+
<?php
21+
use Enqueue\RdKafka\RdKafkaConnectionFactory;
22+
23+
// connects to localhost:9092
24+
$connectionFactory = new RdKafkaConnectionFactory();
25+
26+
// same as above
27+
$connectionFactory = new RdKafkaConnectionFactory('rdkafka://');
28+
29+
// same as above
30+
$connectionFactory = new RdKafkaConnectionFactory([]);
31+
32+
// connect to Kafka broker at example.com:1000 plus custom options
33+
$connectionFactory = new RdKafkaConnectionFactory([
34+
'global' => [
35+
'group.id' => uniqid('', true),
36+
'metadata.broker.list' => 'example.com:1000',
37+
'enable.auto.commit' => 'false',
38+
],
39+
'topic' => [
40+
'auto.offset.reset' => 'beginning',
41+
],
42+
]);
43+
44+
$psrContext = $connectionFactory->createContext();
45+
```
46+
47+
## Send message to topic
48+
49+
```php
50+
<?php
51+
/** @var \Enqueue\RdKafka\RdKafkaContext $psrContext */
52+
53+
$message = $psrContext->createMessage('Hello world!');
54+
55+
$fooTopic = $psrContext->createTopic('foo');
56+
57+
$psrContext->createProducer()->send($fooTopic, $message);
58+
```
59+
60+
## Send message to queue
61+
62+
```php
63+
<?php
64+
/** @var \Enqueue\RdKafka\RdKafkaContext $psrContext */
65+
66+
$message = $psrContext->createMessage('Hello world!');
67+
68+
$fooQueue = $psrContext->createQueue('foo');
69+
70+
$psrContext->createProducer()->send($fooQueue, $message);
71+
```
72+
73+
## Consume message:
74+
75+
```php
76+
<?php
77+
/** @var \Enqueue\RdKafka\RdKafkaContext $psrContext */
78+
79+
$fooQueue = $psrContext->createQueue('foo');
80+
81+
$consumer = $psrContext->createConsumer($fooQueue);
82+
83+
$message = $consumer->receive();
84+
85+
// process a message
86+
87+
$consumer->acknowledge($message);
88+
// $consumer->reject($message);
89+
```
90+
91+
[back to index](index.md)

0 commit comments

Comments
 (0)