From 7c5efdf314537b4260c670db32f02951b2975d05 Mon Sep 17 00:00:00 2001 From: meejah Date: Fri, 17 Mar 2017 14:55:05 -0600 Subject: [PATCH] add white-/black-list information to docs --- docs/wamp/programming.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/wamp/programming.rst b/docs/wamp/programming.rst index c4ddc57f..14557891 100644 --- a/docs/wamp/programming.rst +++ b/docs/wamp/programming.rst @@ -449,6 +449,11 @@ The corresponding **asyncio** code looks like this counter += 1 await sleep(1) +When publishing, you can pass an `options=` kwarg which is an instance of :class:`PublishOptions `. Many of the options require support from the router. + + - whitelisting and blacklisting (all the `eligible*` and `exclude*` options) can affect which subscribers receive the publish; see `crossbar documentation `_ for more information; + - `retain=` asks the router to retain the message; + - `acknowledge=` asks the router to notify you it received the publish (note that this does *not* wait for every subscriber to have received the publish). .. tip:: By default, a publisher will not receive an event it publishes even when the publisher is *itself* subscribed to the topic subscribed to. This behavior can be overridden; see :class:`PublishOptions ` and ``exclude_me=False``.