|
42 | 42 | //|
|
43 | 43 | //| Accumulates a Characteristic's incoming packets in a FIFO buffer and facilitates packet aware
|
44 | 44 | //| outgoing writes. A packet's size is either the characteristic length or the maximum transmission
|
45 |
| -//| unit (MTU), whichever is smaller. The MTU can change so check `incoming_packet_length` before creating a |
| 45 | +//| unit (MTU), whichever is smaller. The MTU can change so check `packet_size` before creating a |
46 | 46 | //| buffer to store data.
|
47 | 47 | //|
|
48 | 48 | //| When we're the server, we ignore all connections besides the first to subscribe to
|
@@ -97,7 +97,7 @@ STATIC void check_for_deinit(bleio_packet_buffer_obj_t *self) {
|
97 | 97 | //| .. method:: readinto(buf)
|
98 | 98 | //|
|
99 | 99 | //| Reads a single BLE packet into the ``buf``. Raises an exception if the next packet is longer
|
100 |
| -//| than the given buffer. Use `incoming_packet_length` to read the maximum length of a single packet. |
| 100 | +//| than the given buffer. Use `packet_size` to read the maximum length of a single packet. |
101 | 101 | //|
|
102 | 102 | //| :return: number of bytes read and stored into ``buf``
|
103 | 103 | //| :rtype: int
|
@@ -171,7 +171,7 @@ STATIC MP_DEFINE_CONST_FUN_OBJ_1(bleio_packet_buffer_deinit_obj, bleio_packet_bu
|
171 | 171 | //| Maximum size of a packet.
|
172 | 172 | //| If the packet is arriving from a remote service via notify or indicate,
|
173 | 173 | //| the maximum size is `Connection.max_packet_length`.
|
174 |
| -//| Otherwise it is the ``max_length`` of the `Characteristic`. |
| 174 | +//| Otherwise it is the ``max_length`` of the :py:class:`~_bleio.Characteristic`. |
175 | 175 | //|
|
176 | 176 | STATIC mp_obj_t bleio_packet_buffer_get_packet_size(mp_obj_t self_in) {
|
177 | 177 | bleio_packet_buffer_obj_t *self = MP_OBJ_TO_PTR(self_in);
|
|
0 commit comments