Skip to content

Commit ce20abd

Browse files
committed
Merge branch '6.4' into 7.0
* 6.4: Improve handler options description
2 parents b952ee2 + a0b0b8b commit ce20abd

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
@@ -2097,11 +2097,16 @@ You can configure your handler by passing options to the attribute::
20972097

20982098
Possible options to configure with the attribute are:
20992099

2100-
* ``bus``
2101-
* ``fromTransport``
2102-
* ``handles``
2103-
* ``method``
2104-
* ``priority``
2100+
============================ ====================================================================================================
2101+
Option Description
2102+
============================ ====================================================================================================
2103+
``bus`` Name of the bus from which the handler can receive messages, by default all buses.
2104+
``fromTransport`` Name of the transport from which the handler can receive messages, by default all transports.
2105+
``handles`` Type of messages (FQCN) that can be processed by the handler, only needed if can't be guessed by
2106+
type-hint.
2107+
``method`` Name of the method that will process the message, only if the target is a class.
2108+
``priority`` Priority of the handler when multiple handlers can process the same message.
2109+
============================ ====================================================================================================
21052110

21062111
.. _messenger-handler-config:
21072112

@@ -2160,11 +2165,16 @@ by tagging the handler service with ``messenger.message_handler``
21602165
21612166
Possible options to configure with tags are:
21622167

2163-
* ``bus``
2164-
* ``from_transport``
2165-
* ``handles``
2166-
* ``method``
2167-
* ``priority``
2168+
============================ ====================================================================================================
2169+
Option Description
2170+
============================ ====================================================================================================
2171+
``bus`` Name of the bus from which the handler can receive messages, by default all buses.
2172+
``from_transport`` Name of the transport from which the handler can receive messages, by default all transports.
2173+
``handles`` Type of messages (FQCN) that can be processed by the handler, only needed if can't be guessed by
2174+
type-hint.
2175+
``method`` Name of the method that will process the message.
2176+
``priority`` Priority of the handler when multiple handlers can process the same message.
2177+
============================ ====================================================================================================
21682178

21692179
.. _handler-subscriber-options:
21702180

0 commit comments

Comments
 (0)