# {py:mod}`labthings_fastapi.websockets`

```{py:module} labthings_fastapi.websockets
```

```{autodoc2-docstring} labthings_fastapi.websockets
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`relay_notifications_to_websocket <labthings_fastapi.websockets.relay_notifications_to_websocket>`
  - ```{autodoc2-docstring} labthings_fastapi.websockets.relay_notifications_to_websocket
    :summary:
    ```
* - {py:obj}`process_messages_from_websocket <labthings_fastapi.websockets.process_messages_from_websocket>`
  - ```{autodoc2-docstring} labthings_fastapi.websockets.process_messages_from_websocket
    :summary:
    ```
* - {py:obj}`websocket_endpoint <labthings_fastapi.websockets.websocket_endpoint>`
  - ```{autodoc2-docstring} labthings_fastapi.websockets.websocket_endpoint
    :summary:
    ```
````

### API

````{py:function} relay_notifications_to_websocket(websocket: fastapi.WebSocket, receive_stream: anyio.abc.ObjectReceiveStream) -> None
:canonical: labthings_fastapi.websockets.relay_notifications_to_websocket
:async:

```{autodoc2-docstring} labthings_fastapi.websockets.relay_notifications_to_websocket
```
````

````{py:function} process_messages_from_websocket(websocket: fastapi.WebSocket, send_stream: anyio.abc.ObjectSendStream, thing: labthings_fastapi.thing.Thing) -> None
:canonical: labthings_fastapi.websockets.process_messages_from_websocket
:async:

```{autodoc2-docstring} labthings_fastapi.websockets.process_messages_from_websocket
```
````

````{py:function} websocket_endpoint(thing: labthings_fastapi.thing.Thing, websocket: fastapi.WebSocket) -> None
:canonical: labthings_fastapi.websockets.websocket_endpoint
:async:

```{autodoc2-docstring} labthings_fastapi.websockets.websocket_endpoint
```
````