Game.GoreAndAsh.Network.API

The module contains monadic and arrow API of network core module.

Documentation

class (MonadIO m, MonadCatch m) => NetworkMonad m where

Low-level monadic API of the core module

Methods

networkBind

Arguments

:: LoggingMonad m

=> Maybe SockAddr

Address to listen, Nothing is client

-> Word

Maximum count of connections

-> Word

Number of channels to open

-> Word32

Incoming max bandwidth

-> Word32

Outcoming max bandwidth

-> m ()

Start listening for messages, should be called once

peersConnectedM :: m (Seq Peer)

Returns peers that were connected during last frame

peersDisconnectedM :: m (Seq Peer)

Returns peers that were disconnected during last frame

networkConnect

Arguments

:: LoggingMonad m

=> SockAddr

Address of host

-> Word

Count of channels to open

-> Word32

Additional data (0 default)

-> m (Maybe ())

Initiate connection to the remote host

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

Returns received packets for given peer and channel

peerSendM :: LoggingMonad m => Peer -> ChannelID -> Message -> m ()

Sends a packet to given peer on given channel

networkPeersM :: m (Seq Peer)

Returns list of currently connected peers (servers on client side, clients on server side)

networkSetDetailedLoggingM :: Bool -> m ()

Sets flag for detailed logging (for debug)

networkChannels :: m Word

Return count of allocated network channels

Instances

(MonadIO (mt m), MonadCatch (mt m), LoggingMonad m, NetworkMonad m, MonadTrans mt) => NetworkMonad (mt m)

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

Peer handling

peersConnected :: (LoggingMonad m, NetworkMonad m) => GameWire m a (Event (Seq Peer))

Fires when one or several clients were connected

peersDisconnected :: (LoggingMonad m, NetworkMonad m) => GameWire m a (Event (Seq Peer))

Fires when one of connected peers is disconnected for some reason

peerDisconnected :: (LoggingMonad m, NetworkMonad m) => Peer -> GameWire m a (Event ())

Fires when statically known peer is disconnected

currentPeers :: (LoggingMonad m, NetworkMonad m) => GameWire m a (Seq Peer)

Returns list of current peers (clients on server, servers on client)

onPeers

Arguments

:: (MonadFix m, LoggingMonad m, NetworkMonad m)

=> (Seq Peer -> GameWire m a b)

Wire that uses current peer collection

-> GameWire m a b

Sometimes you want to listen all peers and use statefull computations at the same time.

The helper maintance internal collection of current peers and switches over it each time it changes.

Messaging support

peerMessages :: (LoggingMonad m, NetworkMonad m) => Peer -> ChannelID -> GameWire m a (Event (Seq ByteString))

Returns sequence of packets that were recieved during last frame from given peer and channel id

peerSend :: (LoggingMonad m, NetworkMonad m) => Peer -> ChannelID -> GameWire m (Event Message) (Event ())

Send message to given peer with given channel id

peerSendMany :: (LoggingMonad m, NetworkMonad m, Foldable t) => Peer -> ChannelID -> GameWire m (Event (t Message)) (Event ())

Send several messages to given peer with given channel id