Copyright	(c) Anton Gushcha, 2016
License	BSD3
Maintainer	ncrashed@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Game.GoreAndAsh.Async.State

Contents

Async helpers
Sync helpers

Description

Synopsis

Documentation

data AsyncState s Source

Internal state of asynchronious core module

s: - state of next module, they are chained until bottom, that is usually an empty data type.

Constructors

AsyncState
Fields asyncAValues :: !AsyncValueMap asyncScheduled :: !SyncSheduled asyncSValues :: !SyncFinished asyncNextId :: !Int asyncNextState :: !s

Instances

Generic (AsyncState s) Source
NFData s => NFData (AsyncState s) Source
Monad m => MonadState (AsyncState s) (AsyncT s m)
type Rep (AsyncState s) Source

emptyAsyncState :: s -> AsyncState s Source

Create inital async state

s: - state of next module

Async helpers

newtype AsyncId Source

Id of async value, it is used to poll info about the value

Constructors

AsyncId
Fields unAsyncId :: Int

Instances

Eq AsyncId Source
Show AsyncId Source
Generic AsyncId Source
NFData AsyncId Source
Hashable AsyncId Source
type Rep AsyncId Source

type AsyncValueMap = HashMap AsyncId (Either (Async Dynamic) (Either SomeException Dynamic)) Source

Container for async values

registerAsyncValue :: Typeable a => Async a -> AsyncState s -> (AsyncId, AsyncState s) Source

Put async value into internal state

getFinishedAsyncValue :: AsyncId -> AsyncState s -> Maybe (Maybe (Either SomeException Dynamic)) Source

Try to get value of given async value

Note: first Maybe layer is test for existense of given async value

Note: second Maybe layer is test is the value is finished

cancelAsyncValue :: AsyncId -> AsyncState s -> (Maybe (Async Dynamic), AsyncState s) Source

Unregister given id and return stored async

purgeAsyncs :: AsyncState s -> AsyncState s Source

Deletes calculated values

Sync helpers

newtype SyncId Source

Id of sync value, it is used to identify return value

Constructors

SyncId
Fields unSyncId :: Int

Instances

Eq SyncId Source
Ord SyncId Source
Show SyncId Source
Generic SyncId Source
NFData SyncId Source
Hashable SyncId Source
type Rep SyncId Source

type SyncSheduled = Seq (SyncId, IO Dynamic) Source

Container for scheduled sync values

type SyncFinished = HashMap SyncId (Either SomeException Dynamic) Source

Container for finished sync values

registerSyncValue :: Typeable a => IO a -> AsyncState s -> (SyncId, AsyncState s) Source

Put sync value into internal state

getFinishedSyncValue :: SyncId -> AsyncState s -> Maybe (Either SomeException Dynamic) Source

Try to get value of given sync value

Note: first Maybe layer is test for existense of given async value

cancelSyncValue :: SyncId -> AsyncState s -> AsyncState s Source

Unregister given sheduled sync action

purgeSyncs :: AsyncState s -> AsyncState s Source

Deletes calculated values