friendsofhyperf/redis-subscriber

Redis native protocol Subscriber based on Swoole coroutine

v3.1.23.1 2024-04-28 05:50 UTC

Requires

• hyperf/coordinator: ~3.1.0
• hyperf/coroutine: ~3.1.0
• hyperf/engine: ^2.1

MIT

• liu,jian
• huangdijia

• redis
• subscriber
• swoole

README

Forked from mix-php/redis-subscriber

A Redis native protocol Subscriber based on Swoole coroutine

A Redis native protocol subscription library based on Swoole coroutine

It connects directly to the Redis server using a Socket, independent of the phpredis extension. This subscriber has the following advantages:

• Smooth modification: Subscriptions can be added or canceled at any time, fulfilling the need for seamless channel switching.
• Safe closure across coroutines: Subscription can be closed at any moment.
• Channel message retrieval: This library's encapsulation style is inspired by the go-redis library in the Go language, retrieving subscribed messages through a channel.

Installation

composer require friendsofhyperf/redis-subscriber

Subscribing to Channels

• Connection or subscription failures will throw an exception

$sub = new \FriendsOfHyperf\Redis\Subscriber\Subscriber('127.0.0.1', 6379, '', 5); // Connection failure will throw an exception
$sub->subscribe('foo', 'bar'); // Subscription failure will throw an exception

$chan = $sub->channel();
while (true) {
    $data = $chan->pop();
    if (empty($data)) { // Manual close or abnormal disconnection from Redis will return false
        if (!$sub->closed) {
            // Handle abnormal disconnection from Redis
            var_dump('Redis connection is disconnected abnormally');
        }
        break;
    }
    var_dump($data);
}

Receiving subscribed messages:

object(FriendsOfHyperf\Redis\Subscriber\Message)#8 (2) {
  ["channel"]=>
  string(2) "foo"
  ["payload"]=>
  string(4) "test"
}

All Methods

Method	Description
subscribe(string ...$channels) : void	Add subscriptions
unsubscribe(string ...$channels) : void	Cancel subscriptions
psubscribe(string ...$channels) : void	Add pattern subscriptions
punsubscribe(string ...$channels) : void	Cancel pattern subscriptions
channel() : Hyperf\Engine\Channel	Retrieve the message channel
close() : void	Close the subscription

License

MIT