ghcjs-websockets: Deprecated: use ghcjs-base's native websockets
Documentation online at http://mstksg.github.io/ghcjs-websockets/JavaScript-WebSockets.html
Deprecated in favor of ghcjs-base's native websockets.
'ghcjs-websockets' aims to provide a clean, idiomatic,
efficient, low-level, out-of-your-way, bare bones,
concurrency-aware interface with minimal abstractions
over the Javascript Websockets API
http://www.w3.org/TR/websockets/,
inspired by common Haskell idioms found in libraries like
'io-stream'
http://hackage.haskell.org/package/io-streams and the
server-side websockets
http://hackage.haskell.org/package/websockets library,
targeting compilation to Javascript with ghcjs
.
The interface asbtracts websockets as simple IO/file
handles, with additional access to the natively "typed"
(text vs binary) nature of the Javascript Websockets API.
There are also convenience functions to directly decode
serialized data (serialized with binary
http://hackage.haskell.org/package/binary) sent through
channels.
The library is mostly intended to be a low-level FFI library, with the hopes that other, more advanced libraries maybe build on the low-level FFI bindings in order to provide more advanced and powerful abstractions. Most design decisions were made with the intent of keeping things as simple as possible in order for future libraries to abstract over it.
Most of the necessary functionality is in hopefully in
JavaScript.WebSockets
; more of the low-level API is
exposed in JavaScript.WebSockets.Internal
if you need
it for library construction.
See the JavaScript.WebSockets
module for detailed usage
instructions and examples.
Some examples:
import Data.Text (unpack) -- A simple echo client, echoing all incoming text data main :: IO () main = withUrl "ws://my-server.com" $ \conn -> forever $ do t <- receiveText conn putStrLn (unpack t) sendText conn t
-- A simple client waiting for connections and outputting the running sum main :: IO () main = withUrl "ws://my-server.com" (runningSum 0) runningSum :: Int -> Connection -> IO () runningSum n conn = do i <- receiveData conn print (n + i) runningSum (n + i) conn
-- Act as a relay between two servers main :: IO () main = do conn1 <- openConnection "ws://server-1.com" conn2 <- openConnection "ws://server-2.com" forever $ do msg <- receiveMessage conn1 sendMessage conn2 msg closeConnection conn2 closeConnection conn1
[Skip to Readme]
Flags
Automatic Flags
Name | Description | Default |
---|---|---|
ghcjs | Tell cabal we are using ghcjs (work around until hackage supports impl(ghcjs)) | Enabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- ghcjs-websockets-0.3.0.5.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
Versions [RSS] | 0.3.0.0, 0.3.0.1, 0.3.0.2, 0.3.0.3, 0.3.0.4, 0.3.0.5 (info) |
---|---|
Change log | CHANGELOG.md |
Dependencies | base (>=4.7 && <5), base64-bytestring (>=1), binary (>=0.7), bytestring (>=0.10), ghcjs-base (>=0.1), text (>=1) [details] |
License | MIT |
Copyright | Copyright (c) Justin Le 2015 |
Author | Justin Le <justin@jle.im> |
Maintainer | Justin Le <justin@jle.im> |
Revised | Revision 1 made by jle at 2016-10-23T09:28:13Z |
Category | Web |
Home page | http://github.com/mstksg/ghcjs-websockets |
Source repo | head: git clone https://github.com/mstksg/ghcjs-websockets |
Uploaded | by jle at 2015-08-08T07:25:11Z |
Distributions | |
Reverse Dependencies | 1 direct, 0 indirect [details] |
Downloads | 3688 total (12 in the last 30 days) |
Rating | (no votes yet) [estimated by Bayesian average] |
Your Rating | |
Status | Docs available [build log] Last success reported on 2015-08-08 [all 1 reports] |