License	BSD-3-Clause
Safe Haskell	None
Language	GHC2021

M.IO.Internal.EffectTypes

Contents

Core effect
Types
Effect operations
Configuration

Description

This module defines the core effects used for networking in the Minecraft protocol implementation. It provides bidirectional packet communication with compression and encryption support.

Synopsis

data Talking (a :: Type -> Type) b where
- Hear :: forall b (a :: Type -> Type). (Unpack b, Typeable b) => Immediately -> Talking a b
- HearU :: forall (a :: Type -> Type). Immediately -> Talking a Uninterpreted
- HearA :: forall (a :: Type -> Type). Immediately -> Talking a SomeUnpack
- Say :: forall a1 (a :: Type -> Type). (Pack a1, Typeable a1) => a1 -> Talking a ()
- Setcompression :: forall (a :: Type -> Type). Int -> Talking a ()
- Setencryption :: forall (a :: Type -> Type). ByteString -> Talking a ()
data Direction
- = Inbound
- | Outbound
data Immediately
- = Immediately
- | Eventually
data Op r where
- Parse :: Uninterpreted -> Op SomeUnpack
- Code :: Direction -> TypeRep -> Op (Maybe Word8)
newtype ParserState = ParserState {
- send2parserstate :: forall r. Op r -> r
}
type Talking' (es :: [Effect]) = (Talking :> es, State ParserState :> es, NonDet :> es)
hear :: forall a (es :: [Effect]). (HasCallStack, Talking :> es, Unpack a, Typeable a) => Immediately -> Eff es a
hearU :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => Immediately -> Eff es Uninterpreted
hearA :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => Immediately -> Eff es SomeUnpack
say :: forall a (es :: [Effect]). (HasCallStack, Talking :> es, Pack a, Typeable a) => a -> Eff es ()
setcompression :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => Int -> Eff es ()
setencryption :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => ByteString -> Eff es ()
enter :: forall (es :: [Effect]). State ParserState :> es => ParserState -> Eff es ()

Core effect

data Talking (a :: Type -> Type) b where Source #

the communication effect

Constructors

Hear :: forall b (a :: Type -> Type). (Unpack b, Typeable b) => Immediately -> Talking a b	listen for a message and assert its type when immediately is set and message missing, invoke `Empty`
HearU :: forall (a :: Type -> Type). Immediately -> Talking a Uninterpreted	listen for a raw uninterpreted message when immediately is set and message missing, invoke `Empty`
HearA :: forall (a :: Type -> Type). Immediately -> Talking a SomeUnpack	listen for a message with dynamic unpacking when immediately is set and message missing, invoke `Empty`
Say :: forall a1 (a :: Type -> Type). (Pack a1, Typeable a1) => a1 -> Talking a ()	send a message
Setcompression :: forall (a :: Type -> Type). Int -> Talking a ()	set the compression threshold non-negative: compress messages larger than this size negative: disable compression
Setencryption :: forall (a :: Type -> Type). ByteString -> Talking a ()	set the encryption key

Instances

Instances details

type DispatchOf Talking Source #
Instance details Defined in M.IO.Internal.EffectTypes type DispatchOf Talking = 'Dynamic

Types

data Direction Source #

relative packet direction. Used to identify packet flow without hardcoding client/server roles

Constructors

Inbound
Outbound

Instances

Instances details

Data Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Direction -> c Direction #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Direction #

toConstr :: Direction -> Constr #

dataTypeOf :: Direction -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Direction) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Direction) #

gmapT :: (forall b. Data b => b -> b) -> Direction -> Direction #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Direction -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Direction -> r #

gmapQ :: (forall d. Data d => d -> u) -> Direction -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Direction -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Direction -> m Direction #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Direction -> m Direction #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Direction -> m Direction #

Bounded Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

minBound :: Direction #

maxBound :: Direction #

Enum Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

succ :: Direction -> Direction #

pred :: Direction -> Direction #

toEnum :: Int -> Direction #

fromEnum :: Direction -> Int #

enumFrom :: Direction -> [Direction] #

enumFromThen :: Direction -> Direction -> [Direction] #

enumFromTo :: Direction -> Direction -> [Direction] #

enumFromThenTo :: Direction -> Direction -> Direction -> [Direction] #

Generic Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Associated Types

type Rep Direction
Instance details Defined in M.IO.Internal.EffectTypes type Rep Direction = D1 ('MetaData "Direction" "M.IO.Internal.EffectTypes" "mmm-0.1.0.0-oCDsNp3EBL2JzoyA6cTai" 'False) (C1 ('MetaCons "Inbound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Outbound" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Direction -> Rep Direction x #

to :: Rep Direction x -> Direction #

Read Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

readsPrec :: Int -> ReadS Direction #

readList :: ReadS [Direction] #

readPrec :: ReadPrec Direction #

readListPrec :: ReadPrec [Direction] #

Show Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

showsPrec :: Int -> Direction -> ShowS #

show :: Direction -> String #

showList :: [Direction] -> ShowS #

NFData Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

rnf :: Direction -> () #

Eq Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

(==) :: Direction -> Direction -> Bool #

(/=) :: Direction -> Direction -> Bool #

Ord Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

compare :: Direction -> Direction -> Ordering #

(<) :: Direction -> Direction -> Bool #

(<=) :: Direction -> Direction -> Bool #

(>) :: Direction -> Direction -> Bool #

(>=) :: Direction -> Direction -> Bool #

max :: Direction -> Direction -> Direction #

min :: Direction -> Direction -> Direction #

Hashable Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

hashWithSalt :: Int -> Direction -> Int

hash :: Direction -> Int

Lift Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

lift :: Quote m => Direction -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Direction -> Code m Direction #

type Rep Direction Source #

Instance details

Defined in M.IO.Internal.EffectTypes

type Rep Direction = D1 ('MetaData "Direction" "M.IO.Internal.EffectTypes" "mmm-0.1.0.0-oCDsNp3EBL2JzoyA6cTai" 'False) (C1 ('MetaCons "Inbound" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Outbound" 'PrefixI 'False) (U1 :: Type -> Type))

data Immediately Source #

urgency level for receiving packets

Constructors

Immediately
Eventually

Instances

Instances details

Data Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Immediately -> c Immediately #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Immediately #

toConstr :: Immediately -> Constr #

dataTypeOf :: Immediately -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Immediately) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Immediately) #

gmapT :: (forall b. Data b => b -> b) -> Immediately -> Immediately #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Immediately -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Immediately -> r #

gmapQ :: (forall d. Data d => d -> u) -> Immediately -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Immediately -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Immediately -> m Immediately #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Immediately -> m Immediately #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Immediately -> m Immediately #

Bounded Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

minBound :: Immediately #

maxBound :: Immediately #

Enum Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

succ :: Immediately -> Immediately #

pred :: Immediately -> Immediately #

toEnum :: Int -> Immediately #

fromEnum :: Immediately -> Int #

enumFrom :: Immediately -> [Immediately] #

enumFromThen :: Immediately -> Immediately -> [Immediately] #

enumFromTo :: Immediately -> Immediately -> [Immediately] #

enumFromThenTo :: Immediately -> Immediately -> Immediately -> [Immediately] #

Generic Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Associated Types

type Rep Immediately
Instance details Defined in M.IO.Internal.EffectTypes type Rep Immediately = D1 ('MetaData "Immediately" "M.IO.Internal.EffectTypes" "mmm-0.1.0.0-oCDsNp3EBL2JzoyA6cTai" 'False) (C1 ('MetaCons "Immediately" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Eventually" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Immediately -> Rep Immediately x #

to :: Rep Immediately x -> Immediately #

Read Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

readsPrec :: Int -> ReadS Immediately #

readList :: ReadS [Immediately] #

readPrec :: ReadPrec Immediately #

readListPrec :: ReadPrec [Immediately] #

Show Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

showsPrec :: Int -> Immediately -> ShowS #

show :: Immediately -> String #

showList :: [Immediately] -> ShowS #

NFData Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

rnf :: Immediately -> () #

Eq Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

(==) :: Immediately -> Immediately -> Bool #

(/=) :: Immediately -> Immediately -> Bool #

Ord Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

compare :: Immediately -> Immediately -> Ordering #

(<) :: Immediately -> Immediately -> Bool #

(<=) :: Immediately -> Immediately -> Bool #

(>) :: Immediately -> Immediately -> Bool #

(>=) :: Immediately -> Immediately -> Bool #

max :: Immediately -> Immediately -> Immediately #

min :: Immediately -> Immediately -> Immediately #

Hashable Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

hashWithSalt :: Int -> Immediately -> Int

hash :: Immediately -> Int

Lift Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

Methods

lift :: Quote m => Immediately -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Immediately -> Code m Immediately #

type Rep Immediately Source #

Instance details

Defined in M.IO.Internal.EffectTypes

type Rep Immediately = D1 ('MetaData "Immediately" "M.IO.Internal.EffectTypes" "mmm-0.1.0.0-oCDsNp3EBL2JzoyA6cTai" 'False) (C1 ('MetaCons "Immediately" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Eventually" 'PrefixI 'False) (U1 :: Type -> Type))

data Op r where Source #

operations on a packet

Constructors

Parse :: Uninterpreted -> Op SomeUnpack	parse any packet
Code :: Direction -> TypeRep -> Op (Maybe Word8)	find code of a packet based on its `TypeRep`

Instances

Instances details

Show (Op r) Source #
Instance details Defined in M.IO.Internal.EffectTypes Methods showsPrec :: Int -> Op r -> ShowS # show :: Op r -> String # showList :: [Op r] -> ShowS #
NFData (Op r) Source #
Instance details Defined in M.IO.Internal.EffectTypes Methods rnf :: Op r -> () #
Eq (Op r) Source #
Instance details Defined in M.IO.Internal.EffectTypes Methods (==) :: Op r -> Op r -> Bool # (/=) :: Op r -> Op r -> Bool #
Ord (Op r) Source #
Instance details Defined in M.IO.Internal.EffectTypes Methods compare :: Op r -> Op r -> Ordering # (<) :: Op r -> Op r -> Bool # (<=) :: Op r -> Op r -> Bool # (>) :: Op r -> Op r -> Bool # (>=) :: Op r -> Op r -> Bool # max :: Op r -> Op r -> Op r # min :: Op r -> Op r -> Op r #
Hashable (Op r) Source #
Instance details Defined in M.IO.Internal.EffectTypes Methods hashWithSalt :: Int -> Op r -> Int hash :: Op r -> Int

newtype ParserState Source #

parser state object (as in object-oriented programming)

Constructors

ParserState
Fields send2parserstate :: forall r. Op r -> r send a "message" to the parser state and get a response

Effect operations

type Talking' (es :: [Effect]) = (Talking :> es, State ParserState :> es, NonDet :> es) Source #

the communication effect with parser state and non-determinism

hear :: forall a (es :: [Effect]). (HasCallStack, Talking :> es, Unpack a, Typeable a) => Immediately -> Eff es a Source #

listen for a message and assert its type

when immediately is set and message missing, invoke Empty

hearU :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => Immediately -> Eff es Uninterpreted Source #

listen for a raw uninterpreted message

when immediately is set and message missing, invoke Empty

hearA :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => Immediately -> Eff es SomeUnpack Source #

listen for a message with dynamic unpacking

when immediately is set and message missing, invoke Empty

say :: forall a (es :: [Effect]). (HasCallStack, Talking :> es, Pack a, Typeable a) => a -> Eff es () Source #

send a message

Configuration

setcompression :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => Int -> Eff es () Source #

set the compression threshold

non-negative: compress messages larger than this size
negative: disable compression

setencryption :: forall (es :: [Effect]). (HasCallStack, Talking :> es) => ByteString -> Eff es () Source #

set the encryption key

enter :: forall (es :: [Effect]). State ParserState :> es => ParserState -> Eff es () Source #

enter the parser state