File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -51,14 +51,6 @@ def __str__(self):
5151 def recv (self , timeout = None ):
5252 """Block waiting for a message from the Bus.
5353
54- If the concrete bus does not override it, this method makes sure
55- that all filters have been applied. That is the case for all
56- internal interfaces.
57-
58- To enable receiving for an interface, please override
59- :meth:`~can.BusABC._recv_internal` instead of this one.
60- Overriding this method is deprecated.
61-
6254 :param float timeout:
6355 seconds to wait for a message or None to wait indefinitely
6456
Original file line number Diff line number Diff line change @@ -48,7 +48,7 @@ About the ``BusABC`` class
4848Concrete implementations *have to * implement the following:
4949 * :meth: `~can.BusABC.send ` to send individual messages
5050 * :meth: `~can.BusABC._recv_internal ` to receive individual messages
51- (see note below)
51+ (see note below! )
5252 * set the :attr: `~can.BusABC.channel_info ` attribute to a string describing
5353 the underlying bus and/or channel
5454
@@ -69,11 +69,15 @@ They *might* implement the following:
6969
7070.. note ::
7171
72+ *TL;DR *: Only override :meth: `~can.BusABC._recv_internal `,
73+ never :meth: `~can.BusABC.recv ` directly.
74+
7275 Previously, concrete bus classes had to override :meth: `~can.BusABC.recv `
7376 directly instead of :meth: `~can.BusABC._recv_internal `, but that has
7477 changed to allow the abstract base class to handle in-software message
75- filtering as a fallback. Older (custom) interfaces might still be
76- implemented like that and thus might not provide message filtering.
78+ filtering as a fallback. All internal interfaces now implement that new
79+ behaviour. Older (custom) interfaces might still be implemented like that
80+ and thus might not provide message filtering:
7781
7882
7983Creating a Release
You can’t perform that action at this time.
0 commit comments