servant-websockets: Small library providing WebSocket endpoints for servant.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

The 'description' field should be longer than the 'synopsis' field. It's useful to provide an informative 'description' to allow Haskell programmers who have never heard about your package to understand the purpose of your package. The 'description' field content is typically shown by tooling (e.g. 'cabal info', Haddock, Hackage) below the 'synopsis' which serves as a headline. Please refer to <https://www.haskell.org/cabal/users-guide/developing-packages.html#package-properties> for more details.

Small library providing WebSocket endpoints for servant.

[Skip to Readme]

Properties

Versions	1.0.0, 1.1.0, 2.0.0, 2.0.0
Change log	CHANGELOG.md
Dependencies	aeson, async, base (>=4.7 && <5), bytestring, conduit, exceptions, monad-control, resourcet, servant-server, servant-websockets, text, wai, wai-websockets, warp, websockets [details]
License	BSD-3-Clause
Copyright	2017 Lorenz Moesenlechner
Author	Lorenz Moesenlechner
Maintainer	moesenle@gmail.com
Category	Servant, Web
Home page	https://github.com/moesenle/servant-websockets#readme
Source repo	head: git clone https://github.com/moesenle/servant-websockets
Uploaded	by moesenle at 2019-10-27T15:09:21Z

Modules

[Index] [Quick Jump]

Servant
- API
  - Servant.API.WebSocket
  - Servant.API.WebSocketConduit

Downloads

servant-websockets-2.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

moesenle

For package maintainers and hackage trustees

edit package information

Readme for servant-websockets-2.0.0

[back to package description]

Introduction

This small library provides two servant endpoints for implementing websockets and is based on websockets and wai-websockets.

This library provides three servant endpoints: WebSocket, WebSocketPending and WebSocketConduit. WebSocket is is a low-level interface for directly interacting with a Connection (see the websockets library for more information). WebSocketPending allows using the rejectRequest with various return codes for greater control. WebSocketConduit provides a conduit based endpoint for JSON serializable input and output.

See the module documentation for examples.