Control.TimeWarp.Rpc.PureRpc

Defines network-emulated implementation of MonadRpc. Threads and time are also emulated via TimedT.

Documentation

data PureRpc m a

Implementation of RPC protocol for emulation, allows to manually define network nastiness via Delays datatype. TCP model is used.

List of known issues:

• Method, once being declared in net, can't be removed. Even throwTo won't help.
• In implementation, remote method is actually inlined at call position, so instance WithNamedLogger would refer to caller's logger name, not server's one.

Instances

MonadTrans PureRpc

Methods

lift :: Monad m => m a -> PureRpc m a

MonadState s m => MonadState s (PureRpc m)

Methods

get :: PureRpc m s

put :: s -> PureRpc m ()

state :: (s -> (a, s)) -> PureRpc m a

Monad (PureRpc m)

Methods

(>>=) :: PureRpc m a -> (a -> PureRpc m b) -> PureRpc m b

(>>) :: PureRpc m a -> PureRpc m b -> PureRpc m b

return :: a -> PureRpc m a

fail :: String -> PureRpc m a

Functor (PureRpc m)

Methods

fmap :: (a -> b) -> PureRpc m a -> PureRpc m b

(<$) :: a -> PureRpc m b -> PureRpc m a

Applicative (PureRpc m)

Methods

pure :: a -> PureRpc m a

(<*>) :: PureRpc m (a -> b) -> PureRpc m a -> PureRpc m b

(*>) :: PureRpc m a -> PureRpc m b -> PureRpc m b

(<*) :: PureRpc m a -> PureRpc m b -> PureRpc m a

MonadThrow m => MonadThrow (PureRpc m)

Methods

throwM :: Exception e => e -> PureRpc m a

MonadIO m => MonadIO (PureRpc m)

Methods

liftIO :: IO a -> PureRpc m a

MonadCatch m => MonadCatch (PureRpc m)

Methods

catch :: Exception e => PureRpc m a -> (e -> PureRpc m a) -> PureRpc m a

(MonadIO m, MonadCatch m) => MonadMask (PureRpc m)

Methods

mask :: ((forall a. PureRpc m a -> PureRpc m a) -> PureRpc m b) -> PureRpc m b

uninterruptibleMask :: ((forall a. PureRpc m a -> PureRpc m a) -> PureRpc m b) -> PureRpc m b

WithNamedLogger (PureRpc m)

Methods

getLoggerName :: PureRpc m LoggerName

modifyLoggerName :: (LoggerName -> LoggerName) -> PureRpc m a -> PureRpc m a

(MonadIO m, MonadCatch m) => MonadTimed (PureRpc m)

Methods

virtualTime :: PureRpc m Microsecond

wait :: RelativeToNow -> PureRpc m ()

fork :: PureRpc m () -> PureRpc m (ThreadId (PureRpc m))

myThreadId :: PureRpc m (ThreadId (PureRpc m))

throwTo :: Exception e => ThreadId (PureRpc m) -> e -> PureRpc m ()

timeout :: TimeUnit t => t -> PureRpc m a -> PureRpc m a

(MonadIO m, MonadCatch m) => MonadRpc (PureRpc m)

Methods

execClient :: MessagePack a => NetworkAddress -> Client a -> PureRpc m a

serve :: Port -> [Method (PureRpc m)] -> PureRpc m ()

type ThreadId (PureRpc m)

type ThreadId (PureRpc m) = PureThreadId

runPureRpc :: (MonadIO m, MonadCatch m, DelaysSpecifier delays) => StdGen -> delays -> PureRpc m a -> m a

Launches distributed scenario, emulating work of network.

class DelaysSpecifier d where

Describes network nastiness.

Minimal complete definition

toDelays

Methods

toDelays :: d -> Delays

Instances

DelaysSpecifier ()

Connection is never established.

Methods

toDelays :: () -> Delays

DelaysSpecifier Microsecond

Specifies permanent connection delay.

Methods

toDelays :: Microsecond -> Delays

DelaysSpecifier Delays

Detailed description of network nastiness.

Methods

toDelays :: Delays -> Delays

DelaysSpecifier (Microsecond, Microsecond)

Connection delay varies is specified range.

Methods

toDelays :: (Microsecond, Microsecond) -> Delays

newtype Delays

Allows to describe most complicated behaviour of network.

Examples:

• Always 1 second delay:

Delays $ \_ _ -> return $ ConnectedIn (interval 1 sec)

• Delay varies between 1 and 5 seconds (with granularity of 1 mcs):

Delays $ \_ _ -> ConnectedIn <$> getRandomTR (interval 1 sec, interval 5 sec)

• For first 10 seconds after scenario start connection is established with probability of 1/6:

Delays $ \_ time -> do
    p <- getRandomR (0, 5)
    if (p == 0) && (time <= interval 10 sec)
        then return $ ConnectedIn 0
        else return NeverConnected

• Node with address isolatedAddr is not accessible:

Delays $ \serverAddr _ ->
    return if serverAddr == isolatedAddr
           then NeverConnected
           else ConnectedIn 0

Constructors

Delays

Fields

• evalDelay :: NetworkAddress -> Microsecond -> Rand StdGen ConnectionOutcome

  Basing on current virtual time, rpc method server's address, returns delay after which server receives RPC request.

Instances

Show Delays

Methods

showsPrec :: Int -> Delays -> ShowS

show :: Delays -> String

showList :: [Delays] -> ShowS

Default Delays

Describes reliable network.

Methods

def :: Delays

DelaysSpecifier Delays

Detailed description of network nastiness.

Methods

toDelays :: Delays -> Delays

data ConnectionOutcome

Describes obstructions occured on executing RPC request.

Constructors

ConnectedIn Microsecond

Connection established in specified amout of time.

NeverConnected

Connection would be never established, client hangs.

getRandomTR :: MonadRandom m => (Microsecond, Microsecond) -> m Microsecond

Return a randomly-selected time value in specified range.