Simulation.Aivika.Trans.Resource

Tested with: GHC 8.0.1

This module defines the resource which can be acquired and then released by the discontinuous process Process. The resource can be either limited by the upper bound (run-time check), or it can have no upper bound. The latter is useful for modeling the infinite queue, for example.

Resource Types

type FCFSResource m = Resource m FCFS

The ordinary FCFS (First Come - First Serviced) resource.

type LCFSResource m = Resource m LCFS

The ordinary LCFS (Last Come - First Serviced) resource.

type SIROResource m = Resource m SIRO

The SIRO (Serviced in Random Order) resource.

type PriorityResource m = Resource m StaticPriorities

The resource with static priorities.

data Resource m s

Represents the resource with strategy s applied for queuing the requests.

Instances

(MonadDES m, Show s, ResultItemable (ResultValue s)) => ResultProvider (Resource m s) m

Methods

resultSource :: ResultName -> ResultDescription -> Resource m s -> ResultSource m

resultSource' :: ResultName -> ResultId -> Resource m s -> ResultSource m

Creating Resource

newFCFSResource

Arguments

:: MonadDES m

=> Int

the initial count (and maximal count too) of the resource

-> Event m (FCFSResource m)

Create a new FCFS resource with the specified initial count which value becomes the upper bound as well.

newFCFSResourceWithMaxCount

Arguments

:: MonadDES m

=> Int

the initial count of the resource

-> Maybe Int

the maximum count of the resource, which can be indefinite

-> Event m (FCFSResource m)

Create a new FCFS resource with the specified initial and maximum counts, where Nothing means that the resource has no upper bound.

newLCFSResource

Arguments

:: MonadDES m

=> Int

the initial count (and maximal count too) of the resource

-> Event m (LCFSResource m)

Create a new LCFS resource with the specified initial count which value becomes the upper bound as well.

newLCFSResourceWithMaxCount

Arguments

:: MonadDES m

=> Int

the initial count of the resource

-> Maybe Int

the maximum count of the resource, which can be indefinite

-> Event m (LCFSResource m)

Create a new LCFS resource with the specified initial and maximum counts, where Nothing means that the resource has no upper bound.

newSIROResource

Arguments

:: (MonadDES m, QueueStrategy m SIRO)

=> Int

the initial count (and maximal count too) of the resource

-> Event m (SIROResource m)

Create a new SIRO resource with the specified initial count which value becomes the upper bound as well.

newSIROResourceWithMaxCount

Arguments

:: (MonadDES m, QueueStrategy m SIRO)

=> Int

the initial count of the resource

-> Maybe Int

the maximum count of the resource, which can be indefinite

-> Event m (SIROResource m)

Create a new SIRO resource with the specified initial and maximum counts, where Nothing means that the resource has no upper bound.

newPriorityResource

Arguments

:: (MonadDES m, QueueStrategy m StaticPriorities)

=> Int

the initial count (and maximal count too) of the resource

-> Event m (PriorityResource m)

Create a new priority resource with the specified initial count which value becomes the upper bound as well.

newPriorityResourceWithMaxCount

Arguments

:: (MonadDES m, QueueStrategy m StaticPriorities)

=> Int

the initial count of the resource

-> Maybe Int

the maximum count of the resource, which can be indefinite

-> Event m (PriorityResource m)

Create a new priority resource with the specified initial and maximum counts, where Nothing means that the resource has no upper bound.

newResource

Arguments

:: (MonadDES m, QueueStrategy m s)

=> s

the strategy for managing the queuing requests

-> Int

the initial count (and maximal count too) of the resource

-> Event m (Resource m s)

Create a new resource with the specified queue strategy and initial count. The last value becomes the upper bound as well.

newResourceWithMaxCount

Arguments

:: (MonadDES m, QueueStrategy m s)

=> s

the strategy for managing the queuing requests

-> Int

the initial count of the resource

-> Maybe Int

the maximum count of the resource, which can be indefinite

-> Event m (Resource m s)

Create a new resource with the specified queue strategy, initial and maximum counts, where Nothing means that the resource has no upper bound.

Resource Properties

resourceStrategy :: Resource m s -> s

Return the strategy applied for queuing the requests.

resourceMaxCount :: Resource m s -> Maybe Int

Return the maximum count of the resource, where Nothing means that the resource has no upper bound.

resourceCount :: MonadDES m => Resource m s -> Event m Int

Return the current available count of the resource.

resourceCountStats :: MonadDES m => Resource m s -> Event m (TimingStats Int)

Return the statistics for the available count of the resource.

resourceUtilisationCount :: MonadDES m => Resource m s -> Event m Int

Return the current utilisation count of the resource.

resourceUtilisationCountStats :: MonadDES m => Resource m s -> Event m (TimingStats Int)

Return the statistics for the utilisation count of the resource.

resourceQueueCount :: MonadDES m => Resource m s -> Event m Int

Return the current queue length of the resource.

resourceQueueCountStats :: MonadDES m => Resource m s -> Event m (TimingStats Int)

Return the statistics for the queue length of the resource.

resourceTotalWaitTime :: MonadDES m => Resource m s -> Event m Double

Return the total wait time of the resource.

resourceWaitTime :: MonadDES m => Resource m s -> Event m (SamplingStats Double)

Return the statistics for the wait time of the resource.

Requesting for and Releasing Resource

requestResource

Arguments

:: (MonadDES m, EnqueueStrategy m s)

=> Resource m s

the requested resource

-> Process m ()

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

requestResourceWithPriority

Arguments

:: (MonadDES m, PriorityQueueStrategy m s p)

=> Resource m s

the requested resource

-> p

the priority

-> Process m ()

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.

tryRequestResourceWithinEvent

Arguments

:: MonadDES m

=> Resource m s

the resource which we try to request for

-> Event m 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

Arguments

:: (MonadDES m, DequeueStrategy m s)

=> Resource m s

the resource to release

-> Process m ()

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

releaseResourceWithinEvent

Arguments

:: (MonadDES m, DequeueStrategy m s)

=> Resource m s

the resource to release

-> Event m ()

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

usingResource

Arguments

:: (MonadDES m, EnqueueStrategy m s)

=> Resource m s

the resource we are going to request for and then release in the end

-> Process m a

the action we are going to apply having the resource

-> Process m 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.

usingResourceWithPriority

Arguments

:: (MonadDES m, PriorityQueueStrategy m s p)

=> Resource m s

the resource we are going to request for and then release in the end

-> p

the priority

-> Process m a

the action we are going to apply having the resource

-> Process m 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.

Altering Resource

incResourceCount

Arguments

:: (MonadDES m, DequeueStrategy m s)

=> Resource m s

the resource

-> Int

the increment for the resource count

-> Event m ()

Increase the count of available resource by the specified number, invoking the awaiting processes as needed.

decResourceCount

Arguments

:: (MonadDES m, EnqueueStrategy m s)

=> Resource m s

the resource

-> Int

the decrement for the resource count

-> Process m ()

Decrease the count of available resource by the specified number, waiting for the processes capturing the resource as needed.

Signals

resourceCountChanged :: MonadDES m => Resource m s -> Signal m Int

Signal triggered when the resourceCount property changes.

resourceCountChanged_ :: MonadDES m => Resource m s -> Signal m ()

Signal triggered when the resourceCount property changes.

resourceUtilisationCountChanged :: MonadDES m => Resource m s -> Signal m Int

Signal triggered when the resourceUtilisationCount property changes.

resourceUtilisationCountChanged_ :: MonadDES m => Resource m s -> Signal m ()

Signal triggered when the resourceUtilisationCount property changes.

resourceQueueCountChanged :: MonadDES m => Resource m s -> Signal m Int

Signal triggered when the resourceQueueCount property changes.

resourceQueueCountChanged_ :: MonadDES m => Resource m s -> Signal m ()

Signal triggered when the resourceQueueCount property changes.

resourceWaitTimeChanged :: MonadDES m => Resource m s -> Signal m (SamplingStats Double)

Signal triggered when the resourceTotalWaitTime and resourceWaitTime properties change.

resourceWaitTimeChanged_ :: MonadDES m => Resource m s -> Signal m ()

Signal triggered when the resourceTotalWaitTime and resourceWaitTime properties change.

resourceChanged_ :: MonadDES m => Resource m s -> Signal m ()

Signal triggered when one of the resource counters changes.