happstack-state-0.3.4: Event-based distributed state. Source code Contents Index

Happstack.State.Transaction

Synopsis

type ExceptionT = SomeException logMT :: Priority -> String -> IO () getTime :: Integral epochTime => AnyEv epochTime getEventClockTime :: AnyEv ClockTime getEventId :: Integral txId => AnyEv txId data GetCheckpointState = GetCheckpointState newtype SetCheckpointState = SetCheckpointState ByteString type TypeString = String data EventHandler where UpdateHandler :: UpdateEvent ev res => (TxContext -> ev -> IO ()) -> (ev -> IO res) -> (Object -> ev) -> EventHandler QueryHandler :: QueryEvent ev res => (ev -> IO res) -> (Object -> ev) -> EventHandler type EventMap = Map TypeString EventHandler data EmitInternal = EmitInternal EventMap emitRef :: IORef EmitInternal emitFunc :: (Serialize ev, Typeable res) => EventMap -> TypeString -> ev -> IO res emitEvent' :: (Serialize ev, Typeable res) => TypeString -> ev -> IO res emitEvent :: (Serialize ev, Typeable res) => ev -> IO res setNewEventMap :: EventMap -> IO () data EventItem = EventItem { eventContext :: TxContext eventData :: Dynamic } eventStreamRef :: MVar (Chan EventItem) initEventStream :: IO () pushEventItem :: Serialize ev => TxContext -> ev -> IO () getEventStream :: IO (IO EventItem) createEventMap :: (Methods st, Component st) => MVar TxControl -> Proxy st -> IO EventMap extraEvents :: Serialize st => TxRun st -> EventMap allStateTypes :: (Methods a, Component a) => Proxy a -> [TypeString] componentVersions :: (Methods a, Component a) => Proxy a -> Map String [ByteString] componentIO :: (Methods a, Component a) => Proxy a -> [IO ()] createNewTxRun :: IO (TxRun st) setNewStateType :: String -> String getStateType :: String -> String setNewState :: TypeString -> ByteString -> IO () getState :: TypeString -> IO ByteString data SetNewState st = SetNewState ByteString data GetState st = GetState update :: (MonadIO m, UpdateEvent ev res) => ev -> m res query :: (MonadIO m, QueryEvent ev res) => ev -> m res quickQuery' :: Serialize st => TxRun st -> HR st -> IO () type Runner ev res = IO (IO ev, res -> IO ()) type EH i o = i -> IO o data Event = forall ev . Serialize ev => Event ev data IHR st = forall ev . Serialize ev => IHR TxContext ev (RunHandler st ev) data HR st = forall ev . Serialize ev => HR ev (RunHandler st ev) type RunHandler st ev = TxContext -> st -> IO (Maybe st, IO ()) data Res a = Ok a | Error ExceptionT type EventQueue st = TChan (HR st) type ProcessQueue st = TChan (IHR st) data TxRun st = TxRun { txProcessQueue :: !(ProcessQueue st) txLastTxContext :: !(TVar TxContext) } type EvLoaders' st = Map String (ProcessQueue st -> ByteString -> IO (TxId, ByteString)) type EvLoaders = Map String (ByteString -> IO (TxId, ByteString)) setEvLoadersQueue :: ProcessQueue st -> EvLoaders' st -> EvLoaders runObjectEvent :: Object -> IO Object runObjectEventFunc :: Object -> EventMap -> IO Object runColdEvent :: TxContext -> Object -> IO () runColdEventFunc :: TxContext -> Object -> EventMap -> IO () lookupEventHandler :: TypeString -> EventMap -> IO EventHandler eventTString :: Serialize ev => ev -> TypeString handleEvent :: (st -> Env -> Ev m res -> STM intermediate) -> (st -> intermediate -> IO (Maybe st, res)) -> (Either ExceptionT res -> IO ()) -> Ev m res -> RunHandler st ev handleQuery :: (Either ExceptionT res -> IO ()) -> Query st res -> RunHandler st ev handleUpdate :: (Either ExceptionT res -> IO ()) -> Update st res -> RunHandler st ev checkDiff :: a -> a -> IO (Maybe a) getEpochMilli :: IO EpochMilli newTxContext :: IO TxContext addTxId :: TxRun st -> TxContext -> STM TxContext globalRandomGen :: MVar StdGen data TxConfig = TxConfig { txcCheckpointSeconds :: Seconds txcOperationMode :: OperationMode txcClusterSize :: Int txcClusterPort :: Int txcCommitFrequency :: Int } data TxControl = TxControl { ctlSaver :: Saver ctlEventSaver :: MVar (WriterStream EventLogEntry) ctlAllComponents :: [String] ctlComponentVersions :: Map String [ByteString] ctlChildren :: [(ThreadId, MVar ())] ctlPrefixLock :: Maybe PrefixLock } data EventLogEntry = EventLogEntry TxContext Object data OperationMode = SingleMode | ClusterMode String nullTxConfig :: TxConfig runTxLoop :: MVar (WriterStream EventLogEntry) -> ProcessQueue st -> st -> IO ()

Documentation

type ExceptionT = SomeException Source

logMT :: Priority -> String -> IO () Source

getTime :: Integral epochTime => AnyEv epochTime Source

getEventClockTime :: AnyEv ClockTime Source

getEventId :: Integral txId => AnyEv txId Source

data GetCheckpointState Source

Constructors GetCheckpointState Instances Typeable GetCheckpointState Version GetCheckpointState Serialize GetCheckpointState QueryEvent GetCheckpointState ByteString

newtype SetCheckpointState Source

Constructors SetCheckpointState ByteString Instances Typeable SetCheckpointState Version SetCheckpointState Serialize SetCheckpointState UpdateEvent SetCheckpointState ()

type TypeString = String Source

data EventHandler where Source

Constructors UpdateHandler :: UpdateEvent ev res => (TxContext -> ev -> IO ()) -> (ev -> IO res) -> (Object -> ev) -> EventHandler QueryHandler :: QueryEvent ev res => (ev -> IO res) -> (Object -> ev) -> EventHandler

type EventMap = Map TypeString EventHandler Source

data EmitInternal Source

Constructors EmitInternal EventMap

emitRef :: IORef EmitInternal Source

emitFunc :: (Serialize ev, Typeable res) => EventMap -> TypeString -> ev -> IO res Source

emitEvent' :: (Serialize ev, Typeable res) => TypeString -> ev -> IO res Source

emitEvent :: (Serialize ev, Typeable res) => ev -> IO res Source

setNewEventMap :: EventMap -> IO () Source

data EventItem Source

Constructors EventItem eventContext :: TxContext eventData :: Dynamic

eventStreamRef :: MVar (Chan EventItem) Source

initEventStream :: IO () Source

pushEventItem :: Serialize ev => TxContext -> ev -> IO () Source

getEventStream :: IO (IO EventItem) Source

createEventMap :: (Methods st, Component st) => MVar TxControl -> Proxy st -> IO EventMap Source

extraEvents :: Serialize st => TxRun st -> EventMap Source

allStateTypes :: (Methods a, Component a) => Proxy a -> [TypeString] Source

componentVersions :: (Methods a, Component a) => Proxy a -> Map String [ByteString] Source

componentIO :: (Methods a, Component a) => Proxy a -> [IO ()] Source

createNewTxRun :: IO (TxRun st) Source

setNewStateType :: String -> String Source

getStateType :: String -> String Source

setNewState :: TypeString -> ByteString -> IO () Source

getState :: TypeString -> IO ByteString Source

data SetNewState st Source

Constructors SetNewState ByteString Instances Typeable1 SetNewState Version (SetNewState st) Typeable st => Serialize (SetNewState st) Typeable st => UpdateEvent (SetNewState st) ()

data GetState st Source

Constructors GetState Instances Typeable1 GetState Version (GetState st) Typeable st => Serialize (GetState st) Typeable st => QueryEvent (GetState st) ByteString

update :: (MonadIO m, UpdateEvent ev res) => ev -> m res Source

Schedule an update and wait for it to complete. When this function returns, you're guaranteed the update will be persistent.

query :: (MonadIO m, QueryEvent ev res) => ev -> m res Source

Emit a state query and wait for the result.

quickQuery' :: Serialize st => TxRun st -> HR st -> IO () Source

type Runner ev res = IO (IO ev, res -> IO ()) Source

type EH i o = i -> IO o Source

data Event Source

Constructors forall ev . Serialize ev => Event ev

data IHR st Source

Constructors forall ev . Serialize ev => IHR TxContext ev (RunHandler st ev)

data HR st Source

Constructors forall ev . Serialize ev => HR ev (RunHandler st ev)

type RunHandler st ev = TxContext -> st -> IO (Maybe st, IO ()) Source

data Res a Source

Constructors Ok a Error ExceptionT

type EventQueue st = TChan (HR st) Source

type ProcessQueue st = TChan (IHR st) Source

data TxRun st Source

Constructors TxRun txProcessQueue :: !(ProcessQueue st) txLastTxContext :: !(TVar TxContext)

type EvLoaders' st = Map String (ProcessQueue st -> ByteString -> IO (TxId, ByteString)) Source

type EvLoaders = Map String (ByteString -> IO (TxId, ByteString)) Source

setEvLoadersQueue :: ProcessQueue st -> EvLoaders' st -> EvLoaders Source

runObjectEvent :: Object -> IO Object Source

runObjectEventFunc :: Object -> EventMap -> IO Object Source

runColdEvent :: TxContext -> Object -> IO () Source

runColdEventFunc :: TxContext -> Object -> EventMap -> IO () Source

lookupEventHandler :: TypeString -> EventMap -> IO EventHandler Source

eventTString :: Serialize ev => ev -> TypeString Source

handleEvent :: (st -> Env -> Ev m res -> STM intermediate) -> (st -> intermediate -> IO (Maybe st, res)) -> (Either ExceptionT res -> IO ()) -> Ev m res -> RunHandler st ev Source

handleQuery :: (Either ExceptionT res -> IO ()) -> Query st res -> RunHandler st ev Source

handleUpdate :: (Either ExceptionT res -> IO ()) -> Update st res -> RunHandler st ev Source

checkDiff :: a -> a -> IO (Maybe a) Source

getEpochMilli :: IO EpochMilli Source

newTxContext :: IO TxContext Source

addTxId :: TxRun st -> TxContext -> STM TxContext Source

globalRandomGen :: MVar StdGen Source

data TxConfig Source

Constructors TxConfig txcCheckpointSeconds :: Seconds Perform checkpoint at least every N seconds. txcOperationMode :: OperationMode txcClusterSize :: Int Number of active nodes in the cluster (not counting this node). txcClusterPort :: Int txcCommitFrequency :: Int Commits per second. Only applies to cluster mode.

data TxControl Source

Constructors TxControl ctlSaver :: Saver Saver given by the user. ctlEventSaver :: MVar (WriterStream EventLogEntry) ctlAllComponents :: [String] Types of each component used. ctlComponentVersions :: Map String [ByteString] Map listing all versions of a component ctlChildren :: [(ThreadId, MVar ())] ctlPrefixLock :: Maybe PrefixLock Stores exclusive prefix lock (implemented in filesystem)

data EventLogEntry Source

Constructors EventLogEntry TxContext Object Instances Show EventLogEntry Typeable EventLogEntry Version EventLogEntry Serialize EventLogEntry

data OperationMode Source

Constructors SingleMode ClusterMode String

nullTxConfig :: TxConfig Source

runTxLoop :: MVar (WriterStream EventLogEntry) -> ProcessQueue st -> st -> IO () Source

Produced by Haddock version 2.4.2