Copyright	(c) 2013 Toralf Wittner
License	MIT
Maintainer	Toralf Wittner <tw@dtex.org>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell98

System.ZMQ4.Monadic

Contents

Type Definitions
- Socket type-classes
- Socket Types
General Operations
ZMQ Options (Read)
ZMQ Options (Write)
Socket operations
Socket Options (Read)
Socket Options (Write)
Error Handling
Re-exports
Low-level Functions

Description

This modules exposes a monadic interface of ZMQ4. Actions run inside a ZMQ monad and Sockets are guaranteed not to leak outside their corresponding runZMQ scope. Running ZMQ computations asynchronously is directly supported through async.

Synopsis

Type Definitions

data ZMQ z a Source

The ZMQ monad is modeled after ST and encapsulates a Context. It uses the uninstantiated type variable z to distinguish different invoctions of runZMQ and to prevent unintented use of Sockets outside their scope. Cf. the paper of John Launchbury and Simon Peyton Jones Lazy Functional State Threads.

Instances

Monad (ZMQ z) Source
Functor (ZMQ z) Source
Applicative (ZMQ z) Source
MonadThrow (ZMQ z) Source
MonadCatch (ZMQ z) Source
MonadMask (ZMQ z) Source
MonadIO (ZMQ z) Source

data Socket z t Source

The ZMQ socket, parameterised by SocketType and belonging to a particular ZMQ thread.

Instances

SocketLike (Socket z) Source

data Flag Source

Flags to apply on send operations (cf. man zmq_send)

Constructors

DontWait	ZMQ_DONTWAIT (Only relevant on Windows.)
SendMore	ZMQ_SNDMORE

Instances

Eq Flag Source
Ord Flag Source
Show Flag Source

data Switch Source

Configuration switch

Constructors

Default	Use default setting
On	Activate setting
Off	De-activate setting

Instances

Eq Switch Source
Ord Switch Source
Show Switch Source

type Timeout = Int64 Source

data Event Source

Socket events.

Constructors

In	`ZMQ_POLLIN` (incoming messages)
Out	`ZMQ_POLLOUT` (outgoing messages, i.e. at least 1 byte can be written)
Err	ZMQ_POLLERR

Instances

Eq Event Source
Ord Event Source
Read Event Source
Show Event Source

data EventType Source

Event types to monitor.

Constructors

ConnectedEvent
ConnectDelayedEvent
ConnectRetriedEvent
ListeningEvent
BindFailedEvent
AcceptedEvent
AcceptFailedEvent
ClosedEvent
CloseFailedEvent
DisconnectedEvent
MonitorStoppedEvent
AllEvents

Instances

Eq EventType Source
Ord EventType Source
Show EventType Source

data EventMsg Source

Event Message to receive when monitoring socket events.

Constructors

Connected !ByteString !Fd
ConnectDelayed !ByteString
ConnectRetried !ByteString !Int
Listening !ByteString !Fd
BindFailed !ByteString !Int
Accepted !ByteString !Fd
AcceptFailed !ByteString !Int
Closed !ByteString !Fd
CloseFailed !ByteString !Int
Disconnected !ByteString !Fd
MonitorStopped !ByteString !Int

Instances

Eq EventMsg Source
Show EventMsg Source

data Poll s m where Source

A Poll value contains the object to poll (a 0MQ socket or a file descriptor), the set of Events which are of interest and--optionally-- a callback-function which is invoked iff the set of interested events overlaps with the actual events.

Constructors

Sock :: s t -> [Event] -> Maybe ([Event] -> m ()) -> Poll s m
File :: Fd -> [Event] -> Maybe ([Event] -> m ()) -> Poll s m

data KeyFormat a where Source

Constructors

BinaryFormat :: KeyFormat Div4
TextFormat :: KeyFormat Div5

Instances

Eq (KeyFormat a) Source
Show (KeyFormat a) Source

data SecurityMechanism Source

Constructors

Null
Plain
Curve

Instances

Eq SecurityMechanism Source
Show SecurityMechanism Source

Socket type-classes

class SocketType a Source

Socket types.

Minimal complete definition

zmqSocketType

class Sender a Source

Sockets which can send.

class Receiver a Source

Sockets which can receive.

class Subscriber a Source

Sockets which can subscribe.

Instances

Subscriber Sub Source

class SocketLike s Source

Minimal complete definition

toSocket

Instances

SocketLike Socket Source
SocketLike (Socket z) Source

class Conflatable a Source

Sockets which can be conflated.

Instances

Conflatable Push Source
Conflatable Pull Source
Conflatable Dealer Source
Conflatable Sub Source
Conflatable Pub Source

class SendProbe a Source

Sockets which can send probes (cf. setProbeRouter).

Instances

SendProbe Router Source
SendProbe Dealer Source
SendProbe Req Source

Socket Types

data Pair Source

ZMQ_PAIR

Constructors

Pair

Instances

Eq Pair Source
Generic Pair Source
SocketType Pair Source
Receiver Pair Source
Sender Pair Source
type Rep Pair Source

data Pub Source

ZMQ_PUB

Constructors

Pub

Instances

Eq Pub Source
Generic Pub Source
SocketType Pub Source
Conflatable Pub Source
Sender Pub Source
type Rep Pub Source

data Sub Source

ZMQ_SUB

Constructors

Sub

Instances

Eq Sub Source
Generic Sub Source
SocketType Sub Source
Conflatable Sub Source
Receiver Sub Source
Subscriber Sub Source
type Rep Sub Source

data XPub Source

ZMQ_XPUB

Constructors

XPub

Instances

Eq XPub Source
Generic XPub Source
SocketType XPub Source
Receiver XPub Source
Sender XPub Source
type Rep XPub Source

data XSub Source

ZMQ_XSUB

Constructors

XSub

Instances

Eq XSub Source
Generic XSub Source
SocketType XSub Source
Receiver XSub Source
Sender XSub Source
type Rep XSub Source

data Req Source

ZMQ_REQ

Constructors

Req

Instances

Eq Req Source
Generic Req Source
SocketType Req Source
SendProbe Req Source
Receiver Req Source
Sender Req Source
type Rep Req Source

data Rep Source

ZMQ_REP

Constructors

Rep

Instances

Eq Rep Source
Generic Rep Source
SocketType Rep Source
Receiver Rep Source
Sender Rep Source
type Rep Rep Source

data Dealer Source

ZMQ_DEALER

Constructors

Dealer

Instances

Eq Dealer Source
Generic Dealer Source
SocketType Dealer Source
SendProbe Dealer Source
Conflatable Dealer Source
Receiver Dealer Source
Sender Dealer Source
type Rep Dealer Source

data Router Source

ZMQ_ROUTER

Constructors

Router

Instances

Eq Router Source
Generic Router Source
SocketType Router Source
SendProbe Router Source
Receiver Router Source
Sender Router Source
type Rep Router Source

data Pull Source

ZMQ_PULL

Constructors

Pull

Instances

Eq Pull Source
Generic Pull Source
SocketType Pull Source
Conflatable Pull Source
Receiver Pull Source
type Rep Pull Source

data Push Source

ZMQ_PUSH

Constructors

Push

Instances

Eq Push Source
Generic Push Source
SocketType Push Source
Conflatable Push Source
Sender Push Source
type Rep Push Source

data Stream Source

ZMQ_STREAM

Constructors

Stream

Instances

Eq Stream Source
Generic Stream Source
SocketType Stream Source
Receiver Stream Source
Sender Stream Source
type Rep Stream Source

General Operations

version :: ZMQ z (Int, Int, Int) Source

runZMQ :: MonadIO m => (forall z. ZMQ z a) -> m a Source

Return the value computed by the given ZMQ monad. Rank-2 polymorphism is used to prevent leaking of z. An invocation of runZMQ will internally create a Context and all actions are executed relative to this context. On finish the context will be disposed, but see async.

async :: ZMQ z a -> ZMQ z (Async a) Source

Run the given ZMQ computation asynchronously, i.e. this function runs the computation in a new thread using async. N.B. reference counting is used to prolong the lifetime of the Context encapsulated in ZMQ as necessary, e.g.:

runZMQ $ do
    s <- socket Pair
    async $ do
        liftIO (threadDelay 10000000)
        identity s >>= liftIO . print

Here, runZMQ will finish before the code section in async, but due to reference counting, the Context will only be disposed after async finishes as well.

socket :: SocketType t => t -> ZMQ z (Socket z t) Source

ZMQ Options (Read)

ioThreads :: ZMQ z Word Source

maxSockets :: ZMQ z Word Source

ZMQ Options (Write)

setIoThreads :: Word -> ZMQ z () Source

setMaxSockets :: Word -> ZMQ z () Source

Socket operations

close :: Socket z t -> ZMQ z () Source

bind :: Socket z t -> String -> ZMQ z () Source

unbind :: Socket z t -> String -> ZMQ z () Source

connect :: Socket z t -> String -> ZMQ z () Source

disconnect :: Socket z t -> String -> ZMQ z () Source

send :: Sender t => Socket z t -> [Flag] -> ByteString -> ZMQ z () Source

send' :: Sender t => Socket z t -> [Flag] -> ByteString -> ZMQ z () Source

sendMulti :: Sender t => Socket z t -> NonEmpty ByteString -> ZMQ z () Source

receive :: Receiver t => Socket z t -> ZMQ z ByteString Source

receiveMulti :: Receiver t => Socket z t -> ZMQ z [ByteString] Source

subscribe :: Subscriber t => Socket z t -> ByteString -> ZMQ z () Source

unsubscribe :: Subscriber t => Socket z t -> ByteString -> ZMQ z () Source

proxy :: Socket z a -> Socket z b -> Maybe (Socket z c) -> ZMQ z () Source

monitor :: [EventType] -> Socket z t -> ZMQ z (Bool -> IO (Maybe EventMsg)) Source

socketMonitor :: [EventType] -> String -> Socket z t -> ZMQ z () Source

poll :: (SocketLike s, MonadIO m) => Timeout -> [Poll s m] -> m [[Event]] Source

Polls for events on the given Poll descriptors. Returns a list of events per descriptor which have occured. (cf. zmq_poll)

Socket Options (Read)

affinity :: Socket z t -> ZMQ z Word64 Source

backlog :: Socket z t -> ZMQ z Int Source

conflate :: Conflatable t => Socket z t -> ZMQ z Bool Source

curvePublicKey :: KeyFormat f -> Socket z t -> ZMQ z ByteString Source

curveSecretKey :: KeyFormat f -> Socket z t -> ZMQ z ByteString Source

curveServerKey :: KeyFormat f -> Socket z t -> ZMQ z ByteString Source

delayAttachOnConnect :: Socket z t -> ZMQ z Bool Source

Deprecated: Use immediate

events :: Socket z t -> ZMQ z [Event] Source

fileDescriptor :: Socket z t -> ZMQ z Fd Source

identity :: Socket z t -> ZMQ z ByteString Source

immediate :: Socket z t -> ZMQ z Bool Source

ipv4Only :: Socket z t -> ZMQ z Bool Source

Deprecated: Use ipv6

ipv6 :: Socket z t -> ZMQ z Bool Source

lastEndpoint :: Socket z t -> ZMQ z String Source

linger :: Socket z t -> ZMQ z Int Source

maxMessageSize :: Socket z t -> ZMQ z Int64 Source

mcastHops :: Socket z t -> ZMQ z Int Source

mechanism :: Socket z t -> ZMQ z SecurityMechanism Source

moreToReceive :: Socket z t -> ZMQ z Bool Source

plainServer :: Socket z t -> ZMQ z Bool Source

plainPassword :: Socket z t -> ZMQ z ByteString Source

plainUserName :: Socket z t -> ZMQ z ByteString Source

rate :: Socket z t -> ZMQ z Int Source

receiveBuffer :: Socket z t -> ZMQ z Int Source

receiveHighWM :: Socket z t -> ZMQ z Int Source

receiveTimeout :: Socket z t -> ZMQ z Int Source

reconnectInterval :: Socket z t -> ZMQ z Int Source

reconnectIntervalMax :: Socket z t -> ZMQ z Int Source

recoveryInterval :: Socket z t -> ZMQ z Int Source

sendBuffer :: Socket z t -> ZMQ z Int Source

sendHighWM :: Socket z t -> ZMQ z Int Source

sendTimeout :: Socket z t -> ZMQ z Int Source

tcpKeepAlive :: Socket z t -> ZMQ z Switch Source

tcpKeepAliveCount :: Socket z t -> ZMQ z Int Source

tcpKeepAliveIdle :: Socket z t -> ZMQ z Int Source

tcpKeepAliveInterval :: Socket z t -> ZMQ z Int Source

zapDomain :: Socket z t -> ZMQ z ByteString Source

Socket Options (Write)

setAffinity :: Word64 -> Socket z t -> ZMQ z () Source

setBacklog :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setConflate :: Conflatable t => Bool -> Socket z t -> ZMQ z () Source

setCurveServer :: Bool -> Socket z t -> ZMQ z () Source

setCurvePublicKey :: KeyFormat f -> Restricted f ByteString -> Socket z t -> ZMQ z () Source

setCurveSecretKey :: KeyFormat f -> Restricted f ByteString -> Socket z t -> ZMQ z () Source

setCurveServerKey :: KeyFormat f -> Restricted f ByteString -> Socket z t -> ZMQ z () Source

setDelayAttachOnConnect :: Bool -> Socket z t -> ZMQ z () Source

Deprecated: Use setImmediate

setIdentity :: Restricted (N1, N254) ByteString -> Socket z t -> ZMQ z () Source

setImmediate :: Bool -> Socket z t -> ZMQ z () Source

setIpv4Only :: Bool -> Socket z t -> ZMQ z () Source

Deprecated: Use setIpv6

setIpv6 :: Bool -> Socket z t -> ZMQ z () Source

setLinger :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z () Source

setMaxMessageSize :: Integral i => Restricted (Nneg1, Int64) i -> Socket z t -> ZMQ z () Source

setMcastHops :: Integral i => Restricted (N1, Int32) i -> Socket z t -> ZMQ z () Source

setPlainServer :: Bool -> Socket z t -> ZMQ z () Source

setPlainPassword :: Restricted (N1, N254) ByteString -> Socket z t -> ZMQ z () Source

setPlainUserName :: Restricted (N1, N254) ByteString -> Socket z t -> ZMQ z () Source

setProbeRouter :: SendProbe t => Bool -> Socket z t -> ZMQ z () Source

setRate :: Integral i => Restricted (N1, Int32) i -> Socket z t -> ZMQ z () Source

setReceiveBuffer :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setReceiveHighWM :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setReceiveTimeout :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z () Source

setReconnectInterval :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setReconnectIntervalMax :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setRecoveryInterval :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setReqCorrelate :: Bool -> Socket z Req -> ZMQ z () Source

setReqRelaxed :: Bool -> Socket z Req -> ZMQ z () Source

setRouterMandatory :: Bool -> Socket z Router -> ZMQ z () Source

setSendBuffer :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setSendHighWM :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z () Source

setSendTimeout :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z () Source

setTcpAcceptFilter :: Maybe ByteString -> Socket z t -> ZMQ z () Source

setTcpKeepAlive :: Switch -> Socket z t -> ZMQ z () Source

setTcpKeepAliveCount :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z () Source

setTcpKeepAliveIdle :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z () Source

setTcpKeepAliveInterval :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z () Source

setXPubVerbose :: Bool -> Socket z XPub -> ZMQ z () Source

Error Handling

data ZMQError Source

ZMQError encapsulates information about errors, which occur when using the native 0MQ API, such as error number and message.

Instances

Eq ZMQError Source
Ord ZMQError Source
Show ZMQError Source
Exception ZMQError Source

errno :: ZMQError -> Int Source

Error number value.

source :: ZMQError -> String Source

Source where this error originates from.

message :: ZMQError -> String Source

Actual error message.

Re-exports

liftIO :: MonadIO m => forall a. IO a -> m a

Lift a computation from the IO monad.

restrict :: Restriction r v => v -> Restricted r v Source

Create a restricted value. If the given value does not satisfy the restrictions, a modified variant is used instead, e.g. if an integer is larger than the upper bound, the upper bound value is used.

toRestricted :: Restriction r v => v -> Maybe (Restricted r v) Source

Create a restricted value. Returns Nothing if the given value does not satisfy all restrictions.

Low-level Functions

waitRead :: Socket z t -> ZMQ z () Source

waitWrite :: Socket z t -> ZMQ z () Source

z85Encode :: MonadIO m => Restricted Div4 ByteString -> m ByteString Source

z85Decode :: MonadIO m => Restricted Div5 ByteString -> m ByteString Source

curveKeyPair :: MonadIO m => m (Restricted Div5 ByteString, Restricted Div5 ByteString) Source

Generate a new curve key pair. (cf. zmq_curve_keypair)