Skip to content

Commit a0b0b8b

Browse files
committed
Merge branch '6.3' into 6.4
* 6.3: Improve handler options description
2 parents 49146be + 5955fd4 commit a0b0b8b

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

messenger.rst

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2181,11 +2181,16 @@ You can configure your handler by passing options to the attribute::
21812181

21822182
Possible options to configure with the attribute are:
21832183

2184-
* ``bus``
2185-
* ``fromTransport``
2186-
* ``handles``
2187-
* ``method``
2188-
* ``priority``
2184+
============================ ====================================================================================================
2185+
Option Description
2186+
============================ ====================================================================================================
2187+
``bus`` Name of the bus from which the handler can receive messages, by default all buses.
2188+
``fromTransport`` Name of the transport from which the handler can receive messages, by default all transports.
2189+
``handles`` Type of messages (FQCN) that can be processed by the handler, only needed if can't be guessed by
2190+
type-hint.
2191+
``method`` Name of the method that will process the message, only if the target is a class.
2192+
``priority`` Priority of the handler when multiple handlers can process the same message.
2193+
============================ ====================================================================================================
21892194

21902195
.. _messenger-handler-config:
21912196

@@ -2244,11 +2249,16 @@ by tagging the handler service with ``messenger.message_handler``
22442249
22452250
Possible options to configure with tags are:
22462251

2247-
* ``bus``
2248-
* ``from_transport``
2249-
* ``handles``
2250-
* ``method``
2251-
* ``priority``
2252+
============================ ====================================================================================================
2253+
Option Description
2254+
============================ ====================================================================================================
2255+
``bus`` Name of the bus from which the handler can receive messages, by default all buses.
2256+
``from_transport`` Name of the transport from which the handler can receive messages, by default all transports.
2257+
``handles`` Type of messages (FQCN) that can be processed by the handler, only needed if can't be guessed by
2258+
type-hint.
2259+
``method`` Name of the method that will process the message.
2260+
``priority`` Priority of the handler when multiple handlers can process the same message.
2261+
============================ ====================================================================================================
22522262

22532263
.. _handler-subscriber-options:
22542264

0 commit comments

Comments
 (0)