Simulation.Aivika.Distributed.Optimistic.TimeServer

Tested with: GHC 7.10.3

This module allows running the time server that coordinates the global simulation time.

Documentation

data TimeServerParams

The time server parameters.

Constructors

TimeServerParams

Fields

• tsLoggingPriority :: Priority

  the logging priority

• tsName :: String

  the monitoring name of the time server

• tsReceiveTimeout :: Int

  the timeout in microseconds used when receiving messages

• tsTimeSyncTimeout :: Int

  the timeout in microseconds used for the time synchronization sessions

• tsTimeSyncDelay :: Int

  the delay in microseconds between the time synchronization sessions

• tsProcessMonitoringEnabled :: Bool

  whether the process monitoring is enabled

• tsProcessMonitoringDelay :: Int

  The delay in microseconds which must be applied for monitoring every remote process

• tsProcessReconnectingEnabled :: Bool

  whether the automatic reconnecting to processes is enabled when enabled monitoring

• tsProcessReconnectingDelay :: Int

  the delay in microseconds before reconnecting

• tsSimulationMonitoringInterval :: Int

  the interval in microseconds between sending the simulation monitoring messages

• tsSimulationMonitoringTimeout :: Int

  the timeout in microseconds when processing the simulation monitoring messages

• tsStrategy :: TimeServerStrategy

  the time server strategy

Instances

Eq TimeServerParams

Methods

(==) :: TimeServerParams -> TimeServerParams -> Bool

(/=) :: TimeServerParams -> TimeServerParams -> Bool

Ord TimeServerParams

Methods

compare :: TimeServerParams -> TimeServerParams -> Ordering

(<) :: TimeServerParams -> TimeServerParams -> Bool

(<=) :: TimeServerParams -> TimeServerParams -> Bool

(>) :: TimeServerParams -> TimeServerParams -> Bool

(>=) :: TimeServerParams -> TimeServerParams -> Bool

max :: TimeServerParams -> TimeServerParams -> TimeServerParams

min :: TimeServerParams -> TimeServerParams -> TimeServerParams

Show TimeServerParams

Methods

showsPrec :: Int -> TimeServerParams -> ShowS

show :: TimeServerParams -> String

showList :: [TimeServerParams] -> ShowS

Generic TimeServerParams

Associated Types

type Rep TimeServerParams :: * -> *

Methods

from :: TimeServerParams -> Rep TimeServerParams x

to :: Rep TimeServerParams x -> TimeServerParams

Binary TimeServerParams

Methods

put :: TimeServerParams -> Put

get :: Get TimeServerParams

putList :: [TimeServerParams] -> Put

type Rep TimeServerParams

type Rep TimeServerParams = D1 * (MetaData "TimeServerParams" "Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer" "aivika-distributed-1.2-34XhNfd7ARLHUummUSadXy" False) (C1 * (MetaCons "TimeServerParams" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "tsLoggingPriority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Priority)) ((:*:) * (S1 * (MetaSel (Just Symbol "tsName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) (S1 * (MetaSel (Just Symbol "tsReceiveTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "tsTimeSyncTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) ((:*:) * (S1 * (MetaSel (Just Symbol "tsTimeSyncDelay") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "tsProcessMonitoringEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "tsProcessMonitoringDelay") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) ((:*:) * (S1 * (MetaSel (Just Symbol "tsProcessReconnectingEnabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool)) (S1 * (MetaSel (Just Symbol "tsProcessReconnectingDelay") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "tsSimulationMonitoringInterval") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) ((:*:) * (S1 * (MetaSel (Just Symbol "tsSimulationMonitoringTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "tsStrategy") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * TimeServerStrategy)))))))

data TimeServerEnv

Those time server environment parameters that cannot be serialized and passed to another process via the net.

Constructors

TimeServerEnv

Fields

• tsSimulationMonitoringAction :: Maybe (TimeServerState -> Process ())

  the simulation monitoring action

data TimeServerStrategy

The time server strategy.

Constructors

WaitIndefinitelyForLogicalProcess

wait for the logical process forever

TerminateDueToLogicalProcessTimeout Int

terminate the server due to the exceeded logical process timeout in microseconds, but not less than tsTimeSyncTimeout, which is a much more preferable option than significantly more risky UnregisterLogicalProcessDueToTimeout

UnregisterLogicalProcessDueToTimeout Int

unregister the logical process due to the exceeded timeout in microseconds, but not less than tsTimeSyncTimeout, which is a very risky option as there can be un-acknowledged messages by the just unregistered logical process that might shutdown, which would keep the global virtual time on the same value even if the existent logical processes had another local time

Instances

Eq TimeServerStrategy

Methods

(==) :: TimeServerStrategy -> TimeServerStrategy -> Bool

(/=) :: TimeServerStrategy -> TimeServerStrategy -> Bool

Ord TimeServerStrategy

Methods

compare :: TimeServerStrategy -> TimeServerStrategy -> Ordering

(<) :: TimeServerStrategy -> TimeServerStrategy -> Bool

(<=) :: TimeServerStrategy -> TimeServerStrategy -> Bool

(>) :: TimeServerStrategy -> TimeServerStrategy -> Bool

(>=) :: TimeServerStrategy -> TimeServerStrategy -> Bool

max :: TimeServerStrategy -> TimeServerStrategy -> TimeServerStrategy

min :: TimeServerStrategy -> TimeServerStrategy -> TimeServerStrategy

Show TimeServerStrategy

Methods

showsPrec :: Int -> TimeServerStrategy -> ShowS

show :: TimeServerStrategy -> String

showList :: [TimeServerStrategy] -> ShowS

Generic TimeServerStrategy

Associated Types

type Rep TimeServerStrategy :: * -> *

Methods

from :: TimeServerStrategy -> Rep TimeServerStrategy x

to :: Rep TimeServerStrategy x -> TimeServerStrategy

Binary TimeServerStrategy

Methods

put :: TimeServerStrategy -> Put

get :: Get TimeServerStrategy

putList :: [TimeServerStrategy] -> Put

type Rep TimeServerStrategy

type Rep TimeServerStrategy = D1 * (MetaData "TimeServerStrategy" "Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer" "aivika-distributed-1.2-34XhNfd7ARLHUummUSadXy" False) ((:+:) * (C1 * (MetaCons "WaitIndefinitelyForLogicalProcess" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "TerminateDueToLogicalProcessTimeout" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))) (C1 * (MetaCons "UnregisterLogicalProcessDueToTimeout" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)))))

defaultTimeServerParams :: TimeServerParams

The default time server parameters.

defaultTimeServerEnv :: TimeServerEnv

The default time server environment parameters.

timeServer :: Int -> TimeServerParams -> Process ()

Start the time server by the specified initial quorum and parameters. The quorum defines the number of logical processes that must be registered in the time server before the global time synchronization is started.

timeServerWithEnv :: Int -> TimeServerParams -> TimeServerEnv -> Process ()

A full version of timeServer that allows specifying the environment parameters.

curryTimeServer :: (Int, TimeServerParams) -> Process ()

A curried version of timeServer for starting the time server on remote node.