Skip to content

Commit 3322ee1

Browse files
committed
[amqp][delay] add docs
1 parent 9b54315 commit 3322ee1

3 files changed

Lines changed: 78 additions & 0 deletions

File tree

‎docs/transport/amqp.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Build on top of [php amqp extension](https://github.com/pdezwart/php-amqp).
1212
* [Send message to queue](#send-message-to-queue)
1313
* [Send priority message](#send-priority-message)
1414
* [Send expiration message](#send-expiration-message)
15+
* [Send delayed message](#send-delayed-message)
1516
* [Consume message](#consume-message)
1617
* [Purge queue messages](#purge-queue-messages)
1718

@@ -163,6 +164,31 @@ $psrContext->createProducer()
163164
;
164165
```
165166

167+
## Send delayed message
168+
169+
AMQP specification says nothing about message delaying hence the producer throws `DeliveryDelayNotSupportedException`.
170+
Though the producer (and the context) accepts a delivry delay strategy and if it is set it uses it to send delayed message.
171+
The `enqueue/amqp-tools` package provides two RabbitMQ delay strategies, to use them you have to install that package
172+
173+
```php
174+
<?php
175+
use Enqueue\AmqpTools\RabbitMqDlxDelayStrategy;
176+
177+
/** @var \Enqueue\AmqpExt\AmqpContext $psrContext */
178+
/** @var \Interop\Amqp\Impl\AmqpQueue $fooQueue */
179+
180+
// make sure you run "composer require enqueue/amqp-tools".
181+
182+
$message = $psrContext->createMessage('Hello world!');
183+
184+
$psrContext->createProducer()
185+
->setDelayStrategy(new RabbitMqDlxDelayStrategy())
186+
->setDeliveryDelay(5000) // 5 sec
187+
188+
->send($fooQueue, $message)
189+
;
190+
````
191+
166192
## Consume message:
167193

168194
```php

‎docs/transport/amqp_bunny.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Build on top of [bunny lib](https://github.com/jakubkulhan/bunny).
1212
* [Send message to queue](#send-message-to-queue)
1313
* [Send priority message](#send-priority-message)
1414
* [Send expiration message](#send-expiration-message)
15+
* [Send delayed message](#send-delayed-message)
1516
* [Consume message](#consume-message)
1617
* [Purge queue messages](#purge-queue-messages)
1718

@@ -163,6 +164,31 @@ $psrContext->createProducer()
163164
;
164165
```
165166

167+
## Send delayed message
168+
169+
AMQP specification says nothing about message delaying hence the producer throws `DeliveryDelayNotSupportedException`.
170+
Though the producer (and the context) accepts a delivry delay strategy and if it is set it uses it to send delayed message.
171+
The `enqueue/amqp-tools` package provides two RabbitMQ delay strategies, to use them you have to install that package
172+
173+
```php
174+
<?php
175+
use Enqueue\AmqpTools\RabbitMqDlxDelayStrategy;
176+
177+
/** @var \Enqueue\AmqpExt\AmqpContext $psrContext */
178+
/** @var \Interop\Amqp\Impl\AmqpQueue $fooQueue */
179+
180+
// make sure you run "composer require enqueue/amqp-tools".
181+
182+
$message = $psrContext->createMessage('Hello world!');
183+
184+
$psrContext->createProducer()
185+
->setDelayStrategy(new RabbitMqDlxDelayStrategy())
186+
->setDeliveryDelay(5000) // 5 sec
187+
188+
->send($fooQueue, $message)
189+
;
190+
````
191+
166192
## Consume message:
167193

168194
```php

‎docs/transport/amqp_lib.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Build on top of [php amqp lib](https://github.com/php-amqplib/php-amqplib).
1212
* [Send message to queue](#send-message-to-queue)
1313
* [Send priority message](#send-priority-message)
1414
* [Send expiration message](#send-expiration-message)
15+
* [Send delayed message](#send-delayed-message)
1516
* [Consume message](#consume-message)
1617
* [Purge queue messages](#purge-queue-messages)
1718

@@ -163,6 +164,31 @@ $psrContext->createProducer()
163164
;
164165
```
165166

167+
## Send delayed message
168+
169+
AMQP specification says nothing about message delaying hence the producer throws `DeliveryDelayNotSupportedException`.
170+
Though the producer (and the context) accepts a delivry delay strategy and if it is set it uses it to send delayed message.
171+
The `enqueue/amqp-tools` package provides two RabbitMQ delay strategies, to use them you have to install that package
172+
173+
```php
174+
<?php
175+
use Enqueue\AmqpTools\RabbitMqDlxDelayStrategy;
176+
177+
/** @var \Enqueue\AmqpExt\AmqpContext $psrContext */
178+
/** @var \Interop\Amqp\Impl\AmqpQueue $fooQueue */
179+
180+
// make sure you run "composer require enqueue/amqp-tools".
181+
182+
$message = $psrContext->createMessage('Hello world!');
183+
184+
$psrContext->createProducer()
185+
->setDelayStrategy(new RabbitMqDlxDelayStrategy())
186+
->setDeliveryDelay(5000) // 5 sec
187+
188+
->send($fooQueue, $message)
189+
;
190+
````
191+
166192
## Consume message:
167193

168194
```php

0 commit comments

Comments
 (0)