Network.ZRE

Documentation

runZre :: ZRE a -> IO ()

runZreCfg :: ZRECfg -> ZRE a -> IO ()

runZreEnvConfig :: ZRE a -> IO ()

Run with config file loaded from the enviornment variable ENVCFG (etczre.conf or ~/.zre.conf)

runZreParse :: Parser extra -> (extra -> ZRE a) -> IO ()

Run with config file loaded from the environment variable ENVCFG (etczre.conf or ~/.zre.conf), possibly overriden by command-line options.

Accepts another `optparse-applicative` Parser for extending built-in one.

readZ :: ZRE Event

writeZ :: API -> ZRE ()

unReadZ :: Event -> ZRE ()

defaultConf :: ZRECfg

data API

Constructors

DoJoin Group

DoLeave Group

DoShout Group ByteString

DoShoutMulti Group [ByteString]

DoWhisper UUID ByteString

DoDiscover UUID Endpoint

DoDebug Bool

DoQuit

Instances

Show API

Defined in Network.ZRE.Types

Methods

showsPrec :: Int -> API -> ShowS

show :: API -> String

showList :: [API] -> ShowS

MonadReader (EventQueue, APIQueue) ZRE

Defined in Network.ZRE.Types

Methods

ask :: ZRE (EventQueue, APIQueue)

local :: ((EventQueue, APIQueue) -> (EventQueue, APIQueue)) -> ZRE a -> ZRE a

reader :: ((EventQueue, APIQueue) -> a) -> ZRE a

data Event

Constructors

New UUID (Maybe Name) Groups Headers Endpoint

Ready UUID Name Groups Headers Endpoint

GroupJoin UUID Group

GroupLeave UUID Group

Quit UUID (Maybe Name)

Message ZREMsg

Shout UUID Group Content UTCTime

Whisper UUID Content UTCTime

Debug ByteString

Instances

Show Event

Defined in Network.ZRE.Types

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

MonadReader (EventQueue, APIQueue) ZRE

Defined in Network.ZRE.Types

Methods

ask :: ZRE (EventQueue, APIQueue)

local :: ((EventQueue, APIQueue) -> (EventQueue, APIQueue)) -> ZRE a -> ZRE a

reader :: ((EventQueue, APIQueue) -> a) -> ZRE a

data ZRE a

Instances

MonadIO ZRE

Defined in Network.ZRE.Types

Methods

liftIO :: IO a -> ZRE a

Applicative ZRE

Defined in Network.ZRE.Types

Methods

pure :: a -> ZRE a

(<*>) :: ZRE (a -> b) -> ZRE a -> ZRE b

liftA2 :: (a -> b -> c) -> ZRE a -> ZRE b -> ZRE c

(*>) :: ZRE a -> ZRE b -> ZRE b

(<*) :: ZRE a -> ZRE b -> ZRE a

Functor ZRE

Defined in Network.ZRE.Types

Methods

fmap :: (a -> b) -> ZRE a -> ZRE b

(<$) :: a -> ZRE b -> ZRE a

Monad ZRE

Defined in Network.ZRE.Types

Methods

(>>=) :: ZRE a -> (a -> ZRE b) -> ZRE b

(>>) :: ZRE a -> ZRE b -> ZRE b

return :: a -> ZRE a

MonadBaseControl IO ZRE

Defined in Network.ZRE.Types

Associated Types

type StM ZRE a

Methods

liftBaseWith :: (RunInBase ZRE IO -> IO a) -> ZRE a

restoreM :: StM ZRE a -> ZRE a

MonadBase IO ZRE

Defined in Network.ZRE.Types

Methods

liftBase :: IO α -> ZRE α

MonadReader (EventQueue, APIQueue) ZRE

Defined in Network.ZRE.Types

Methods

ask :: ZRE (EventQueue, APIQueue)

local :: ((EventQueue, APIQueue) -> (EventQueue, APIQueue)) -> ZRE a -> ZRE a

reader :: ((EventQueue, APIQueue) -> a) -> ZRE a

type StM ZRE a

Defined in Network.ZRE.Types

type StM ZRE a = a

data Group

Instances

Show Group

Defined in Data.ZRE

Methods

showsPrec :: Int -> Group -> ShowS

show :: Group -> String

showList :: [Group] -> ShowS

Eq Group

Defined in Data.ZRE

Methods

(==) :: Group -> Group -> Bool

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

Ord Group

Defined in Data.ZRE

Methods

compare :: Group -> Group -> Ordering

(<) :: Group -> Group -> Bool

(<=) :: Group -> Group -> Bool

(>) :: Group -> Group -> Bool

(>=) :: Group -> Group -> Bool

max :: Group -> Group -> Group

min :: Group -> Group -> Group

mkGroup :: ByteString -> Group

Constructor for Group

unGroup :: Group -> ByteString

zjoin :: Group -> ZRE ()

zleave :: Group -> ZRE ()

zshout :: Group -> ByteString -> ZRE ()

zshout' :: Group -> [ByteString] -> ZRE ()

zwhisper :: UUID -> ByteString -> ZRE ()

zdebug :: ZRE ()

znodebug :: ZRE ()

zquit :: ZRE ()

zfail :: String -> ZRE a

zrecv :: ZRE Event

pEndpoint :: Endpoint -> ByteString

toASCIIBytes :: UUID -> ByteString

Convert a UUID into a hyphentated string using lower-case letters, packed as ASCII bytes into ByteString.

This should be equivalent to toString with pack.

getApiQueue :: ZRE APIQueue

getEventQueue :: ZRE EventQueue

module Network.ZRE.Lib