[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 12/24] python/aqmp: add AsyncProtocol._readline() method
From: |
John Snow |
Subject: |
[PATCH v2 12/24] python/aqmp: add AsyncProtocol._readline() method |
Date: |
Fri, 16 Jul 2021 20:32:41 -0400 |
This is added as a courtesy: many protocols are line-based, including
QMP. Putting it in AsyncProtocol lets us keep the QMP class
implementation just a pinch more abstract.
(And, if we decide to add a QTEST implementation later, it will need
this, too. (Yes, I have a QTEST implementation.))
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/protocol.py | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/python/qemu/aqmp/protocol.py b/python/qemu/aqmp/protocol.py
index 6f83d3e3922..28cd5d9f4fd 100644
--- a/python/qemu/aqmp/protocol.py
+++ b/python/qemu/aqmp/protocol.py
@@ -774,6 +774,35 @@ def _cb_inbound(self, msg: T) -> T:
self.logger.debug("<-- %s", str(msg))
return msg
+ @upper_half
+ @bottom_half
+ async def _readline(self) -> bytes:
+ """
+ Wait for a newline from the incoming reader.
+
+ This method is provided as a convenience for upper-layer
+ protocols, as many are line-based.
+
+ This method *may* return a sequence of bytes without a trailing
+ newline if EOF occurs, but *some* bytes were received. In this
+ case, the next call will raise `EOFError`. It is assumed that
+ the layer 5 protocol will decide if there is anything meaningful
+ to be done with a partial message.
+
+ :raise OSError: For stream-related errors.
+ :raise EOFError:
+ If the reader stream is at EOF and there are no bytes to return.
+ :return: bytes, including the newline.
+ """
+ assert self._reader is not None
+ msg_bytes = await self._reader.readline()
+
+ if not msg_bytes:
+ if self._reader.at_eof():
+ raise EOFError
+
+ return msg_bytes
+
@upper_half
@bottom_half
async def _do_recv(self) -> T:
--
2.31.1
- [PATCH v2 01/24] python/aqmp: add asynchronous QMP (AQMP) subpackage, (continued)
- [PATCH v2 01/24] python/aqmp: add asynchronous QMP (AQMP) subpackage, John Snow, 2021/07/16
- [PATCH v2 02/24] python/aqmp: add error classes, John Snow, 2021/07/16
- [PATCH v2 04/24] python/aqmp: add asyncio compatibility wrappers, John Snow, 2021/07/16
- [PATCH v2 03/24] python/pylint: Add exception for TypeVar names ('T'), John Snow, 2021/07/16
- [PATCH v2 05/24] python/aqmp: add generic async message-based protocol support, John Snow, 2021/07/16
- [PATCH v2 06/24] python/aqmp: add runstate state machine to AsyncProtocol, John Snow, 2021/07/16
- [PATCH v2 07/24] python/aqmp: Add logging utility helpers, John Snow, 2021/07/16
- [PATCH v2 08/24] python/aqmp: add logging to AsyncProtocol, John Snow, 2021/07/16
- [PATCH v2 09/24] python/aqmp: add AsyncProtocol.accept() method, John Snow, 2021/07/16
- [PATCH v2 10/24] python/aqmp: add configurable read buffer limit, John Snow, 2021/07/16
- [PATCH v2 12/24] python/aqmp: add AsyncProtocol._readline() method,
John Snow <=
- [PATCH v2 13/24] python/aqmp: add QMP Message format, John Snow, 2021/07/16
- [PATCH v2 11/24] python/aqmp: add _cb_inbound and _cb_inbound logging hooks, John Snow, 2021/07/16
- [PATCH v2 16/24] python/pylint: disable too-many-function-args, John Snow, 2021/07/16
- [PATCH v2 14/24] python/aqmp: add well-known QMP object models, John Snow, 2021/07/16
- [PATCH v2 17/24] python/aqmp: add QMP protocol support, John Snow, 2021/07/16
- [PATCH v2 18/24] python/pylint: disable no-member check, John Snow, 2021/07/16
- [PATCH v2 15/24] python/aqmp: add QMP event support, John Snow, 2021/07/16
- [PATCH v2 19/24] python/aqmp: Add message routing to QMP protocol, John Snow, 2021/07/16