https://github.com/tfausak/wuss

:lock: Secure WebSocket (WSS) clients in Haskell.
https://github.com/tfausak/wuss

haskell

Last synced: 3 months ago
JSON representation

:lock: Secure WebSocket (WSS) clients in Haskell.

• Host: GitHub
• URL: https://github.com/tfausak/wuss
• Owner: tfausak
• License: mit
• Created: 2015-04-15T13:53:42.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-05-19T13:42:08.000Z (9 months ago)
• Last Synced: 2024-05-19T14:44:29.248Z (9 months ago)
• Topics: haskell
• Language: Haskell
• Homepage: https://hackage.haskell.org/package/wuss
• Size: 88.9 KB
• Stars: 69
• Watchers: 3
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Wuss

[![CI](https://github.com/tfausak/wuss/actions/workflows/ci.yml/badge.svg)](https://github.com/tfausak/wuss/actions/workflows/ci.yml)

[![Hackage](https://badgen.net/hackage/v/wuss)](https://hackage.haskell.org/package/wuss)

Secure WebSocket (WSS) clients in Haskell.

---

Wuss is a library that lets you easily create secure WebSocket clients over the

WSS protocol. It is a small addition to [the `websockets` package][] and is

adapted from existing solutions by [@jaspervdj][], [@mpickering][], and

[@elfenlaid][].

-   [Installation](#installation)

-   [Usage](#usage)

## Installation

To add Wuss as a dependency to your package, add it to your Cabal file.

```

build-depends: wuss

```

For other use cases, install it with Cabal.

``` sh

$ cabal install wuss

```

## Usage

``` hs

import Wuss

import Control.Concurrent (forkIO)

import Control.Monad (forever, unless, void)

import Data.Text (Text, pack)

import Network.WebSockets (ClientApp, receiveData, sendClose, sendTextData)

main :: IO ()

main = runSecureClient "echo.websocket.org" 443 "/" ws

ws :: ClientApp ()

ws connection = do

    putStrLn "Connected!"

    void . forkIO . forever $ do

        message <- receiveData connection

        print (message :: Text)

    let loop = do

            line <- getLine

            unless (null line) $ do

                sendTextData connection (pack line)

                loop

    loop

    sendClose connection (pack "Bye!")

```

For more information about Wuss, please read [the Haddock documentation][].

[the `websockets` package]: https://hackage.haskell.org/package/websockets

[@jaspervdj]: https://gist.github.com/jaspervdj/7198388

[@mpickering]: https://gist.github.com/mpickering/f1b7ba3190a4bb5884f3

[@elfenlaid]: https://gist.github.com/elfenlaid/7b5c28065e67e4cf0767

[semantic versioning]: http://semver.org/spec/v2.0.0.html

[the change log]: CHANGELOG.md

[the haddock documentation]: https://hackage.haskell.org/package/wuss