# off_broadway_websocket v1.2.2 - Table of Contents

> An Off-Broadway producer enabling real-time ingestion of WebSocket data.

## Pages

- Project
  - [README](readme.md)
  - [Changelog](changelog.md)
  - [LICENSE](license.md)

- Guides
  - [Getting Started](getting_started.md)
  - [Configuration](configuration.md)
  - [Auth Refresh and Handshake Failures](auth_refresh_and_handshake_failures.md)
  - [On Upgrade Bootstrap](on_upgrade_bootstrap.md)
  - [Frame Handler](frame_handler.md)
  - [Retry and Liveness](retry_and_liveness.md)
  - [Telemetry](telemetry.md)

## Modules

- PublicAPI
  - [OffBroadwayWebSocket.Producer](OffBroadwayWebSocket.Producer.md): A `GenStage` producer that streams data from a WebSocket connection.

- Internals
  - [OffBroadwayWebSocket.Client](OffBroadwayWebSocket.Client.md): Provides functions to establish and configure WebSocket connections
using the **gun** library, with customizable timeouts and connection options.

  - [OffBroadwayWebSocket.ClientBehaviour](OffBroadwayWebSocket.ClientBehaviour.md): Behaviour describing the minimal client API used by the producer.
  - [OffBroadwayWebSocket.State](OffBroadwayWebSocket.State.md): Holds the connection and retry state for a WebSocket producer in an Off-Broadway pipeline.

