Simulation.Aivika.Trans.Task

Tested with: GHC 7.8.3

The Task value represents a process that was already started in background. We can check the completion of the task, receive notifications about changing its state and even suspend an outer process awaiting the final result of the task. It complements the Process monad as it allows immediately continuing the main computation without suspension.

Task

data Task m a

The task represents a process that was already started in background.

data TaskResult a

Represents the result of the task.

Constructors

TaskCompleted a

the task was successfully completed and it returned the specified result

TaskError SomeException

the specified exception was raised when performing the task.

TaskCancelled

the task was cancelled

taskId :: Task m a -> ProcessId m

Return an identifier for the process that was launched in background for this task.

tryGetTaskResult :: MonadComp m => Task m a -> Event m (Maybe (TaskResult a))

Try to get the task result immediately without suspension.

taskResult :: MonadComp m => Task m a -> Process m (TaskResult a)

Return the task result suspending the outer process if required.

taskResultReceived :: Task m a -> Signal m (TaskResult a)

Return a signal that notifies about receiving the result of the task.

taskProcess :: MonadComp m => Task m a -> Process m a

Return an outer process that behaves like the task itself except for one thing: if the outer process is cancelled then it is not enough to cancel the task.

cancelTask :: MonadComp m => Task m a -> Event m ()

Cancel the task.

taskCancelled :: MonadComp m => Task m a -> Event m Bool

Test whether the task was cancelled.

Running Task

runTask :: MonadComp m => Process m a -> Event m (Task m a)

Run the process in background and return the corresponded task immediately.

runTaskUsingId :: MonadComp m => ProcessId m -> Process m a -> Event m (Task m a)

Run the process with the specified identifier in background and return the corresponded task immediately.

Spawning Tasks

spawnTask :: MonadComp m => ContCancellation -> Process m a -> Process m (Task m a)

Run a child process in background and return immediately the corresponded task.

spawnTaskUsingId :: MonadComp m => ContCancellation -> ProcessId m -> Process m a -> Process m (Task m a)

Run using the specified identifier a child process in background and return immediately the corresponded task.

Enqueueing Task

enqueueTask :: MonadComp m => Double -> Process m a -> Event m (Task m a)

Enqueue the process that will be started at the specified time from the event queue. It returns the corresponded task immediately.

enqueueTaskUsingId :: MonadComp m => Double -> ProcessId m -> Process m a -> Event m (Task m a)

Enqueue the process that will be started at the specified time with the given identifier from the event queue. It returns the corresponded task immediately.