Simulation.Aivika.Dynamics.FIFO

Tested with: GHC 7.4.1

This module defines the FIFO queue.

Documentation

data FIFO a

Represents the FIFO queue with rule: first input - first output.

fifoQueue :: FIFO a -> EventQueue

Return the event queue.

fifoNull :: FIFO a -> Dynamics Bool

Test whether the FIFO queue is empty.

fifoFull :: FIFO a -> Dynamics Bool

Test whether the FIFO queue is full.

fifoMaxCount :: FIFO a -> Int

The maximum available number of items.

fifoCount :: FIFO a -> Dynamics Int

Return the queue size.

fifoLostCount :: FIFO a -> Dynamics Int

Return the number of lost items.

newFIFO :: EventQueue -> Int -> Simulation (FIFO a)

Create a new FIFO queue with the specified maximum available number of items.

dequeueFIFO :: FIFO a -> Process a

Dequeue from the FIFO queue suspending the process if the queue is empty.

tryDequeueFIFO :: FIFO a -> Dynamics (Maybe a)

Try to dequeue from the FIFO queue immediately.

enqueueFIFO :: FIFO a -> a -> Process ()

Enqueue the item in the FIFO queue suspending the process if the queue is full.

tryEnqueueFIFO :: FIFO a -> a -> Dynamics Bool

Try to enqueue the item in the FIFO queue. Return False in the monad if the queue is full.

enqueueFIFOOrLost :: FIFO a -> a -> Dynamics ()

Try to enqueue the item in the FIFO queue. If the queue is full then the item will be lost.