Download the PHP package byjg/message-queue-client without Composer
On this page you can find all versions of the php package byjg/message-queue-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download byjg/message-queue-client
More information about byjg/message-queue-client
Files in byjg/message-queue-client
Package message-queue-client
Short Description A minimal PHP foundation for building message queue drivers. Features low-code publishing and consumption, decoupled components (Messages, Queues, and Connectors), and easy connector implementation.
License MIT
Informations about the package message-queue-client
sidebar_key: message-queue-client tags: [php, queue]
Message Queue Client
A minimal PHP foundation for building message queue drivers. Features low-code publishing and consumption, decoupled components (Messages, Queues, and Connectors), and easy connector implementation.
Features
- Low code to publish and consume messages
- Messages, Queues and Connector objects are decoupled
- Easy to implement new connectors
Code Structure
| Component | Description | Location |
|---|---|---|
| Message | Represents a message payload with properties | \ByJG\MessageQueueClient\Message |
| Pipe | Abstraction representing a queue or topic destination with optional properties | \ByJG\MessageQueueClient\Connector\Pipe |
| Envelope | Combines a Message with its destination Pipe | \ByJG\MessageQueueClient\Envelope |
| ConnectorInterface | Interface for message queue implementations | \ByJG\MessageQueueClient\Connector\ConnectorInterface |
| ConnectorFactory | Factory for creating connector instances | \ByJG\MessageQueueClient\Connector\ConnectorFactory |
| ConsumerClientTrait | Helper for implementing consumer clients | \ByJG\MessageQueueClient\ConsumerClientTrait |
| ConsumerClientInterface | Interface for consumer client implementations | \ByJG\MessageQueueClient\ConsumerClientInterface |
Implemented Connectors
| Connector | URL / Documentation | Composer Package |
|---|---|---|
| Mock | docs/mock-connector.md | - |
| RabbitMQ | https://github.com/byjg/rabbitmq-client | byjg/rabbitmq-client |
| Redis | https://github.com/byjg/redis-queue-client | byjg/redis-queue-client |
Usage
Publish
Consume
The consume method will wait for a message and call the callback function to process the message. If there is no message in the queue, the method will wait until a message arrives.
If you want to exit the consume method, just return Message::ACK | Message::EXIT from the callback function.
Possible return values from the callback function:
Message::ACK- Acknowledge the message and remove from the queueMessage::NACK- Not acknowledge the message and remove from the queue. If the queue has a dead letter queue, the message will be sent to the dead letter queue.Message::REQUEUE- Requeue the messageMessage::EXIT- Exit the consume method
Consumer Client
You can simplify the consume method by using the ConsumerClientTrait. See more details in the docs/consumer-client-trait.md.
Connectors
The connectors are the classes responsible to connect to the message queue server and send/receive messages.
All connector have the following interface:
There is no necessary call the method getDriver() because the method publish() and consume() will call it automatically.
Use the method getDriver() only if you need to access the connection directly.
Documentation
Core Components
- Pipe Class - Represents a message queue or topic
- Message Class - Represents a message that can be published or consumed
- Envelope Class - Encapsulates a message with its destination pipe
Connectors
- Connector Interface - Interface for message queue connectors
- Connector Factory - Factory for creating connector instances
- Mock Connector - Simple connector for testing
Helpers
- Consumer Client Trait - Helper for implementing consumer clients