Control.TimeWarp.Rpc.Message

This module defines typeclasses which allow to abstragate from concrete serialization strategy, and also Message type, which binds a name to request.

UPGRADE-NOTE: currently only Binary serialization is supported, need to add support for MessagePack, aeson, cereal e.t.c.

Message

type MessageName = Text

Message name, which is expected to uniquely define type of message.

class Typeable m => Message m where

Defines type with it's own MessageName.

Methods

messageName :: Proxy m -> MessageName

Uniquely identifies this type

messageName :: Data m => Proxy m -> MessageName

Uniquely identifies this type

formatMessage :: m -> Text

Description of message, for debug purposes

formatMessage :: Buildable m => m -> Text

Description of message, for debug purposes

Serialization and deserialization

class PackingType p where

Defines a serialization / deserialization strategy. Deserealization is assumed to be performed in two phases:

• byte stream -> intermediate form
• intermediate form -> any part of message (or their combination)

Minimal complete definition

unpackMsg

Associated Types

type IntermediateForm p :: *

Defines intermediate form

Methods

unpackMsg :: MonadThrow m => p -> Conduit ByteString m (IntermediateForm p)

Way of unpacking raw bytes to intermediate form.

Instances

Binary h => PackingType (BinaryP h)

Associated Types

type IntermediateForm (BinaryP h) :: *

Methods

unpackMsg :: MonadThrow m => BinaryP h -> Conduit ByteString m (IntermediateForm (BinaryP h))

class PackingType p => Packable p r where

Defines a way to serialize object r with given packing type p.

Minimal complete definition

packMsg

Methods

packMsg :: MonadThrow m => p -> Conduit r m ByteString

Way of packing data to raw bytes.

Instances

Binary h => Packable (BinaryP h) (WithHeaderData h RawData)

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h RawData) m ByteString

(Binary h, Binary r, Message r) => Packable (BinaryP h) (WithHeaderData h (ContentData r))

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h (ContentData r)) m ByteString

class PackingType p => Unpackable p r where

Defines a way to deserealize data with given packing type p and extract object r.

Minimal complete definition

extractMsgPart

Methods

extractMsgPart :: MonadThrow m => p -> IntermediateForm p -> m r

Way to extract message part from intermediate form.

Instances

Binary h => Unpackable (BinaryP h) NameData

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m NameData

(Binary h, Binary r) => Unpackable (BinaryP h) (ContentData r)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (ContentData r)

Binary h => Unpackable (BinaryP h) (WithHeaderData h RawData)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (WithHeaderData h RawData)

Basic packing types

data BinaryP header

Defines way to encode Binary instances into message of format (header, [[name], content]), where [x] = (length of x, x). P here denotes to "packing".

Constructors

BinaryP

Instances

Binary h => PackingType (BinaryP h)

Associated Types

type IntermediateForm (BinaryP h) :: *

Methods

unpackMsg :: MonadThrow m => BinaryP h -> Conduit ByteString m (IntermediateForm (BinaryP h))

Binary h => Unpackable (BinaryP h) NameData

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m NameData

(Binary h, Binary r) => Unpackable (BinaryP h) (ContentData r)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (ContentData r)

Binary h => Unpackable (BinaryP h) (WithHeaderData h RawData)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (WithHeaderData h RawData)

Binary h => Packable (BinaryP h) (WithHeaderData h RawData)

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h RawData) m ByteString

(Binary h, Binary r, Message r) => Packable (BinaryP h) (WithHeaderData h (ContentData r))

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h (ContentData r)) m ByteString

type IntermediateForm (BinaryP h)

type IntermediateForm (BinaryP h) = WithHeaderData h RawData

plainBinaryP :: BinaryP ()

Parts of message

This part describes different parts of message. which are enought for serializing message / could be extracted on deserializing.

| Message's content.

data ContentData r

Constructors

ContentData r

Instances

(Binary h, Binary r) => Unpackable (BinaryP h) (ContentData r)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (ContentData r)

(Binary h, Binary r, Message r) => Packable (BinaryP h) (WithHeaderData h (ContentData r))

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h (ContentData r)) m ByteString

data NameData

Message's name.

Constructors

NameData MessageName

Instances

Binary h => Unpackable (BinaryP h) NameData

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m NameData

data RawData

Designates data given from incoming message, but not deserialized to any specified object.

Constructors

RawData ByteString

Instances

Binary h => Unpackable (BinaryP h) (WithHeaderData h RawData)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (WithHeaderData h RawData)

Binary h => Packable (BinaryP h) (WithHeaderData h RawData)

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h RawData) m ByteString

data WithHeaderData h r

Message's header & something else

Constructors

WithHeaderData h r

Instances

Binary h => Unpackable (BinaryP h) (WithHeaderData h RawData)

Methods

extractMsgPart :: MonadThrow m => BinaryP h -> IntermediateForm (BinaryP h) -> m (WithHeaderData h RawData)

Binary h => Packable (BinaryP h) (WithHeaderData h RawData)

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h RawData) m ByteString

(Binary h, Binary r, Message r) => Packable (BinaryP h) (WithHeaderData h (ContentData r))

Methods

packMsg :: MonadThrow m => BinaryP h -> Conduit (WithHeaderData h (ContentData r)) m ByteString

Util

messageName' :: Message m => m -> MessageName

As messageName, but accepts message itself, may be more convinient is most cases.

runGetOrThrow :: MonadThrow m => Get a -> ByteString -> m a

Parses given bytestring, throwing ParseError on fail.