boost::redis::request::subscribe

Appends a SUBSCRIBE command to the end of the request.

Synopsis

Declared in <boost/redis/request.hpp>

template<class ForwardIt>
void
subscribe(
    ForwardIt channels_begin,
    ForwardIt channels_end);

Description

[`channels_begin`, channels_end) should point to a valid range of elements convertible to std::string_view. If the range contains ["ch1", "ch2"], the resulting command is SUBSCRIBE ch1 ch2.]

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