Amazon SQS Support
Ecotone support for Amazon SQS PHP
Installation
composer require ecotone/sqs
Module Powered By
Enqueue solid and powerful abstraction over asynchronous queues.
Configuration
In order to use SQS Support
we need to add ConnectionFactory
to our Dependency Container.
# config/services.yaml
Enqueue\Sqs\SqsConnectionFactory:
class: Enqueue\Sqs\SqsConnectionFactory
arguments:
- "sqs:?key=key&secret=secret®ion=us-east-1&version=latest"
Message Channel
To create Message Channel, we need to create Service Context.
use Ecotone\Sqs\SqsBackedMessageChannelBuilder;
class MessagingConfiguration
{
#[ServiceContext]
public function orderChannel()
{
return SqsBackedMessageChannelBuilder::create("orders");
}
}
Now orders
channel will be available in Messaging System.
Message Channel Configuration
SqsBackedMessageChannelBuilder::create("orders")
->withAutoDeclare(false) // do not auto declare queue
->withDefaultTimeToLive(1000) // limit TTL of messages
Message Publisher
If you want to publish Message directly to Exchange, you may use of Publisher.
use Ecotone\Sqs\Configuration\SqsMessagePublisherConfiguration;
class PublisherConfiguration
{
#[ServiceContext]
public function registerPublisherConfig()
{
return
SqsMessagePublisherConfiguration::create(
MessagePublisher::class, // 1
"delivery", // 2
"application/json" // 3
);
}
}
Reference name
- Name under which it will be available in Dependency Container.Queue name
- Name of queue where Message should be publishedDefault Conversion [Optional]
- Default type, payload will be converted to.
Publisher Configuration
SqsMessagePublisherConfiguration::create(queueName: $queueName)
->withAutoDeclareQueueOnSend(false) // 1
->withHeaderMapper("application.*") // 2
withAutoDeclareQueueOnSend
- should Ecotone try to declare queue before sending messagewithHeaderMapper
- On default headers are not send with message. You map provide mapping for headers that should be mapped toSQS Message
Message Consumer
To connect consumer directly to a SQS Queue, we need to provide Ecotone
with information, how the Queue is configured.
use Ecotone\Sqs\Configuration\SqsMessageConsumerConfiguration;
class ConsumerConfiguration
{
#[ServiceContext]
public function registerConsumerConfig(): array
{
return [
SqsMessageConsumerConfiguration::create("orders_consumer", "orders")
];
}
}
Provides Consumer that will be registered at given name
"orders_consumer"
and will be polling"orders"
queue
Consumer Configuration
$consumerConfiguration = SqsMessageConsumerConfiguration::createDirectExchange()
->withDeclareOnStartup(false) // do not try to declare queue before consuming first message;
Last updated
Was this helpful?