Reads a message from the WebSocket server. If on_message_callback was specified at WebSocket initialization, this function will never return messages Returns a future whose result is the message, or None if the connection is closed. If a callback argument i
(
self,
callback: Optional[Callable[["Future[Union[None, str, bytes]]"], None]] = None,
)
| 1500 | return self.protocol.write_message(message, binary=binary) |
| 1501 | |
| 1502 | def read_message( |
| 1503 | self, |
| 1504 | callback: Optional[Callable[["Future[Union[None, str, bytes]]"], None]] = None, |
| 1505 | ) -> Awaitable[Union[None, str, bytes]]: |
| 1506 | """Reads a message from the WebSocket server. |
| 1507 | |
| 1508 | If on_message_callback was specified at WebSocket |
| 1509 | initialization, this function will never return messages |
| 1510 | |
| 1511 | Returns a future whose result is the message, or None |
| 1512 | if the connection is closed. If a callback argument |
| 1513 | is given it will be called with the future when it is |
| 1514 | ready. |
| 1515 | """ |
| 1516 | |
| 1517 | awaitable = self.read_queue.get() |
| 1518 | if callback is not None: |
| 1519 | self.io_loop.add_future(asyncio.ensure_future(awaitable), callback) |
| 1520 | return awaitable |
| 1521 | |
| 1522 | def on_message(self, message: Union[str, bytes]) -> Optional[Awaitable[None]]: |
| 1523 | return self._on_message(message) |