Metro

Documentation

class GetPacketId k pkt where

Methods

getPacketId :: pkt -> k

class SetPacketId k pkt where

Methods

setPacketId :: k -> pkt -> pkt

class SendPacket spkt where

Minimal complete definition

Nothing

Methods

sendPacket :: MonadIO m => spkt -> (ByteString -> m ()) -> m ()

default sendPacket :: (MonadIO m, Binary spkt) => spkt -> (ByteString -> m ()) -> m ()

class RecvPacket rpkt where

Methods

recvPacket :: MonadIO m => (Int -> m ByteString) -> m rpkt

class Servable serv where

Associated Types

data ServerConfig serv

type SID serv

type STP serv

Methods

newServer :: MonadIO m => ServerConfig serv -> m serv

servOnce :: MonadUnliftIO m => serv -> (Maybe (SID serv, TransportConfig (STP serv)) -> m ()) -> m ()

onConnEnter :: MonadIO m => serv -> SID serv -> m ()

onConnLeave :: MonadIO m => serv -> SID serv -> m ()

servClose :: MonadIO m => serv -> m ()

class Transport transport where

Associated Types

data TransportConfig transport

Methods

newTransport :: TransportConfig transport -> IO transport

recvData :: transport -> Int -> IO ByteString

sendData :: transport -> ByteString -> IO ()

closeTransport :: transport -> IO ()

Instances

Transport BSTransport

Defined in Metro.TP.BS

Associated Types

data TransportConfig BSTransport

Methods

newTransport :: TransportConfig BSTransport -> IO BSTransport

recvData :: BSTransport -> Int -> IO ByteString

sendData :: BSTransport -> ByteString -> IO ()

closeTransport :: BSTransport -> IO ()

Transport tp => Transport (Debug tp)

Defined in Metro.TP.Debug

Associated Types

data TransportConfig (Debug tp)

Methods

newTransport :: TransportConfig (Debug tp) -> IO (Debug tp)

recvData :: Debug tp -> Int -> IO ByteString

sendData :: Debug tp -> ByteString -> IO ()

closeTransport :: Debug tp -> IO ()

data TransportError

Constructors

TransportClosed

Instances

Eq TransportError

Defined in Metro.Class

Methods

(==) :: TransportError -> TransportError -> Bool

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

Ord TransportError

Defined in Metro.Class

Methods

compare :: TransportError -> TransportError -> Ordering

(<) :: TransportError -> TransportError -> Bool

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

(>) :: TransportError -> TransportError -> Bool

(>=) :: TransportError -> TransportError -> Bool

max :: TransportError -> TransportError -> TransportError

min :: TransportError -> TransportError -> TransportError

Show TransportError

Defined in Metro.Class

Methods

showsPrec :: Int -> TransportError -> ShowS

show :: TransportError -> String

showList :: [TransportError] -> ShowS

Exception TransportError

Defined in Metro.Class

Methods

toException :: TransportError -> SomeException

fromException :: SomeException -> Maybe TransportError

displayException :: TransportError -> String

sendBinary :: (MonadIO m, Binary spkt) => spkt -> (ByteString -> m ()) -> m ()

class FromConn m where

Methods

fromConn :: Monad n => ConnT tp n a -> m tp n a

Instances

FromConn ConnT

Defined in Metro.Conn

Methods

fromConn :: forall (n :: Type -> Type) tp a. Monad n => ConnT tp n a -> ConnT tp n a

FromConn (SessionT u nid k rpkt)

Defined in Metro.Session

Methods

fromConn :: forall (n :: Type -> Type) tp a. Monad n => ConnT tp n a -> SessionT u nid k rpkt tp n a

FromConn (NodeT u nid k rpkt)

Defined in Metro.Node

Methods

fromConn :: forall (n :: Type -> Type) tp a. Monad n => ConnT tp n a -> NodeT u nid k rpkt tp n a

data ConnT tp m a

Instances

FromConn ConnT

Defined in Metro.Conn

Methods

fromConn :: forall (n :: Type -> Type) tp a. Monad n => ConnT tp n a -> ConnT tp n a

MonadTrans (ConnT tp)

Defined in Metro.Conn

Methods

lift :: Monad m => m a -> ConnT tp m a

Monad m => MonadReader (ConnEnv tp) (ConnT tp m)

Defined in Metro.Conn

Methods

ask :: ConnT tp m (ConnEnv tp)

local :: (ConnEnv tp -> ConnEnv tp) -> ConnT tp m a -> ConnT tp m a

reader :: (ConnEnv tp -> a) -> ConnT tp m a

Monad m => Monad (ConnT tp m)

Defined in Metro.Conn

Methods

(>>=) :: ConnT tp m a -> (a -> ConnT tp m b) -> ConnT tp m b

(>>) :: ConnT tp m a -> ConnT tp m b -> ConnT tp m b

return :: a -> ConnT tp m a

Functor m => Functor (ConnT tp m)

Defined in Metro.Conn

Methods

fmap :: (a -> b) -> ConnT tp m a -> ConnT tp m b

(<$) :: a -> ConnT tp m b -> ConnT tp m a

Applicative m => Applicative (ConnT tp m)

Defined in Metro.Conn

Methods

pure :: a -> ConnT tp m a

(<*>) :: ConnT tp m (a -> b) -> ConnT tp m a -> ConnT tp m b

liftA2 :: (a -> b -> c) -> ConnT tp m a -> ConnT tp m b -> ConnT tp m c

(*>) :: ConnT tp m a -> ConnT tp m b -> ConnT tp m b

(<*) :: ConnT tp m a -> ConnT tp m b -> ConnT tp m a

MonadIO m => MonadIO (ConnT tp m)

Defined in Metro.Conn

Methods

liftIO :: IO a -> ConnT tp m a

MonadUnliftIO m => MonadUnliftIO (ConnT tp m)

Defined in Metro.Conn

Methods

withRunInIO :: ((forall a. ConnT tp m a -> IO a) -> IO b) -> ConnT tp m b

data ConnEnv tp

Instances

Monad m => MonadReader (ConnEnv tp) (ConnT tp m)

Defined in Metro.Conn

Methods

ask :: ConnT tp m (ConnEnv tp)

local :: (ConnEnv tp -> ConnEnv tp) -> ConnT tp m a -> ConnT tp m a

reader :: (ConnEnv tp -> a) -> ConnT tp m a

runConnT :: ConnEnv tp -> ConnT tp m a -> m a

initConnEnv :: (MonadIO m, Transport tp) => TransportConfig tp -> m (ConnEnv tp)

data SessionT u nid k rpkt tp m a

Instances

FromConn (SessionT u nid k rpkt)

Defined in Metro.Session

Methods

fromConn :: forall (n :: Type -> Type) tp a. Monad n => ConnT tp n a -> SessionT u nid k rpkt tp n a

Monad m => MonadReader (SessionEnv u nid k rpkt) (SessionT u nid k rpkt tp m)

Defined in Metro.Session

Methods

ask :: SessionT u nid k rpkt tp m (SessionEnv u nid k rpkt)

local :: (SessionEnv u nid k rpkt -> SessionEnv u nid k rpkt) -> SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m a

reader :: (SessionEnv u nid k rpkt -> a) -> SessionT u nid k rpkt tp m a

MonadTrans (SessionT u nid k rpkt tp)

Defined in Metro.Session

Methods

lift :: Monad m => m a -> SessionT u nid k rpkt tp m a

Monad m => Monad (SessionT u nid k rpkt tp m)

Defined in Metro.Session

Methods

(>>=) :: SessionT u nid k rpkt tp m a -> (a -> SessionT u nid k rpkt tp m b) -> SessionT u nid k rpkt tp m b

(>>) :: SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m b -> SessionT u nid k rpkt tp m b

return :: a -> SessionT u nid k rpkt tp m a

Functor m => Functor (SessionT u nid k rpkt tp m)

Defined in Metro.Session

Methods

fmap :: (a -> b) -> SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m b

(<$) :: a -> SessionT u nid k rpkt tp m b -> SessionT u nid k rpkt tp m a

Applicative m => Applicative (SessionT u nid k rpkt tp m)

Defined in Metro.Session

Methods

pure :: a -> SessionT u nid k rpkt tp m a

(<*>) :: SessionT u nid k rpkt tp m (a -> b) -> SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m b

liftA2 :: (a -> b -> c) -> SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m b -> SessionT u nid k rpkt tp m c

(*>) :: SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m b -> SessionT u nid k rpkt tp m b

(<*) :: SessionT u nid k rpkt tp m a -> SessionT u nid k rpkt tp m b -> SessionT u nid k rpkt tp m a

MonadIO m => MonadIO (SessionT u nid k rpkt tp m)

Defined in Metro.Session

Methods

liftIO :: IO a -> SessionT u nid k rpkt tp m a

MonadUnliftIO m => MonadUnliftIO (SessionT u nid k rpkt tp m)

Defined in Metro.Session

Methods

withRunInIO :: ((forall a. SessionT u nid k rpkt tp m a -> IO a) -> IO b) -> SessionT u nid k rpkt tp m b

sessionState :: MonadIO m => SessionT u nid k rpkt tp m Bool

send :: (MonadUnliftIO m, Transport tp, SendPacket spkt, SetPacketId k spkt) => spkt -> SessionT u nid k rpkt tp m ()

receive :: (MonadIO m, Transport tp) => SessionT u nid k rpkt tp m (Maybe rpkt)

makeResponse :: (MonadUnliftIO m, Transport tp, SendPacket spkt, SetPacketId k spkt) => (rpkt -> m (Maybe spkt)) -> SessionT u nid k rpkt tp m ()

makeResponse_ :: (MonadUnliftIO m, Transport tp, SendPacket spkt, SetPacketId k spkt) => (rpkt -> Maybe spkt) -> SessionT u nid k rpkt tp m ()

data NodeT u nid k rpkt tp m a

Instances

FromConn (NodeT u nid k rpkt)

Defined in Metro.Node

Methods

fromConn :: forall (n :: Type -> Type) tp a. Monad n => ConnT tp n a -> NodeT u nid k rpkt tp n a

Monad m => MonadReader (NodeEnv u nid k rpkt) (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

ask :: NodeT u nid k rpkt tp m (NodeEnv u nid k rpkt)

local :: (NodeEnv u nid k rpkt -> NodeEnv u nid k rpkt) -> NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m a

reader :: (NodeEnv u nid k rpkt -> a) -> NodeT u nid k rpkt tp m a

MonadTrans (NodeT u nid k rpkt tp)

Defined in Metro.Node

Methods

lift :: Monad m => m a -> NodeT u nid k rpkt tp m a

Monad m => Monad (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

(>>=) :: NodeT u nid k rpkt tp m a -> (a -> NodeT u nid k rpkt tp m b) -> NodeT u nid k rpkt tp m b

(>>) :: NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m b -> NodeT u nid k rpkt tp m b

return :: a -> NodeT u nid k rpkt tp m a

Functor m => Functor (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

fmap :: (a -> b) -> NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m b

(<$) :: a -> NodeT u nid k rpkt tp m b -> NodeT u nid k rpkt tp m a

Applicative m => Applicative (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

pure :: a -> NodeT u nid k rpkt tp m a

(<*>) :: NodeT u nid k rpkt tp m (a -> b) -> NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m b

liftA2 :: (a -> b -> c) -> NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m b -> NodeT u nid k rpkt tp m c

(*>) :: NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m b -> NodeT u nid k rpkt tp m b

(<*) :: NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m b -> NodeT u nid k rpkt tp m a

MonadIO m => MonadIO (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

liftIO :: IO a -> NodeT u nid k rpkt tp m a

MonadUnliftIO m => MonadUnliftIO (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

withRunInIO :: ((forall a. NodeT u nid k rpkt tp m a -> IO a) -> IO b) -> NodeT u nid k rpkt tp m b

data NodeEnv1 u nid k rpkt tp

Constructors

NodeEnv1

Fields

• nodeEnv :: NodeEnv u nid k rpkt
• connEnv :: ConnEnv tp

data NodeEnv u nid k rpkt

Instances

Monad m => MonadReader (NodeEnv u nid k rpkt) (NodeT u nid k rpkt tp m)

Defined in Metro.Node

Methods

ask :: NodeT u nid k rpkt tp m (NodeEnv u nid k rpkt)

local :: (NodeEnv u nid k rpkt -> NodeEnv u nid k rpkt) -> NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m a

reader :: (NodeEnv u nid k rpkt -> a) -> NodeT u nid k rpkt tp m a

data SessionMode

Constructors

SingleAction

MultiAction

Instances

Eq SessionMode

Defined in Metro.Node

Methods

(==) :: SessionMode -> SessionMode -> Bool

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

Show SessionMode

Defined in Metro.Node

Methods

showsPrec :: Int -> SessionMode -> ShowS

show :: SessionMode -> String

showList :: [SessionMode] -> ShowS

data NodeMode

Constructors

Single

Multi

Instances

Eq NodeMode

Defined in Metro.Node

Methods

(==) :: NodeMode -> NodeMode -> Bool

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

Show NodeMode

Defined in Metro.Node

Methods

showsPrec :: Int -> NodeMode -> ShowS

show :: NodeMode -> String

showList :: [NodeMode] -> ShowS

runNodeT :: NodeEnv u nid k rpkt -> NodeT u nid k rpkt tp m a -> ConnT tp m a

runNodeT1 :: NodeEnv1 u nid k rpkt tp -> NodeT u nid k rpkt tp m a -> m a

initEnv :: MonadIO m => u -> nid -> IO k -> m (NodeEnv u nid k rpkt)

withEnv :: Monad m => u -> NodeT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m a

initEnv1 :: MonadIO m => (NodeEnv u nid k rpkt -> NodeEnv u nid k rpkt) -> ConnEnv tp -> u -> nid -> IO k -> m (NodeEnv1 u nid k rpkt tp)

getEnv1 :: (Monad m, Transport tp) => NodeT u nid k rpkt tp m (NodeEnv1 u nid k rpkt tp)

runSessionT_ :: Monad m => SessionEnv u nid k rpkt -> SessionT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m a

withSessionT :: (MonadUnliftIO m, Eq k, Hashable k) => Maybe Int64 -> SessionT u nid k rpkt tp m a -> NodeT u nid k rpkt tp m a

newSessionEnv :: (MonadIO m, Eq k, Hashable k) => Maybe Int64 -> k -> NodeT u nid k rpkt tp m (SessionEnv u nid k rpkt)

nextSessionId :: MonadIO m => NodeT u nid k rpkt tp m k

busy :: MonadIO m => NodeT u nid k rpkt tp m Bool

startNodeT :: (MonadUnliftIO m, Transport tp, RecvPacket rpkt, GetPacketId k rpkt, Eq k, Hashable k) => SessionT u nid k rpkt tp m () -> NodeT u nid k rpkt tp m ()

startNodeT_ :: (MonadUnliftIO m, Transport tp, RecvPacket rpkt, GetPacketId k rpkt, Eq k, Hashable k) => (rpkt -> m Bool) -> SessionT u nid k rpkt tp m () -> NodeT u nid k rpkt tp m ()

nodeState :: MonadIO m => NodeT u nid k rpkt tp m Bool

stopNodeT :: (MonadIO m, Transport tp) => NodeT u nid k rpkt tp m ()

env :: Monad m => NodeT u nid k rpkt tp m u

request :: (MonadUnliftIO m, Transport tp, SendPacket spkt, SetPacketId k spkt, Eq k, Hashable k) => Maybe Int64 -> spkt -> NodeT u nid k rpkt tp m (Maybe rpkt)

requestAndRetry :: (MonadUnliftIO m, Transport tp, SendPacket spkt, SetPacketId k spkt, Eq k, Hashable k) => Maybe Int64 -> Maybe Int -> spkt -> NodeT u nid k rpkt tp m (Maybe rpkt)

getTimer :: MonadIO m => NodeT u nid k rpkt tp m Int64

getNodeId :: Monad m => NodeT n nid k rpkt tp m nid

getSessionSize :: MonadIO m => NodeEnv u nid k rpkt -> m Int

getSessionSize1 :: MonadIO m => NodeEnv1 u nid k rpkt tp -> m Int

data ServerT serv u nid k rpkt tp m a

Instances

MonadTrans (ServerT serv u nid k rpkt tp)

Defined in Metro.Server

Methods

lift :: Monad m => m a -> ServerT serv u nid k rpkt tp m a

Monad m => MonadReader (ServerEnv serv u nid k rpkt tp) (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

ask :: ServerT serv u nid k rpkt tp m (ServerEnv serv u nid k rpkt tp)

local :: (ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp) -> ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m a

reader :: (ServerEnv serv u nid k rpkt tp -> a) -> ServerT serv u nid k rpkt tp m a

Monad m => Monad (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

(>>=) :: ServerT serv u nid k rpkt tp m a -> (a -> ServerT serv u nid k rpkt tp m b) -> ServerT serv u nid k rpkt tp m b

(>>) :: ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m b -> ServerT serv u nid k rpkt tp m b

return :: a -> ServerT serv u nid k rpkt tp m a

Functor m => Functor (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

fmap :: (a -> b) -> ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m b

(<$) :: a -> ServerT serv u nid k rpkt tp m b -> ServerT serv u nid k rpkt tp m a

Applicative m => Applicative (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

pure :: a -> ServerT serv u nid k rpkt tp m a

(<*>) :: ServerT serv u nid k rpkt tp m (a -> b) -> ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m b

liftA2 :: (a -> b -> c) -> ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m b -> ServerT serv u nid k rpkt tp m c

(*>) :: ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m b -> ServerT serv u nid k rpkt tp m b

(<*) :: ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m b -> ServerT serv u nid k rpkt tp m a

MonadIO m => MonadIO (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

liftIO :: IO a -> ServerT serv u nid k rpkt tp m a

MonadUnliftIO m => MonadUnliftIO (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

withRunInIO :: ((forall a. ServerT serv u nid k rpkt tp m a -> IO a) -> IO b) -> ServerT serv u nid k rpkt tp m b

data ServerEnv serv u nid k rpkt tp

Instances

Monad m => MonadReader (ServerEnv serv u nid k rpkt tp) (ServerT serv u nid k rpkt tp m)

Defined in Metro.Server

Methods

ask :: ServerT serv u nid k rpkt tp m (ServerEnv serv u nid k rpkt tp)

local :: (ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp) -> ServerT serv u nid k rpkt tp m a -> ServerT serv u nid k rpkt tp m a

reader :: (ServerEnv serv u nid k rpkt tp -> a) -> ServerT serv u nid k rpkt tp m a

runServerT :: ServerEnv serv u nid k rpkt tp -> ServerT serv u nid k rpkt tp m a -> m a

initServerEnv :: (MonadIO m, Servable serv) => ServerConfig serv -> IO k -> (TransportConfig (STP serv) -> TransportConfig tp) -> (SID serv -> ConnEnv tp -> IO (Maybe (nid, u))) -> m (ServerEnv serv u nid k rpkt tp)

setNodeMode :: NodeMode -> ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp

setSessionMode :: SessionMode -> ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp

setServerName :: String -> ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp

setKeepalive :: Int64 -> ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp

setDefaultSessionTimeout :: Int64 -> ServerEnv serv u nid k rpkt tp -> ServerEnv serv u nid k rpkt tp

setOnNodeLeave :: MonadIO m => ServerEnv serv u nid k rpkt tp -> (nid -> u -> IO ()) -> m ()

handleConn :: (MonadUnliftIO m, Transport tp, Show nid, Eq nid, Hashable nid, Eq k, Hashable k, GetPacketId k rpkt, RecvPacket rpkt, Servable serv) => String -> SID serv -> ConnEnv tp -> nid -> u -> (rpkt -> m Bool) -> SessionT u nid k rpkt tp m () -> ServerT serv u nid k rpkt tp m (NodeEnv1 u nid k rpkt tp, Async ())

startServer :: (MonadUnliftIO m, Transport tp, Show nid, Eq nid, Hashable nid, Eq k, Hashable k, GetPacketId k rpkt, RecvPacket rpkt, Servable serv) => ServerEnv serv u nid k rpkt tp -> SessionT u nid k rpkt tp m () -> m ()

startServer_ :: (MonadUnliftIO m, Transport tp, Show nid, Eq nid, Hashable nid, Eq k, Hashable k, GetPacketId k rpkt, RecvPacket rpkt, Servable serv) => ServerEnv serv u nid k rpkt tp -> (rpkt -> m Bool) -> SessionT u nid k rpkt tp m () -> m ()

stopServerT :: (MonadIO m, Servable serv) => ServerT serv u nid k rpkt tp m ()

serverEnv :: Monad m => ServerT serv u nid k rpkt tp m (ServerEnv serv u nid k rpkt tp)

getNodeEnvList :: ServerEnv serv u nid k rpkt tp -> IOHashMap nid (NodeEnv1 u nid k rpkt tp)

getServ :: ServerEnv serv u nid k rpkt tp -> serv