Web.SocketIO

How to use this module

Note that most of the string literals below are of type Text.

{-\# LANGUAGE OverloadedStrings \#-}

import Web.SocketIO

-- listens to port 4000
main = server 4000 $ do

    -- send something to the client
    emit "some event" ["hey"]

    -- ping-pong
    on "ping" $ do
        emit "pong" []

    -- do some IO
    on "Kim Jong-Un" $ liftIO launchMissile
        

Running a standalone server

server :: Port -> HandlerM () -> IO ()

Run a socket.io application, build on top of Warp.

serverConfig :: Port -> Configuration -> HandlerM () -> IO ()

Run a socket.io application with configurations applied.

defaultConfig :: Configuration

Default configurations to be overridden.

 defaultConfig :: Configuration
 defaultConfig = Configuration
    {   transports = [XHRPolling]
    ,   logLevel = 3                
    ,   closeTimeout = 60
    ,   pollingDuration = 20
    ,   heartbeats = True
    ,   heartbeatTimeout = 60
    ,   heartbeatInterval = 25
    }

data Configuration

Constructors

Configuration

Fields

transports :: [Transport]

logLevel :: Int

heartbeats :: Bool

closeTimeout :: Int

heartbeatTimeout :: Int

heartbeatInterval :: Int

pollingDuration :: Int

Instances

Show Configuration

type Port = Int

data Transport

Now only xhr-polling is supported.

Constructors

XHRPolling

Instances

Eq Transport

Show Transport

Sending and receiving events

class Subscriber m where

Receiving events.

Methods

on

Arguments

:: Event

event to listen to

-> CallbackM ()

callback

-> m ()

Instances

Subscriber HandlerM

class Publisher m where

Sending events

Methods

emit

Arguments

:: Event

event to trigger

-> [Text]

message to carry with

-> m ()

Sends a message to the socket that starts it.

 emit "launch" ["missile", "nuke"] 

broadcast

Arguments

:: Event

event to trigger

-> [Text]

message to carry with

-> m ()

Sends a message to everyone else except for the socket that starts it.

 broadcast "hide" ["nukes coming!"] 

Instances

Publisher CallbackM

Publisher HandlerM

reply :: CallbackM [Text]

messages carried with the event

 on "echo" $ do
     messages <- reply
     liftIO $ print messages

type Event = Text

Special events

On disconnection

 on "disconnect" $ do
     liftIO $ print "client disconnected"

Types

data HandlerM a

Capable of both sending and receiving events.

Use liftIO if you wanna do some IO here.

Instances

Monad HandlerM

Functor HandlerM

Applicative HandlerM

MonadIO HandlerM

Subscriber HandlerM

Publisher HandlerM

MonadBase IO HandlerM

data CallbackM a

Capable of only sending events.

Use liftIO if you wanna do some IO here.

Instances

Monad CallbackM

Functor CallbackM

Applicative CallbackM

MonadIO CallbackM

Publisher CallbackM

MonadBase IO CallbackM