Nsq PHP

PHP Client for NSQ.

This library follow SemVer. Until version 1.0 will be released anything MAY change at any time, public API SHOULD NOT be considered stable. If you want use it before stable version was released install strict version without range.

Installation

This library is installable via Composer:

composer require nsq/nsq

Requirements

This library requires PHP 8.0 or later.

Although not required, it is recommended that you install the phpinnacle/ext-buffer to speed up phpinnacle/buffer .

Features

• PUB
• SUB
• Feature Negotiation
• Discovery
• Backoff
• TLS
• Deflate
• Snappy
• Sampling
• AUTH

Usage

Producer

use Nsq\Producer;

$producer = new Producer(address: 'tcp://nsqd:4150');

// Publish a message to a topic
$producer->pub('topic', 'Simple message');

// Publish multiple messages to a topic (atomically) 
$producer->mpub('topic', [
    'Message one',
    'Message two',
]);

// Publish a deferred message to a topic
$producer->dpub('topic', 'Deferred message', delay: 5000);

Consumer

use Nsq\Consumer;
use Nsq\Protocol\Message;

$consumer = new Consumer(
    topic: 'topic', 
    channel: 'channel',
    address: 'tcp://nsqd:4150',
);

// Simple blocking loop based on generator
$generator = $consumer->generator(); 

foreach ($generator as $message) {
    if ($message instanceof Message) {
        $payload = $message->body;

        // handle message

        $message->touch(); // Reset the timeout for an in-flight message        
        $message->requeue(timeout: 5000); // Re-queue a message (indicate failure to process)        
        $message->finish(); // Finish a message (indicate successful processing)        
    }
    
    // In case of nothing received during timeout generator will return NULL
    // Here we can do something between messages, like pcntl_signal_dispatch()

    // Gracefully close connection (loop will be ended)
    $generator->send(0); 
}

Integrations

• Symfony

License:

The MIT License (MIT). Please see LICENSE for more information.