Download the PHP package b2pweb/bdf-queue without Composer

Queue

This package provides 2 layers for abstraction of message broker.

• A connection layer
• A destination layer

Supports

Usage Instructions

Produce messages

First, create a new destination manager instance.

Push a basic message into the queue. The consume should defined handler to process the message.

Useful for monolithic application that needs to differ a process. Push a message job into the queue. The consumer will evaluate the job string and run the processor. In this use case the producer and the receiver share the same model.

Available type for dsn destination

The class Bdf\Queue\Destination\DsnDestinationFactory provides default type of destination:

You can declare your own type:

Consume messages

The consumer layer provides many tools for message handling. The default stack of objects that will receive the message is:

consumer (ConsumerInterface) -> receivers (ReceiverInterface) -> processor (ProcessorInterface) -> handler (callable)

• consumer has the strategy for reading the message from queue / topic. It also manage a graceful shutdown.
• receivers is the stack of middlewares interacts with the envelope.
• processor resolves the handler arguments. You can plug here your business logic and remove the handler layer. By default processor injects 2 arguments in handlers: the message data and the envelope.
• handler manages the business logic. Handler allows an interface less mode.

An example to consume a simple message:

Consume a job message:

Create a handler

Use the synthax "Class@method" to determine the callable (By default the method is "handle") or register your handlers on a specific destination with the receiver builder:

Run the consumer in console

Create receiver extensions

The consumer use a stack of receivers to extend the reception of messages. See the interface Bdf\Queue\Consumer\ReceiverInterface and the trait Bdf\Queue\Consumer\DelegateHelper.

You can use the Bdf\Queue\Consumer\Receiver\Builder\ReceiverLoader::add() to register your receiver in the stack

Customize the string payload

The class Bdf\Queue\Serializer\SerializerInterface manage the payload content sent to the message broker. By default metadata are added to the json as:

• PHP Type: to help consumer to deserialize complex entities.
• Message info: The attempt number for retry, The sending date, ...

A basic payload looks like:

You can customize the string with your own implementation of the serializer interface.

Try the hello world example (configure the message broker in example/config/connections.php):

RPC client

Additionnal options for connection

Note:

• Format of a valid DSN: {driver}+{vendor}://{user}:{password}@{host}:{port}/{queue}?{option}=value
• See https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md for more kafka options.

Additionnal options for message

Serialization

Benchmarks

simple job / closure job

Analysis

• For the best execution time, regardless of size, use the default Serializer
• For the smaller size, regardless of time, use BdfSerializer with CompressedSerializer
• For the best compromise, use Serializer with CompressedSerializer
  • Always smaller than pure BdfSerializer (JSON or Binary)
  • Faster on unserialize, slightly slower on serialize
  • Around twice faster than compressed bdf, but only ~40% larger on simple job

License

Distributed under the terms of the MIT license.