Data.BinaryCom

Binary Communicator

This module provides the datatype BinaryCom, which enables you to easily send and receive data to and from a binary source. The transmitted data can be an instance of the Binary class, or you can provide your own Put and Get actions to serialize and parse the binary stream.

Documentation

data BinaryCom

BinaryCom type

binaryCom :: MonadIO m => Handle -> m BinaryCom

Creates a BinaryCom from a Handle opened for both reading and writing. Be careful not to use the handle afterwards

binaryCom2H

Arguments

:: MonadIO m

=> Handle

For reading

-> Handle

For writing

-> m BinaryCom

New BinaryCom

Creates a BinaryCom from two Handles: one for reading, one for writing

binaryComBS

Arguments

:: MonadIO m

=> ByteString

For reading

-> Handle

For writing

-> m BinaryCom

New BinaryCom

Creates a BinaryCom from a lazy ByteString (for reading) and a Handle (for writing)

send :: (Binary a, MonadIO m) => BinaryCom -> a -> m ()

Sends a serializable value through a BinaryCom

flush :: MonadIO m => BinaryCom -> m ()

Flushes a BinaryCom. Do not forget to do this after sending!

sendFlush :: (Binary a, MonadIO m) => BinaryCom -> a -> m ()

Shortcut for sending a value and flushing the BinaryCom

receive :: (Binary a, MonadIO m) => BinaryCom -> m a

Receives a serializable value through a BinaryCom

sendPut :: MonadIO m => BinaryCom -> Put -> m ()

Runs a Put monad and sends its result

receiveGet :: MonadIO m => BinaryCom -> Get a -> m a

Receives a value. Runs a Get monad to parse it