Stability	experimental
Maintainer	David Sorokin <david.sorokin@gmail.com>
Safe Haskell	Safe-Inferred

Simulation.Aivika.Resource

Description

Tested with: GHC 7.6.3

This module defines a limited resource which can be acquired and then released by the discontinuous process Process.

Synopsis

Documentation

data Resource s q Source

Represents a limited resource.

Instances

Eq (Resource s q)

newResource Source

Arguments

:: QueueStrategy s q
=> s	the strategy for managing the queuing requests
-> Int	the maximum count of the resource
-> Simulation (Resource s q)

Create a new resource with the specified queue strategy and maximum count.

newResourceWithCount Source

Arguments

:: QueueStrategy s q
=> s	the strategy for managing the queuing requests
-> Int	the maximum count of the resource
-> Int	the initial count of the resource
-> Simulation (Resource s q)

Create a new resource with the specified queue strategy, maximum and initial count.

resourceMaxCount :: Resource s q -> Int Source

Return the maximum count of the resource.

resourceCount :: Resource s q -> Event Int Source

Return the current count of the resource.

requestResource Source

Arguments

:: EnqueueStrategy s q
=> Resource s q	the requested resource
-> Process ()

Request for the resource decreasing its count in case of success, otherwise suspending the discontinuous process until some other process releases the resource.

requestResourceWithPriority Source

Arguments

:: PriorityQueueStrategy s q
=> Resource s q	the requested resource
-> Double	the priority
-> Process ()

Request with the priority for the resource decreasing its count in case of success, otherwise suspending the discontinuous process until some other process releases the resource.

requestResourceWithDynamicPriority Source

Arguments

:: DynamicPriorityQueueStrategy s q
=> Resource s q	the requested resource
-> Event Double	the dynamic priority
-> Process ()

Request with the dynamic priority for the resource decreasing its count in case of success, otherwise suspending the discontinuous process until some other process releases the resource.

tryRequestResourceWithinEvent Source

Arguments

:: Resource s q	the resource which we try to request for
-> Event Bool

Try to request for the resource decreasing its count in case of success and returning True in the Event monad; otherwise, returning False.

releaseResource Source

Arguments

:: DequeueStrategy s q
=> Resource s q	the resource to release
-> Process ()

Release the resource increasing its count and resuming one of the previously suspended processes as possible.

releaseResourceWithinEvent Source

Arguments

:: DequeueStrategy s q
=> Resource s q	the resource to release
-> Event ()

Release the resource increasing its count and resuming one of the previously suspended processes as possible.

usingResource Source

Arguments

:: EnqueueStrategy s q
=> Resource s q	the resource we are going to request for and then release in the end
-> Process a	the action we are going to apply having the resource
-> Process a	the result of the action

Acquire the resource, perform some action and safely release the resource in the end, even if the IOException was raised within the action. The process identifier must be created with support of exception handling, i.e. with help of function newProcessIdWithCatch. Unfortunately, such processes are slower than those that are created with help of other function newProcessId.

usingResourceWithPriority Source

Arguments

:: PriorityQueueStrategy s q
=> Resource s q	the resource we are going to request for and then release in the end
-> Double	the priority
-> Process a	the action we are going to apply having the resource
-> Process a	the result of the action

Acquire the resource with the specified priority, perform some action and safely release the resource in the end, even if the IOException was raised within the action. The process identifier must be created with support of exception handling, i.e. with help of function newProcessIdWithCatch. Unfortunately, such processes are slower than those that are created with help of other function newProcessId.

usingResourceWithDynamicPriority Source

Arguments

:: DynamicPriorityQueueStrategy s q
=> Resource s q	the resource we are going to request for and then release in the end
-> Event Double	the dynamic priority
-> Process a	the action we are going to apply having the resource
-> Process a	the result of the action

Acquire the resource with the dynamic priority, perform some action and safely release the resource in the end, even if the IOException was raised within the action. The process identifier must be created with support of exception handling, i.e. with help of function newProcessIdWithCatch. Unfortunately, such processes are slower than those that are created with help of other function newProcessId.