Web.DDP.Deadpan.DSL

An EDSL designed to make writing deadpan applications easy!

This DSL is a simple decoration of some application specific functions arround a ReaderT monad instance.

A core cabal of functions are exported from this module which are then put to use in web.ddp.deadpan to create an expressive dsl for creating ddp applications.

The main functions exported are...

TODO: Ensure these are up to date...

• rundeadpan
• sethandler
• deletehandler
• setdefaulthandler
• senddata
• sendmessage

these allow you to...

• run a deadpan application with some initial set of callbacks
• set new values for response handlers
• delete existing response handlers
• set a handler to act when no existing handler matches the incomming message
• send an ejsonvalue to the server (low-level)
• send messages to be interpreted as rpc calls

... respectively.

There is also a `control.lens.lens` collections provided into a single ejsonvalue.

This can be used to...

• Retrieve any current collection data
• Set collection data manually
• Perform actions on collection data in callbacks

Documentation

data LookupItem a

The LookupItem data-type is used to store a set of callbacks.

_ident is a reference to the callback, not the expected message id.

Constructors

LI

Fields

_ident :: GUID

_body :: a

ident :: forall a. Lens' (LookupItem a) GUID

body :: forall a a. Lens (LookupItem a) (LookupItem a) a a

type Lookup a = Seq (LookupItem a)

data AppState cb

Constructors

AppState

Fields

_callbackSet :: Lookup cb

Callbacks to match against by message

_collections :: EJsonValue

Shared data Expected to be an EJObject

_connection :: Connection

Network connection to server

connection :: forall cb. Lens' (AppState cb) Connection

collections :: forall cb. Lens' (AppState cb) EJsonValue

callbackSet :: forall cb cb. Lens (AppState cb) (AppState cb) (Lookup cb) (Lookup cb)

type Callback = EJsonValue -> DeadpanApp ()

newtype DeadpanApp a

Constructors

DeadpanApp

Fields

_deadpanApp :: ReaderT (TVar (AppState Callback)) IO a

Instances

Monad DeadpanApp

Functor DeadpanApp

Applicative DeadpanApp

MonadIO DeadpanApp

deadpanApp :: forall a a. Iso (DeadpanApp a) (DeadpanApp a) (ReaderT (TVar (AppState Callback)) IO a) (ReaderT (TVar (AppState Callback)) IO a)

data Version

Constructors

Vpre1

Vpre2

V1

Instances

Bounded Version

Enum Version

Eq Version

Ord Version

Read Version

Show Version

version2string :: Version -> EJsonValue

reverseVersions :: [EJsonValue]

runDeadpan :: DeadpanApp a -> TVar (AppState Callback) -> IO a

The order of these args match that of runReaderT

newID :: DeadpanApp GUID

addHandler :: LookupItem Callback -> DeadpanApp ()

setHandler :: GUID -> Callback -> DeadpanApp GUID

onMatches :: EJsonValue -> Callback -> Callback

setMatchHandler :: EJsonValue -> Callback -> DeadpanApp GUID

setIdHandler :: GUID -> Callback -> DeadpanApp GUID

setMsgHandler :: Text -> Callback -> DeadpanApp GUID

setCatchAllHandler :: Callback -> DeadpanApp GUID

deleteHandlerID :: GUID -> DeadpanApp ()

modifyAppState :: (AppState Callback -> AppState Callback) -> DeadpanApp ()

getAppState :: DeadpanApp (AppState Callback)

Get the raw app state. Reads the value out of the TVar container.

getAppStateL :: Prism' (AppState Callback) x -> DeadpanApp (Maybe x)

Get the app state in conjunction with a Prism, allowing for more succing state access

getCollections :: DeadpanApp EJsonValue

sendData :: EJsonValue -> DeadpanApp ()

A low-level function intended to be able to send any arbitrary data to the server. Given that all messages to the server are intended to fit the "message" format, You should probably use sendMessage instead.

sendMessage :: Text -> EJsonValue -> DeadpanApp ()

Send a particular type of message (indicated by the key) to the server. This should be the primary means of [client -> server] communication by a client application.

connectVersion :: Version -> DeadpanApp ()

Send a connection message to the server and specify the DDP API version that you wish to use.

connect :: DeadpanApp ()

Send a generic connection message to the server.

fork :: DeadpanApp a -> DeadpanApp ThreadId

Provides a way to fork a background thread running the app provided

fetchMessagesThenExit :: DeadpanApp a -> DeadpanApp a

Runs fetchMessages and kills the thread when the supplied app finishes.

Note: Any DeadpanApp calls made after this one will not be able to interact with server-sent messages.

fetchMessages :: DeadpanApp ThreadId

Continuously pull down messages from the server in a background thread and respond to each message with the callback set. Returns a ThreadId so that this can be killed explicitly before the program exits in order to avoid the "recv: invalid argument (Bad file descriptor)" error.

getServerMessage :: DeadpanApp (Maybe EJsonValue)

respondToMessage :: Lookup Callback -> Maybe EJsonValue -> DeadpanApp ()

Loop through all callbacks

Each callback is responsible for discarding messages that it doesn't care about...

module Data.EJson

module Web.DDP.Deadpan.GUID

data Text :: *

A space efficient, packed, unboxed Unicode text type.

Instances

Chunk Text

Hashable Text

Semigroup Text

Ixed Text

WebSocketsData Text

Strict Text Text

Cons Text Text Char Char

Snoc Text Text Char Char

type State Text = Buffer

type ChunkElem Text = Char

type Item Text = Char

type Index Text = Int

type IxValue Text = Char

pack :: String -> Text

O(n) Convert a String into a Text. Subject to fusion. Performs replacement on invalid scalar values.