Game.GoreAndAsh.Async.State

Documentation

data AsyncState s

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)

Associated Types

type Rep (AsyncState s) :: * -> *

Methods

from :: AsyncState s -> Rep (AsyncState s) x

to :: Rep (AsyncState s) x -> AsyncState s

NFData s => NFData (AsyncState s)

Methods

rnf :: AsyncState s -> ()

Monad m => MonadState (AsyncState s) (AsyncT s m)

Methods

get :: AsyncT s m (AsyncState s)

put :: AsyncState s -> AsyncT s m ()

state :: (AsyncState s -> (a, AsyncState s)) -> AsyncT s m a

type Rep (AsyncState s)

type Rep (AsyncState s) = D1 (MetaData "AsyncState" "Game.GoreAndAsh.Async.State" "gore-and-ash-async-1.1.1.0-2OVkZlWWiw2AoycryFpZ3T" False) (C1 (MetaCons "AsyncState" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "asyncAValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AsyncValueMap)) (S1 (MetaSel (Just Symbol "asyncScheduled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SyncSheduled))) ((:*:) (S1 (MetaSel (Just Symbol "asyncSValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SyncFinished)) ((:*:) (S1 (MetaSel (Just Symbol "asyncNextId") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "asyncNextState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 s))))))

emptyAsyncState :: s -> AsyncState s

Create inital async state

s

- state of next module

Async helpers

newtype AsyncId

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

Constructors

AsyncId

Fields

• unAsyncId :: Int

Instances

Eq AsyncId

Methods

(==) :: AsyncId -> AsyncId -> Bool

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

Show AsyncId

Methods

showsPrec :: Int -> AsyncId -> ShowS

show :: AsyncId -> String

showList :: [AsyncId] -> ShowS

Generic AsyncId

Associated Types

type Rep AsyncId :: * -> *

Methods

from :: AsyncId -> Rep AsyncId x

to :: Rep AsyncId x -> AsyncId

NFData AsyncId

Methods

rnf :: AsyncId -> ()

Hashable AsyncId

Methods

hashWithSalt :: Int -> AsyncId -> Int

hash :: AsyncId -> Int

type Rep AsyncId

type Rep AsyncId = D1 (MetaData "AsyncId" "Game.GoreAndAsh.Async.State" "gore-and-ash-async-1.1.1.0-2OVkZlWWiw2AoycryFpZ3T" True) (C1 (MetaCons "AsyncId" PrefixI True) (S1 (MetaSel (Just Symbol "unAsyncId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

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

Container for async values

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

Put async value into internal state

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

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)

Unregister given id and return stored async

purgeAsyncs :: AsyncState s -> AsyncState s

Deletes calculated values

Sync helpers

newtype SyncId

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

Constructors

SyncId

Fields

• unSyncId :: Int

Instances

Eq SyncId

Methods

(==) :: SyncId -> SyncId -> Bool

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

Ord SyncId

Methods

compare :: SyncId -> SyncId -> Ordering

(<) :: SyncId -> SyncId -> Bool

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

(>) :: SyncId -> SyncId -> Bool

(>=) :: SyncId -> SyncId -> Bool

max :: SyncId -> SyncId -> SyncId

min :: SyncId -> SyncId -> SyncId

Show SyncId

Methods

showsPrec :: Int -> SyncId -> ShowS

show :: SyncId -> String

showList :: [SyncId] -> ShowS

Generic SyncId

Associated Types

type Rep SyncId :: * -> *

Methods

from :: SyncId -> Rep SyncId x

to :: Rep SyncId x -> SyncId

NFData SyncId

Methods

rnf :: SyncId -> ()

Hashable SyncId

Methods

hashWithSalt :: Int -> SyncId -> Int

hash :: SyncId -> Int

type Rep SyncId

type Rep SyncId = D1 (MetaData "SyncId" "Game.GoreAndAsh.Async.State" "gore-and-ash-async-1.1.1.0-2OVkZlWWiw2AoycryFpZ3T" True) (C1 (MetaCons "SyncId" PrefixI True) (S1 (MetaSel (Just Symbol "unSyncId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

type SyncSheduled = Seq (SyncId, IO Dynamic)

Container for scheduled sync values

type SyncFinished = HashMap SyncId (Either SomeException Dynamic)

Container for finished sync values

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

Put sync value into internal state

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

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

Unregister given sheduled sync action

purgeSyncs :: AsyncState s -> AsyncState s

Deletes calculated values