hardbyte / hardbyte/python-can

SocketcanBus.send() timeout semantics differ from BusABC.send()

Open
#2,005 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
1.6k
Forks
697
PR merge metrics
No merged PRs in 30d

Description

### Describe the bug
In the `send()` method of `BusABC`, the optional `timeout` argument is documented as
```
If > 0, wait up to this many seconds for message to be ACK'ed or
for transmit queue to be ready depending on driver implementation.
If timeout is exceeded, an exception will be raised.
Might not be supported by all interfaces.
None blocks indefinitely.
```

but the `SocketcanBus` implementation of `BusABC` documents (and implements) it like this:
```
Wait up to this many seconds for the transmit queue to be ready.
If not given, the call may fail immediately.
```

It looks to me like the handling in `SocketcanBus` just doesn't conform to the expected interface, in particular it does
```python
# If no timeout is given, poll for availability
if timeout is None:
timeout = 0
```
which results in nonblocking behavior and potentially raising `can.CanOperationError("Transmit buffer full")` instead of waiting indefinitely when no timeout is specified.

### To Reproduce
```python
msg = can.Message(
arbitration_id=0x123, is_extended_id=False, data=[1, 2, 3, 4, 5, 6, 7, 8]
)
with can.Bus(interface="socketcan", channel="can0") as bus:
for i in range(10000):
bus.send(msg)
```
Observe that sending fails if the sending rate exceeds the capacity of the bus, instead of blocking and waiting.

### Expected behavior
As the timeout is `None`, blocking indefinitely until the transmit queue is ready, as specified in the `BusABC.send()` docs.

### Additional context

OS and version: Ubuntu 24.04.3 LTS, 6.14.0-35-generic
Python version: Python 3.12.3
python-can version: 4.3.1
python-can interface/s (if applicable): socketcan, F81601 interface (PCI), Manufacturer provided driver

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.