Web.Rep.Socket

A socket between a web page and haskell, based on the box library.

Documentation

socketPage :: Page

Page with all the trimmings for a sharedRep Box

defaultSocketPage :: Page

Bootstrapped base page for a web socket.

data SocketConfig

Socket configuration

>>> defaultSocketConfig
SocketConfig {host = "127.0.0.1", port = 9160, path = "/"}

Constructors

SocketConfig

Fields

• host :: Text
• port :: Int
• path :: Text

Instances

Generic SocketConfig

Defined in Web.Rep.Socket

Associated Types

type Rep SocketConfig :: Type -> Type

Methods

from :: SocketConfig -> Rep SocketConfig x

to :: Rep SocketConfig x -> SocketConfig

Show SocketConfig

Defined in Web.Rep.Socket

Methods

showsPrec :: Int -> SocketConfig -> ShowS

show :: SocketConfig -> String

showList :: [SocketConfig] -> ShowS

Eq SocketConfig

Defined in Web.Rep.Socket

Methods

(==) :: SocketConfig -> SocketConfig -> Bool

(/=) :: SocketConfig -> SocketConfig -> Bool

type Rep SocketConfig

Defined in Web.Rep.Socket

type Rep SocketConfig = D1 ('MetaData "SocketConfig" "Web.Rep.Socket" "web-rep-0.12.3.0-E5Upzoz1WN63xERmXwdVK2" 'False) (C1 ('MetaCons "SocketConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

defaultSocketConfig :: SocketConfig

official default

serveSocketBox :: SocketConfig -> Page -> Box IO Text Text -> IO ()

bidirectional websocket serving a Box

type CodeBox = Box IO [Code] (ByteString, ByteString)

A common Box pattern. [Code] is typically committed to the websocket and key-value elements, representing changes to the shared objects that are in the Dom are emitted.

type CoCodeBox = Codensity IO (Box IO [Code] (ByteString, ByteString))

Codensity CodeBox

data CodeBoxConfig

Configuration for a CodeBox serving.

Constructors

CodeBoxConfig

Fields

• codeBoxSocket :: SocketConfig
• codeBoxPage :: Page
• codeBoxCommitterQueue :: Queue [Code]
• codeBoxEmitterQueue :: Queue (ByteString, ByteString)

Instances

Generic CodeBoxConfig

Defined in Web.Rep.Socket

Associated Types

type Rep CodeBoxConfig :: Type -> Type

Methods

from :: CodeBoxConfig -> Rep CodeBoxConfig x

to :: Rep CodeBoxConfig x -> CodeBoxConfig

type Rep CodeBoxConfig

Defined in Web.Rep.Socket

type Rep CodeBoxConfig = D1 ('MetaData "CodeBoxConfig" "Web.Rep.Socket" "web-rep-0.12.3.0-E5Upzoz1WN63xERmXwdVK2" 'False) (C1 ('MetaCons "CodeBoxConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "codeBoxSocket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SocketConfig) :*: S1 ('MetaSel ('Just "codeBoxPage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Page)) :*: (S1 ('MetaSel ('Just "codeBoxCommitterQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Queue [Code])) :*: S1 ('MetaSel ('Just "codeBoxEmitterQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Queue (ByteString, ByteString))))))

defaultCodeBoxConfig :: CodeBoxConfig

official default config.

codeBox :: CoCodeBox

Turn the default configuration into a live (Codensity) CodeBox

codeBoxWith :: CodeBoxConfig -> CoCodeBox

Turn a configuration into a live (Codensity) CodeBox

serveRep :: SharedRep IO a -> (Markup -> [Code]) -> (Either ByteString a -> [Code]) -> CodeBoxConfig -> IO ()

serve a SharedRep

serveRepWithBox :: SharedRep IO a -> (Markup -> [Code]) -> (Either ByteString a -> [Code]) -> CodeBox -> IO ()

non-codensity sharedRep server.

replaceInput :: Markup -> [Code]

Convert HTML representation to Code, replacing the input section of a page.

replaceOutput :: Show a => Either ByteString a -> [Code]

Convert (typically parsed representation) to Code, replacing the output section of a page, and appending errors.

replaceOutput_ :: Show a => Either ByteString a -> [Code]

Convert (typically parsed representation) to Code, replacing the output section of a page, and throwing away errors.

sharedStream :: Monad m => SharedRep m a -> Committer m Markup -> Committer m (Either ByteString a) -> Emitter m (ByteString, ByteString) -> m ()

Stream a SharedRep

data PlayConfig

Configuration to control a (re)play of an emitter with a Gap (timing) element.

Constructors

PlayConfig

Fields

• playPause :: Bool
• playSpeed :: Double
• playFrame :: Int

Instances

Generic PlayConfig

Defined in Web.Rep.Socket

Associated Types

type Rep PlayConfig :: Type -> Type

Methods

from :: PlayConfig -> Rep PlayConfig x

to :: Rep PlayConfig x -> PlayConfig

Show PlayConfig

Defined in Web.Rep.Socket

Methods

showsPrec :: Int -> PlayConfig -> ShowS

show :: PlayConfig -> String

showList :: [PlayConfig] -> ShowS

Eq PlayConfig

Defined in Web.Rep.Socket

Methods

(==) :: PlayConfig -> PlayConfig -> Bool

(/=) :: PlayConfig -> PlayConfig -> Bool

type Rep PlayConfig

Defined in Web.Rep.Socket

type Rep PlayConfig = D1 ('MetaData "PlayConfig" "Web.Rep.Socket" "web-rep-0.12.3.0-E5Upzoz1WN63xERmXwdVK2" 'False) (C1 ('MetaCons "PlayConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "playPause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "playSpeed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "playFrame") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

defaultPlayConfig :: PlayConfig

Start on pause at normal speed and at frame 0.

repPlayConfig :: PlayConfig -> SharedRep IO PlayConfig

representation of a PlayConfig

servePlayStream :: PlayConfig -> CodeBoxConfig -> CoEmitter IO (Gap, [Code]) -> IO ()

Serve an emitter controlled by a PlayConfig representation.

servePlayStreamWithBox :: PlayConfig -> CoEmitter IO (Gap, [Code]) -> CodeBox -> IO ()

Serve an emitter controlled by a PlayConfig representation, with an explicit CodeBox.

data Code

A simple schema for code that communicates changes to a Html page via JS code.

Constructors

Replace ByteString ByteString

Append ByteString ByteString

Console ByteString

Eval ByteString

Val ByteString

Instances

Generic Code

Defined in Web.Rep.Socket

Associated Types

type Rep Code :: Type -> Type

Methods

from :: Code -> Rep Code x

to :: Rep Code x -> Code

Read Code

Defined in Web.Rep.Socket

Methods

readsPrec :: Int -> ReadS Code

readList :: ReadS [Code]

readPrec :: ReadPrec Code

readListPrec :: ReadPrec [Code]

Show Code

Defined in Web.Rep.Socket

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

Eq Code

Defined in Web.Rep.Socket

Methods

(==) :: Code -> Code -> Bool

(/=) :: Code -> Code -> Bool

type Rep Code

Defined in Web.Rep.Socket

type Rep Code = D1 ('MetaData "Code" "Web.Rep.Socket" "web-rep-0.12.3.0-E5Upzoz1WN63xERmXwdVK2" 'False) ((C1 ('MetaCons "Replace" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "Append" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))) :+: (C1 ('MetaCons "Console" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: (C1 ('MetaCons "Eval" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)) :+: C1 ('MetaCons "Val" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))))

code :: Code -> ByteString

Convert Code to a ByteString

console :: ByteString -> ByteString

write to the console

val :: ByteString -> ByteString

send arbitrary byestrings.

replace :: ByteString -> ByteString -> ByteString

replace a container and run any embedded scripts

append :: ByteString -> ByteString -> ByteString

append to a container and run any embedded scripts

clean :: ByteString -> ByteString

Double backslash newline and single quotes.

webSocket :: Js

create a web socket for event data

refreshJsbJs :: Js

Event hooks that may need to be reattached given dynamic content creation.

preventEnter :: Js

prevent the Enter key from triggering an event

runScriptJs :: Js

script injection js.

See https://ghinda.net/article/script-tags/ for why this might be needed.