Game.GoreAndAsh.Network.Module

The module contains declaration of module monad transformer and instance of GameModule.

Documentation

newtype NetworkT s m a

Monad transformer of network core module.

s

- State of next core module in modules chain;

m

- Next monad in modules monad stack;

a

- Type of result value;

How to embed module:

type AppStack = ModuleStack [LoggingT, NetworkT, ... other modules ... ] IO

newtype AppMonad a = AppMonad (AppStack a)
  deriving (Functor, Applicative, Monad, MonadFix, MonadIO, LoggingMonad, NetworkMonad)

The module is NOT pure within first phase (see ModuleStack docs), therefore currently only IO end monad can handler the module.

Constructors

NetworkT

Fields

• runNetworkT :: StateT (NetworkState s) m a

Instances

MonadBase IO m => MonadBase IO (NetworkT s m)

Methods

liftBase :: IO α -> NetworkT s m α

MonadError e m => MonadError e (NetworkT s m)

Methods

throwError :: e -> NetworkT s m a

catchError :: NetworkT s m a -> (e -> NetworkT s m a) -> NetworkT s m a

MonadTrans (NetworkT s)

Methods

lift :: Monad m => m a -> NetworkT s m a

Monad m => MonadState (NetworkState s) (NetworkT s m)

Methods

get :: NetworkT s m (NetworkState s)

put :: NetworkState s -> NetworkT s m ()

state :: (NetworkState s -> (a, NetworkState s)) -> NetworkT s m a

Monad m => Monad (NetworkT s m)

Methods

(>>=) :: NetworkT s m a -> (a -> NetworkT s m b) -> NetworkT s m b

(>>) :: NetworkT s m a -> NetworkT s m b -> NetworkT s m b

return :: a -> NetworkT s m a

fail :: String -> NetworkT s m a

Functor m => Functor (NetworkT s m)

Methods

fmap :: (a -> b) -> NetworkT s m a -> NetworkT s m b

(<$) :: a -> NetworkT s m b -> NetworkT s m a

MonadFix m => MonadFix (NetworkT s m)

Methods

mfix :: (a -> NetworkT s m a) -> NetworkT s m a

Monad m => Applicative (NetworkT s m)

Methods

pure :: a -> NetworkT s m a

(<*>) :: NetworkT s m (a -> b) -> NetworkT s m a -> NetworkT s m b

(*>) :: NetworkT s m a -> NetworkT s m b -> NetworkT s m b

(<*) :: NetworkT s m a -> NetworkT s m b -> NetworkT s m a

MonadIO m => MonadIO (NetworkT s m)

Methods

liftIO :: IO a -> NetworkT s m a

MonadThrow m => MonadThrow (NetworkT s m)

Methods

throwM :: Exception e => e -> NetworkT s m a

MonadMask m => MonadMask (NetworkT s m)

Methods

mask :: ((forall a. NetworkT s m a -> NetworkT s m a) -> NetworkT s m b) -> NetworkT s m b

uninterruptibleMask :: ((forall a. NetworkT s m a -> NetworkT s m a) -> NetworkT s m b) -> NetworkT s m b

MonadCatch m => MonadCatch (NetworkT s m)

Methods

catch :: Exception e => NetworkT s m a -> (e -> NetworkT s m a) -> NetworkT s m a

MonadResource m => MonadResource (NetworkT s m)

Methods

liftResourceT :: ResourceT IO a -> NetworkT s m a

(MonadIO m, MonadCatch m) => NetworkMonad (NetworkT s m)

Methods

networkBind :: Maybe SockAddr -> Word -> Word -> Word32 -> Word32 -> NetworkT s m ()

peersConnectedM :: NetworkT s m (Seq Peer)

peersDisconnectedM :: NetworkT s m (Seq Peer)

networkConnect :: SockAddr -> Word -> Word32 -> NetworkT s m (Maybe ())

peerMessagesM :: Peer -> ChannelID -> NetworkT s m (Seq ByteString)

peerSendM :: Peer -> ChannelID -> Message -> NetworkT s m ()

networkPeersM :: NetworkT s m (Seq Peer)

networkSetDetailedLoggingM :: Bool -> NetworkT s m ()

networkChannels :: NetworkT s m Word

type ModuleState (NetworkT s m)

type ModuleState (NetworkT s m) = NetworkState s

Orphan instances

GameModule m s => GameModule (NetworkT s m) (NetworkState s)

Associated Types

type ModuleState (NetworkT s m :: * -> *) :: *

Methods

runModule :: MonadIO m' => NetworkT s m a -> NetworkState s -> m' (a, NetworkState s)

newModuleState :: MonadIO m' => m' (NetworkState s)

withModule :: Proxy (* -> *) (NetworkT s m) -> IO a -> IO a

cleanupModule :: NetworkState s -> IO ()