events

Yield pushed event envelopes until the server closes the socket. The subscription must already be open, normally through a with block.

Yield pushed event payloads until the server closes the socket.

Raises:

Type	Description
RuntimeError	If the subscription has not been opened with with.

Example

with client.subscribe([{"event": "pane.output"}]) as stream:
    for event in stream.events():
        print(event["event"])

Source code in src/herdr_client/sync/client.py

def events(self) -> Iterator[EventEnvelope]:
    """Yield pushed event payloads until the server closes the socket.

    Raises:
        RuntimeError: If the subscription has not been opened with ``with``.

    Example:
        ```python
        with client.subscribe([{"event": "pane.output"}]) as stream:
            for event in stream.events():
                print(event["event"])
        ```
    """
    file = self._file
    if file is None or self._socket is None:
        raise RuntimeError("subscription has not been opened")

    while True:
        line = read_line(file)
        if line == b"":
            return
        if line.strip() == b"":
            continue
        yield event_envelope(decode_json(line))