boost::redis::request::psubscribe

Appends a PSUBSCRIBE command to the end of the request.

Synopsis

Declared in <boost/redis/request.hpp>

template<class Range>
void
psubscribe(
    Range&& patterns,
    decltype(std::cbegin(patterns))* = nullptr);

Description

If patterns contains ["news.*", "events.*"], the resulting command is PSUBSCRIBE news.* events.*.

Subscriptions created using this function are tracked to enable PubSub state restoration. After successfully executing the request, the connection will store any newly subscribed channels and patterns. Every time a reconnection happens, a suitable SUBSCRIBE/`PSUBSCRIBE` command is issued automatically, to restore the subscriptions that were active before the reconnection.

PubSub store restoration only happens when using subscribe, unsubscribe, psubscribe or punsubscribe. Subscription commands added by push or push_range are not tracked.

Created with MrDocs