yesod-websockets

WebSockets support for Yesod

Version on this page:	0.3.0.2
LTS Haskell 20.25:	0.3.0.3
Stackage Nightly 2023-06-10:	0.3.0.3
Latest on Hackage:	0.3.0.3

See all snapshots yesod-websockets appears in

MIT licensed by Michael Snoyman

Maintained by michael@snoyman.com

This version can be pinned in stack with:yesod-websockets-0.3.0.2@sha256:fc9cd6b12a5fece57bfc8908d00fc730b7d39b9e5e31e6b1abd21f454f04e1d7,1031

Module documentation for 0.3.0.2

Yesod
- Yesod.WebSockets

Depends on 8 packages(full list with versions):

base, conduit, mtl, transformers, unliftio, wai-websockets, websockets, yesod-core

REQUIRED PACKAGES

The example, chat.hs, requires stm-lifted and conduit-combinators which are not dependencies of yesod-websockets. Installing the extra packages needed for the chat.hs example can be installed with the command:

$ cabal install stm-lifted conduit-combinators

TIMEOUTS

Versions of yesod-websockets prior to 0.2.1 may experience session timeouts after about 30 seconds of inactivity. Refer to the patch in the websockets library which addresses this issue:

https://github.com/jaspervdj/websockets/commit/536849d1f3265076f61edefd5c89e84e82a99c71

Changes

0.3.0.2

sendClose and sendPing correctly find the Connection from WebSocketsT

Previously, these types were incorrectly typed to look for the Connection on the m of WebSocketsT m (), and not via WebSocketsT itself. Because this made them practically impossible to use, this change is unlikely to break any existing code.

0.3.0.1

Minor cabal file improvements

0.3.0

Upgrade to yesod-core 1.6

0.2.6

Fix warnings

0.2.5

Allow to start websockets with custom ConnectionOptions with webSocketsOptions and webSocketsOptionsWith

0.2.4.1

Support for websockets 0.10

0.2.3

receiveDataMessageE and sendDataMessageE

0.2.2

Add exceptional websocket commands #772