Download the PHP package bongrun/rsmq without Composer

Redis Simple Message Queue

A lightweight message queue for PHP that requires no dedicated queue server. Just a Redis server. See smrchy/rsmq for more information.

This is a fork of eislambey/php-rsmq with the following changes:

• Uses predis instead of the Redis extension
• Has some OO wrappers for QueueAttributes and Message
• Provides a simple QueueWorker

Table of Contents

• Installation
• Methods
  • Construct
  • Queue
  • createQueue
  • listQueues
  • deleteQueue
  • getQueueAttributes
  • setQueueAttributes
  • Messages
  • sendMessage
  • receiveMessage
  • deleteMessage
  • popMessage
  • changeMessageVisibility
• QueueWorker
• LICENSE

Installation

composer require andrewbreksa/rsmq

Methods

Construct

Creates a new instance of RSMQ.

Parameters:

• $predis (\Predis\ClientInterface): *required The Predis instance
• $ns (string): optional (Default: "rsmq") The namespace prefix used for all keys created by RSMQ
• $realtime (Boolean): optional (Default: false) Enable realtime PUBLISH of new messages

Example:

Queue

createQueue

Create a new queue.

Parameters:

• $name (string): The Queue name. Maximum 160 characters; alphanumeric characters, hyphens (-), and underscores (_) are allowed.
• $vt (int): optional (Default: 30) The length of time, in seconds, that a message received from a queue will be invisible to other receiving components when they ask to receive messages. Allowed values: 0-9999999 (around 115 days)
• $delay (int): optional (Default: 0) The time in seconds that the delivery of all new messages in the queue will be delayed. Allowed values: 0-9999999 (around 115 days)
• $maxsize (int): optional (Default: 65536) The maximum message size in bytes. Allowed values: 1024-65536 and -1 (for unlimited size)

Returns:

• true (Bool)

Throws:

• \AndrewBreksa\RSMQ\Exceptions\QueueAlreadyExistsException

Example:

listQueues

List all queues

Returns an array:

• ["qname1", "qname2"]

Example:

deleteQueue

Deletes a queue and all messages.

Parameters:

• $name (string): The Queue name.

Returns:

• true (Bool)

Throws:

• \AndrewBreksa\RSMQ\Exceptions\QueueNotFoundException

Example:

getQueueAttributes

Get queue attributes, counter and stats

Parameters:

• $queue (string): The Queue name.

Returns a \AndrewBreksa\RSMQ\QueueAttributes object with the following properties:

• vt (int): The visibility timeout for the queue in seconds
• delay (int): The delay for new messages in seconds
• maxSize (int): The maximum size of a message in bytes
• totalReceived (int): Total number of messages received from the queue
• totalSent (int): Total number of messages sent to the queue
• created (float): Timestamp (epoch in seconds) when the queue was created
• modified (float): Timestamp (epoch in seconds) when the queue was last modified with setQueueAttributes
• messageCount (int): Current number of messages in the queue
• hiddenMessageCount (int): Current number of hidden / not visible messages. A message can be hidden while "in flight" due to a vt parameter or when sent with a delay

Example:

setQueueAttributes

Sets queue parameters.

Parameters:

• $queue (string): The Queue name.
• $vt (int): optional * The length of time, in seconds, that a message received from a queue will be invisible to other receiving components when they ask to receive messages. Allowed values: 0-9999999 (around 115 days)
• $delay (int): optional The time in seconds that the delivery of all new messages in the queue will be delayed. Allowed values: 0-9999999 (around 115 days)
• $maxsize (int): optional The maximum message size in bytes. Allowed values: 1024-65536 and -1 (for unlimited size)

Note: At least one attribute (vt, delay, maxsize) must be supplied. Only attributes that are supplied will be modified.

Returns a \AndrewBreksa\RSMQ\QueueAttributes object with the following properties:

• vt (int): The visibility timeout for the queue in seconds
• delay (int): The delay for new messages in seconds
• maxSize (int): The maximum size of a message in bytes
• totalReceived (int): Total number of messages received from the queue
• totalSent (int): Total number of messages sent to the queue
• created (float): Timestamp (epoch in seconds) when the queue was created
• modified (float): Timestamp (epoch in seconds) when the queue was last modified with setQueueAttributes
• messageCount (int): Current number of messages in the queue
• hiddenMessageCount (int): Current number of hidden / not visible messages. A message can be hidden while "in flight" due to a vt parameter or when sent with a delay

Throws:

• \AndrewBreksa\RSMQ\QueueAttributes
• \AndrewBreksa\RSMQ\QueueParametersValidationException
• \AndrewBreksa\RSMQ\QueueNotFoundException

Example:

Messages

sendMessage

Sends a new message.

Parameters:

• $queue (string)
• $message (string)
• $delay (int): optional (Default: queue settings) The time in seconds that the delivery of the message will be delayed. Allowed values: 0-9999999 (around 115 days)

Returns:

• $id (string): The internal message id.

Throws:

• \AndrewBreksa\RSMQ\Exceptions\MessageToLongException
• \AndrewBreksa\RSMQ\Exceptions\QueueNotFoundException
• \AndrewBreksa\RSMQ\Exceptions\QueueParametersValidationException

Example:

receiveMessage

Receive the next message from the queue.

Parameters:

• $queue (string): The Queue name.
• $vt (int): optional (Default: queue settings) The length of time, in seconds, that the received message will be invisible to others. Allowed values: 0-9999999 (around 115 days)

Returns a \AndrewBreksa\RSMQ\Message object with the following properties:

• message (string): The message's contents.
• id (string): The internal message id.
• sent (int): Timestamp of when this message was sent / created.
• firstReceived (int): Timestamp of when this message was first received.
• receiveCount (int): Number of times this message was received.

Note: Will return an empty array if no message is there

Throws:

• \AndrewBreksa\RSMQ\Exceptions\QueueNotFoundException
• \AndrewBreksa\RSMQ\Exceptions\QueueParametersValidationException

Example:

deleteMessage

Parameters:

• $queue (string): The Queue name.
• $id (string): message id to delete.

Returns:

• true if successful, false if the message was not found (bool).

Throws:

• \AndrewBreksa\RSMQ\Exceptions\QueueParametersValidationException

Example:

popMessage

Receive the next message from the queue and delete it.

Important: This method deletes the message it receives right away. There is no way to receive the message again if something goes wrong while working on the message.

Parameters:

• $queue (string): The Queue name.

Returns a \AndrewBreksa\RSMQ\Message object with the following properties:

• message (string): The message's contents.
• id (string): The internal message id.
• sent (int): Timestamp of when this message was sent / created.
• firstReceived (int): Timestamp of when this message was first received.
• receiveCount (int): Number of times this message was received.

Note: Will return an empty object if no message is there

Throws:

• \AndrewBreksa\RSMQ\Exceptions\QueueNotFoundException
• \AndrewBreksa\RSMQ\Exceptions\QueueParametersValidationException

Example:

changeMessageVisibility

Change the visibility timer of a single message. The time when the message will be visible again is calculated from the current time (now) + vt.

Parameters:

• qname (string): The Queue name.
• id (string): The message id.
• vt (int): The length of time, in seconds, that this message will not be visible. Allowed values: 0-9999999 (around 115 days)

Returns:

• true if successful, false if the message was not found (bool).

Throws:

• \AndrewBreksa\RSMQ\Exceptions\QueueParametersValidationException
• \AndrewBreksa\RSMQ\Exceptions\QueueNotFoundException

Example:

QueueWorker

The QueueWorker class provides an easy way to consume RSMQ messages, to use it:

LICENSE

The MIT LICENSE. See LICENSE