Simulation.Aivika.Server

Tested with: GHC 7.6.3

It models the server that prodives a service.

Server

data Server s a b

It models a server that takes a and provides b having state s.

newServer

Arguments

:: (a -> Process b)

provide an output by the specified input

-> Simulation (Server () a b)

Create a new server that can provide output b by input a. Also it returns the corresponded processor that being applied updates the server state.

newServerWithState

Arguments

:: s

the initial state

-> ((s, a) -> Process (s, b))

provide an output by the specified input and update the state

-> Simulation (Server s a b)

Create a new server that can provide output b by input a starting from state s. Also it returns the corresponded processor that being applied updates the server state.

Processing

serverProcessor :: Server s a b -> Processor a b

Return a processor for the specified server.

The processor updates the internal state of the server. The usual case is when the processor is applied only once in a chain of data processing. Otherwise; every time the processor is used, the state of the server changes.

Server Properties and Activities

serverInitState :: Server s a b -> s

The initial state of the server.

serverState :: Server s a b -> Event s

Return the current state of the server.

See also serverStateChanged and serverStateChanged_.

serverTotalInputTime :: Server s a b -> Event Double

Return the counted total time spent by the server in awaiting the input.

The value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverTotalInputTimeChanged and serverTotalInputTimeChanged_.

serverTotalProcessingTime :: Server s a b -> Event Double

Return the counted total time spent by the server to process all tasks.

The value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverTotalProcessingTimeChanged and serverTotalProcessingTimeChanged_.

serverTotalOutputTime :: Server s a b -> Event Double

Return the counted total time when the server was in the lock state trying to deliver the output.

The value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverTotalOutputTimeChanged and serverTotalOutputTimeChanged_.

serverInputTime :: Server s a b -> Event (SamplingStats Double)

Return the statistics of the time spent by the server in awaiting the input.

The value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverInputTimeChanged and serverInputTimeChanged_.

serverProcessingTime :: Server s a b -> Event (SamplingStats Double)

Return the statistics of the time spent by the server to process the tasks.

The value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverProcessingTimeChanged and serverProcessingTimeChanged_.

serverOutputTime :: Server s a b -> Event (SamplingStats Double)

Return the statistics of the time when the server was in the lock state trying to deliver the output.

The value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverOutputTimeChanged and serverOutputTimeChanged_.

serverInputTimeFactor :: Server s a b -> Event Double

It returns the factor changing from 0 to 1, which estimates how often the server was awaiting for the next input task.

This factor is calculated as

  totalInputTime / (totalInputTime + totalProcessingTime + totalOutputTime)

As before in this module, the value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverInputTimeFactorChanged and serverInputTimeFactorChanged_.

serverProcessingTimeFactor :: Server s a b -> Event Double

It returns the factor changing from 0 to 1, which estimates how often the server was busy with direct processing its tasks.

This factor is calculated as

  totalProcessingTime / (totalInputTime + totalProcessingTime + totalOutputTime)

As before in this module, the value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverProcessingTimeFactorChanged and serverProcessingTimeFactorChanged_.

serverOutputTimeFactor :: Server s a b -> Event Double

It returns the factor changing from 0 to 1, which estimates how often the server was locked trying to deliver the output after the task is finished.

This factor is calculated as

  totalOutputTime / (totalInputTime + totalProcessingTime + totalOutputTime)

As before in this module, the value returned changes discretely and it is usually delayed relative to the current simulation time.

See also serverOutputTimeFactorChanged and serverOutputTimeFactorChanged_.

Summary

serverSummary :: Server s a b -> Int -> Event ShowS

Return the summary for the server with desciption of its properties and activities using the specified indent.

Derived Signals for Properties

serverStateChanged :: Server s a b -> Signal s

Signal when the serverState property value has changed.

serverStateChanged_ :: Server s a b -> Signal ()

Signal when the serverState property value has changed.

serverTotalInputTimeChanged :: Server s a b -> Signal Double

Signal when the serverTotalInputTime property value has changed.

serverTotalInputTimeChanged_ :: Server s a b -> Signal ()

Signal when the serverTotalInputTime property value has changed.

serverTotalProcessingTimeChanged :: Server s a b -> Signal Double

Signal when the serverTotalProcessingTime property value has changed.

serverTotalProcessingTimeChanged_ :: Server s a b -> Signal ()

Signal when the serverTotalProcessingTime property value has changed.

serverTotalOutputTimeChanged :: Server s a b -> Signal Double

Signal when the serverTotalOutputTime property value has changed.

serverTotalOutputTimeChanged_ :: Server s a b -> Signal ()

Signal when the serverTotalOutputTime property value has changed.

serverInputTimeChanged :: Server s a b -> Signal (SamplingStats Double)

Signal when the serverInputTime property value has changed.

serverInputTimeChanged_ :: Server s a b -> Signal ()

Signal when the serverInputTime property value has changed.

serverProcessingTimeChanged :: Server s a b -> Signal (SamplingStats Double)

Signal when the serverProcessingTime property value has changed.

serverProcessingTimeChanged_ :: Server s a b -> Signal ()

Signal when the serverProcessingTime property value has changed.

serverOutputTimeChanged :: Server s a b -> Signal (SamplingStats Double)

Signal when the serverOutputTime property value has changed.

serverOutputTimeChanged_ :: Server s a b -> Signal ()

Signal when the serverOutputTime property value has changed.

serverInputTimeFactorChanged :: Server s a b -> Signal Double

Signal when the serverInputTimeFactor property value has changed.

serverInputTimeFactorChanged_ :: Server s a b -> Signal ()

Signal when the serverInputTimeFactor property value has changed.

serverProcessingTimeFactorChanged :: Server s a b -> Signal Double

Signal when the serverProcessingTimeFactor property value has changed.

serverProcessingTimeFactorChanged_ :: Server s a b -> Signal ()

Signal when the serverProcessingTimeFactor property value has changed.

serverOutputTimeFactorChanged :: Server s a b -> Signal Double

Signal when the serverOutputTimeFactor property value has changed.

serverOutputTimeFactorChanged_ :: Server s a b -> Signal ()

Signal when the serverOutputTimeFactor property value has changed.

Basic Signals

serverInputReceived :: Server s a b -> Signal a

Raised when the server receives a new input task.

serverTaskProcessed :: Server s a b -> Signal (a, b)

Raised when the server has just processed the task.

serverOutputProvided :: Server s a b -> Signal (a, b)

Raised when the server has just delivered the output.

Overall Signal

serverChanged_ :: Server s a b -> Signal ()

Signal whenever any property of the server changes.