Metro.Class

Documentation

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 :: Type

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) :: Type

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

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 RecvPacket rpkt where

Methods

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

class SendPacket spkt where

Minimal complete definition

Nothing

Methods

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

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

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

class SetPacketId k pkt where

Methods

setPacketId :: k -> pkt -> pkt

class GetPacketId k pkt where

Methods

getPacketId :: pkt -> k