Module: Redis::KeyspaceNotifications

Relationships & Source Files
Namespace Children
Modules: `Channels`, `Parser`
Classes: `Manager`, `Notification`
Exceptions: `ParseError`
Defined in:	lib/redis/keyspace_notifications.rb, lib/redis/keyspace_notifications/channels.rb, lib/redis/keyspace_notifications/manager.rb, lib/redis/keyspace_notifications/notification.rb, lib/redis/keyspace_notifications/parser.rb

Overview

Keyspace, keyevent and (Redis 8.8+) subkey notification support, layered on pub/sub.

Layer 1 — Channels builders and Parser are usable directly inside the existing subscribe/psubscribe DSL. Layer 2 — Manager (built via #keyspace_notifications) owns a dedicated connection and background thread and dispatches parsed Notification objects to handlers.

Notifications must be enabled on the server via the notify-keyspace-events configuration (a server-side, per-node setting — this library deliberately does not set it for you). Notification channels are emitted by the server; do not PUBLISH to them manually. See specs/keyspace-notifications/user-guide.md.