Network.Transport

A Transport abstracts the details of message delivery, and defines the interfaces that specific Transport implementations should provide in order to deliver messages for Endpoints.

Documentation

type Address = String

A Mailbox is a place where transports can put messages for Endpoints to receive. Typically Endpoints will use the same Mailbox when binding or connecting with a Transport.

An address is a logical identifier suitable for establishing a connection to another Endpoint over a Transport. It's use (if at all) is specific to the Transport in question.

data Binding

Bindings are a site for receiving messages on a particular Address through a Transport.

Constructors

Binding

Fields

bindingName :: Name

unbind :: IO ()

data Envelope

An Envelope is a container for a Message with the Address of the Message's destination.

Constructors

Envelope

Fields

envelopeDestination :: Name

envelopeContents :: Message

Instances

Eq Envelope

Show Envelope

Generic Envelope

Serialize Envelope

type Message = ByteString

Messages are containers for arbitrary data that may be sent to other Endpoints.

type Name = String

Name for uniquely identifying an Endpoint; suitable for identifying the target destination for a Message.

data Resolver

A Resolver translates a name into an Address, if possible. Transports may find resolvers useful for determing where to reach a specific Endpoint, given it''s Name.

resolve :: Resolver -> Name -> IO (Maybe Address)

Ask the Resolver to find one or more Addresses for the provided Name, if any are available from this resolver.

resolverFromList :: [(Name, Address)] -> Resolver

A simple Resolver that accepts an association list of Names to Addresses and returns the addresses associated with a given name in the list.

type Scheme = String

A scheme is an identifier for a discrete type of transport.

data Transport

A Transport defines a specific method for establishing connections between Endpoints.

Constructors

Transport

Fields

scheme :: String

handles :: Name -> IO Bool

bind :: Mailbox Message -> Name -> IO (Either String Binding)

sendTo :: Name -> Message -> IO ()

shutdown :: IO ()

module Control.Concurrent.Mailbox