Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 2.51 KB

producer.md

File metadata and controls

107 lines (74 loc) · 2.51 KB

PHP Simple Queue Usage basics

Message producer object to send messages to a queue.

📖 Guide


📄 Producer

You need to configure $transport and $config to send new messages.


Send a new message to queue:

$producer = new \Simple\Queue\Producer($transport, $config);

$producer->send($producer->createMessage('my_queue', ['my_data']));

or a custom example (you need to think about serialization):

$producer = new \Simple\Queue\Producer($transport, $config);

$message = (new \Simple\Queue\Message('my_queue', 'my_data'))
    ->withEvent('my_event')
    ->changePriority(\Simple\Queue\Priority::VERY_HIGH);

$producer->send($message);

You can send a message from anywhere in the application to process it in the background.


Send a new message to queue through job:

$producer = new \Simple\Queue\Producer($transport, $config);

$producer->dispatch(MyJob::class, ['key' => 'value']);

You can send a message to the queue from anywhere in the application where available $producer.


Message

Description of the base entity Message.

// create new Message
$message = new \Simple\Queue\Message('my_queue', 'my_data');

// public getters
$message->getId();
$message->getStatus();
$message->isJob();
$message->getError();
$message->getExactTime();
$message->getCreatedAt();
$message->getAttempts();
$message->getQueue();
$message->getEvent();
$message->getBody();
$message->getPriority();
$message->getRedeliveredAt();
$message->isRedelivered();

// public setters
$message->changeRedeliveredAt($redeliveredAt);
$message->changeQueue($queue);
$message->changePriority($priority);
$message->withEvent($event);

Each message has Status and Priority.

  • Status
    Used to delimit messages in a queue (system parameter, not available for public modification).
    Possible options: NEW; IN_PROCESS; ERROR; REDELIVERED.

  • Priority
    Used to sort messages in the consumer.
    Possible options: VERY_LOW = -2; LOW = -1; DEFAULT = 0; HIGH = 1; VERY_HIGH = 2.