Copyright	Copyright (c) 2015-2017 David Sorokin <david.sorokin@gmail.com>
License	BSD3
Maintainer	David Sorokin <david.sorokin@gmail.com>
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Simulation.Aivika.Distributed.Optimistic.TimeServer

Description

Tested with: GHC 7.10.3

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

Synopsis

data TimeServerParams = TimeServerParams {
- tsLoggingPriority :: Priority
- tsName :: String
- tsReceiveTimeout :: Int
- tsTimeSyncTimeout :: Int
- tsTimeSyncDelay :: Int
- tsProcessMonitoringEnabled :: Bool
- tsProcessMonitoringDelay :: Int
- tsProcessReconnectingEnabled :: Bool
- tsProcessReconnectingDelay :: Int
- tsSimulationMonitoringInterval :: Int
- tsSimulationMonitoringTimeout :: Int
- tsStrategy :: TimeServerStrategy
}
data TimeServerEnv = TimeServerEnv {
- tsSimulationMonitoringAction :: Maybe (TimeServerState -> Process ())
}
data TimeServerStrategy
defaultTimeServerParams :: TimeServerParams
defaultTimeServerEnv :: TimeServerEnv
timeServer :: Int -> TimeServerParams -> Process ()
timeServerWithEnv :: Int -> TimeServerParams -> TimeServerEnv -> Process ()
curryTimeServer :: (Int, TimeServerParams) -> Process ()

Documentation

data TimeServerParams Source #

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

Instances details

Generic TimeServerParams Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Associated Types type Rep TimeServerParams :: Type -> Type # Methods from :: TimeServerParams -> Rep TimeServerParams x # to :: Rep TimeServerParams x -> TimeServerParams #
Show TimeServerParams Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Methods showsPrec :: Int -> TimeServerParams -> ShowS # show :: TimeServerParams -> String # showList :: [TimeServerParams] -> ShowS #
Binary TimeServerParams Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Methods put :: TimeServerParams -> Put # get :: Get TimeServerParams # putList :: [TimeServerParams] -> Put #
Eq TimeServerParams Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Methods (==) :: TimeServerParams -> TimeServerParams -> Bool # (/=) :: TimeServerParams -> TimeServerParams -> Bool #
Ord TimeServerParams Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer 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 #
type Rep TimeServerParams Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer type Rep TimeServerParams = D1 ('MetaData "TimeServerParams" "Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer" "aivika-distributed-1.5.1-LD6d5nK4AIqDBvGt7m30NF" 'False) (C1 ('MetaCons "TimeServerParams" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tsLoggingPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Priority) :: (S1 ('MetaSel ('Just "tsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: S1 ('MetaSel ('Just "tsReceiveTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :: (S1 ('MetaSel ('Just "tsTimeSyncTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: (S1 ('MetaSel ('Just "tsTimeSyncDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "tsProcessMonitoringEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :: ((S1 ('MetaSel ('Just "tsProcessMonitoringDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: (S1 ('MetaSel ('Just "tsProcessReconnectingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: S1 ('MetaSel ('Just "tsProcessReconnectingDelay") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :: (S1 ('MetaSel ('Just "tsSimulationMonitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: (S1 ('MetaSel ('Just "tsSimulationMonitoringTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "tsStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TimeServerStrategy))))))

data TimeServerEnv Source #

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 Source #

The time server strategy.

Constructors

WaitIndefinitelyForLogicalProcess	wait for the logical processes forever
TerminateDueToLogicalProcessTimeout Int	terminate the server due to the exceeded logical process timeout in microseconds, but not less than `tsTimeSyncTimeout`, which should be applied if the process reconnecting is enabled
UnregisterLogicalProcessDueToTimeout Int	unregister the logical process due to the exceeded timeout in microseconds, but not less than `tsTimeSyncTimeout`, which can be applied only if the process disconnecting is enabled

Instances

Instances details

Generic TimeServerStrategy Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Associated Types type Rep TimeServerStrategy :: Type -> Type # Methods from :: TimeServerStrategy -> Rep TimeServerStrategy x # to :: Rep TimeServerStrategy x -> TimeServerStrategy #
Show TimeServerStrategy Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Methods showsPrec :: Int -> TimeServerStrategy -> ShowS # show :: TimeServerStrategy -> String # showList :: [TimeServerStrategy] -> ShowS #
Binary TimeServerStrategy Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Methods put :: TimeServerStrategy -> Put # get :: Get TimeServerStrategy # putList :: [TimeServerStrategy] -> Put #
Eq TimeServerStrategy Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer Methods (==) :: TimeServerStrategy -> TimeServerStrategy -> Bool # (/=) :: TimeServerStrategy -> TimeServerStrategy -> Bool #
Ord TimeServerStrategy Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer 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 #
type Rep TimeServerStrategy Source #
Instance details Defined in Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer type Rep TimeServerStrategy = D1 ('MetaData "TimeServerStrategy" "Simulation.Aivika.Distributed.Optimistic.Internal.TimeServer" "aivika-distributed-1.5.1-LD6d5nK4AIqDBvGt7m30NF" 'False) (C1 ('MetaCons "WaitIndefinitelyForLogicalProcess" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TerminateDueToLogicalProcessTimeout" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "UnregisterLogicalProcessDueToTimeout" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

defaultTimeServerParams :: TimeServerParams Source #

The default time server parameters.

defaultTimeServerEnv :: TimeServerEnv Source #

The default time server environment parameters.

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

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 () Source #

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

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

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