# {py:mod}`bluesky_tiled_plugins.streaming`

```{py:module} bluesky_tiled_plugins.streaming
```

```{autodoc2-docstring} bluesky_tiled_plugins.streaming
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`BlueskyStreamUpdate <bluesky_tiled_plugins.streaming.BlueskyStreamUpdate>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate
    :summary:
    ```
* - {py:obj}`BlueskyStreamSubscription <bluesky_tiled_plugins.streaming.BlueskyStreamSubscription>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamSubscription
    :summary:
    ```
````

### Functions

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

* - {py:obj}`subscribe_to_streams <bluesky_tiled_plugins.streaming.subscribe_to_streams>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.streaming.subscribe_to_streams
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <bluesky_tiled_plugins.streaming.logger>`
  - ```{autodoc2-docstring} bluesky_tiled_plugins.streaming.logger
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: bluesky_tiled_plugins.streaming.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.logger
```

````

`````{py:class} BlueskyStreamUpdate
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate
```

````{py:attribute} run_uid
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.run_uid
:type: str
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.run_uid
```

````

````{py:attribute} stream_name
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.stream_name
:type: str
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.stream_name
```

````

````{py:attribute} data_keys
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.data_keys
:type: tuple[str, ...]
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.data_keys
```

````

````{py:attribute} update
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.update
:type: tiled.client.stream.LiveArrayData | tiled.client.stream.LiveArrayRef | tiled.client.stream.LiveTableData
:value: >
   None

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.update
```

````

````{py:attribute} sequence
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.sequence
:type: int
:value: >
   0

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.sequence
```

````

````{py:method} data() -> typing.Any
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.data

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamUpdate.data
```

````

`````

`````{py:class} BlueskyStreamSubscription(container: tiled.client.container.Container, streams: collections.abc.Mapping[str, tuple[str, ...] | None] | None, callback: collections.abc.Callable[[bluesky_tiled_plugins.streaming.BlueskyStreamUpdate], None], *, start: int | None, max_size: int, run_filter: collections.abc.Callable[[tiled.client.stream.LiveChildCreated], bool] | None)
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamSubscription

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamSubscription
```

````{py:property} closed
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamSubscription.closed
:type: bool

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamSubscription.closed
```

````

````{py:method} disconnect() -> None
:canonical: bluesky_tiled_plugins.streaming.BlueskyStreamSubscription.disconnect

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.BlueskyStreamSubscription.disconnect
```

````

`````

````{py:function} subscribe_to_streams(container: tiled.client.container.Container, callback: collections.abc.Callable[[bluesky_tiled_plugins.streaming.BlueskyStreamUpdate], None], *, streams: collections.abc.Mapping[str, str | collections.abc.Iterable[str] | None] | None, metadata_filter: collections.abc.Callable[[collections.abc.Mapping[str, typing.Any]], bool] | None = None, required_specs: str | collections.abc.Iterable[str] | None = None, run_filter: collections.abc.Callable[[tiled.client.stream.LiveChildCreated], bool] | None = None, start: int | None = 0, max_size: int = 1000000) -> bluesky_tiled_plugins.streaming.BlueskyStreamSubscription
:canonical: bluesky_tiled_plugins.streaming.subscribe_to_streams

```{autodoc2-docstring} bluesky_tiled_plugins.streaming.subscribe_to_streams
```
````