servant-subscriber: When REST is not enough ...

[ bsd3, library, program, web ] [ Propose Tags ]

Please see Readme.md


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.2.0.0, 0.2.0.1, 0.3.0.0, 0.4.0.0, 0.5.0.0, 0.5.0.1, 0.5.0.2, 0.5.0.3, 0.6.0.0, 0.6.0.1, 0.6.0.2
Dependencies aeson (>=0.11.2 && <0.12), async, attoparsec, base (>=4.7 && <5), blaze-builder, bytestring, case-insensitive, containers, directory (>=1.2.2.0), filepath, http-types, lens, lifted-base, monad-control, monad-logger, network-uri, purescript-bridge (==0.6.*), servant, servant-foreign, servant-server, servant-subscriber, stm, text, time, transformers, wai, wai-websockets, warp, websockets [details]
License BSD-3-Clause
Copyright Copyright: (c) 2016 Robert Klotzner
Author Robert Klotzner
Maintainer robert Dot klotzner A T gmx Dot at
Category Web
Home page http://github.com/eskimor/servant-subscriber#readme
Source repo head: git clone https://github.com/eskimor/servant-subscriber
Uploaded by eskimo at Sun Jul 24 05:52:45 UTC 2016
Distributions NixOS:0.6.0.2
Executables psGenerator
Downloads 3546 total (227 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2016-11-22 [all 3 reports]

Modules

  • Servant
    • Servant.Subscriber
      • Servant.Subscriber.Backend
        • Servant.Subscriber.Backend.Wai
      • Servant.Subscriber.Client
      • Servant.Subscriber.Request
      • Servant.Subscriber.Response
      • Servant.Subscriber.Subscribable
      • Servant.Subscriber.Types

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for servant-subscriber-0.2.0.0

[back to package description]

Servant Subscriber

Build Status

Servant-subscriber enables you clients to subscribe to resources in your servant-api (an API endpoint). Servant-subscriber will then notify the client via a WebSocket connection whenever the resource changes, thus the client can easily stay up to date with a resource.

Status

It seems to work - it is already tested in examples/central-counter of servant-purescript.

Still missing:

  • Client code generation with servant-purescript for subscriptions.
  • Client side code (purescript-subscriber) currently only contains a very low-level API which is also about to change.
  • Documentation, blog post.
  • Tests

I will now continue with my actual project which uses servant-subscriber and add the missing parts when they come along.