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

Synopsis

• data ZMQ z a
• data Socket z t
• data Flag
  • = DontWait
  • | SendMore
• data Switch
  • = Default
  • | On
  • | Off
• type Timeout = Int64
• data Event
  • = In
  • | Out
  • | Err
• data EventType
  • = ConnectedEvent
  • | ConnectDelayedEvent
  • | ConnectRetriedEvent
  • | ListeningEvent
  • | BindFailedEvent
  • | AcceptedEvent
  • | AcceptFailedEvent
  • | ClosedEvent
  • | CloseFailedEvent
  • | DisconnectedEvent
  • | MonitorStoppedEvent
  • | AllEvents
• data EventMsg
  • = 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
• data Poll s m where
  • Sock :: s t -> [Event] -> Maybe ([Event] -> m ()) -> Poll s m
  • File :: Fd -> [Event] -> Maybe ([Event] -> m ()) -> Poll s m
• data KeyFormat a where
  • BinaryFormat :: KeyFormat Div4
  • TextFormat :: KeyFormat Div5
• data SecurityMechanism
  • = Null
  • | Plain
  • | Curve
• class SocketType a
• class Sender a
• class Receiver a
• class Subscriber a
• class SocketLike s
• class Conflatable a
• class SendProbe a
• data Pair = Pair
• data Pub = Pub
• data Sub = Sub
• data XPub = XPub
• data XSub = XSub
• data Req = Req
• data Rep = Rep
• data Dealer = Dealer
• data Router = Router
• data Pull = Pull
• data Push = Push
• data Stream = Stream
• version :: ZMQ z (Int, Int, Int)
• runZMQ :: MonadIO m => (forall z. ZMQ z a) -> m a
• async :: ZMQ z a -> ZMQ z (Async a)
• socket :: SocketType t => t -> ZMQ z (Socket z t)
• ioThreads :: ZMQ z Word
• maxSockets :: ZMQ z Word
• setIoThreads :: Word -> ZMQ z ()
• setMaxSockets :: Word -> ZMQ z ()
• close :: Socket z t -> ZMQ z ()
• bind :: Socket z t -> String -> ZMQ z ()
• unbind :: Socket z t -> String -> ZMQ z ()
• connect :: Socket z t -> String -> ZMQ z ()
• disconnect :: Socket z t -> String -> ZMQ z ()
• send :: Sender t => Socket z t -> [Flag] -> ByteString -> ZMQ z ()
• send' :: Sender t => Socket z t -> [Flag] -> ByteString -> ZMQ z ()
• sendMulti :: Sender t => Socket z t -> NonEmpty ByteString -> ZMQ z ()
• receive :: Receiver t => Socket z t -> ZMQ z ByteString
• receiveMulti :: Receiver t => Socket z t -> ZMQ z [ByteString]
• subscribe :: Subscriber t => Socket z t -> ByteString -> ZMQ z ()
• unsubscribe :: Subscriber t => Socket z t -> ByteString -> ZMQ z ()
• proxy :: Socket z a -> Socket z b -> Maybe (Socket z c) -> ZMQ z ()
• monitor :: [EventType] -> Socket z t -> ZMQ z (Bool -> IO (Maybe EventMsg))
• socketMonitor :: [EventType] -> String -> Socket z t -> ZMQ z ()
• poll :: (SocketLike s, MonadIO m) => Timeout -> [Poll s m] -> m [[Event]]
• affinity :: Socket z t -> ZMQ z Word64
• backlog :: Socket z t -> ZMQ z Int
• conflate :: Conflatable t => Socket z t -> ZMQ z Bool
• curvePublicKey :: KeyFormat f -> Socket z t -> ZMQ z ByteString
• curveSecretKey :: KeyFormat f -> Socket z t -> ZMQ z ByteString
• curveServerKey :: KeyFormat f -> Socket z t -> ZMQ z ByteString
• delayAttachOnConnect :: Socket z t -> ZMQ z Bool
• events :: Socket z t -> ZMQ z [Event]
• fileDescriptor :: Socket z t -> ZMQ z Fd
• identity :: Socket z t -> ZMQ z ByteString
• immediate :: Socket z t -> ZMQ z Bool
• ipv4Only :: Socket z t -> ZMQ z Bool
• ipv6 :: Socket z t -> ZMQ z Bool
• lastEndpoint :: Socket z t -> ZMQ z String
• linger :: Socket z t -> ZMQ z Int
• maxMessageSize :: Socket z t -> ZMQ z Int64
• mcastHops :: Socket z t -> ZMQ z Int
• mechanism :: Socket z t -> ZMQ z SecurityMechanism
• moreToReceive :: Socket z t -> ZMQ z Bool
• plainServer :: Socket z t -> ZMQ z Bool
• plainPassword :: Socket z t -> ZMQ z ByteString
• plainUserName :: Socket z t -> ZMQ z ByteString
• rate :: Socket z t -> ZMQ z Int
• receiveBuffer :: Socket z t -> ZMQ z Int
• receiveHighWM :: Socket z t -> ZMQ z Int
• receiveTimeout :: Socket z t -> ZMQ z Int
• reconnectInterval :: Socket z t -> ZMQ z Int
• reconnectIntervalMax :: Socket z t -> ZMQ z Int
• recoveryInterval :: Socket z t -> ZMQ z Int
• sendBuffer :: Socket z t -> ZMQ z Int
• sendHighWM :: Socket z t -> ZMQ z Int
• sendTimeout :: Socket z t -> ZMQ z Int
• tcpKeepAlive :: Socket z t -> ZMQ z Switch
• tcpKeepAliveCount :: Socket z t -> ZMQ z Int
• tcpKeepAliveIdle :: Socket z t -> ZMQ z Int
• tcpKeepAliveInterval :: Socket z t -> ZMQ z Int
• zapDomain :: Socket z t -> ZMQ z ByteString
• setAffinity :: Word64 -> Socket z t -> ZMQ z ()
• setBacklog :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setConflate :: Conflatable t => Bool -> Socket z t -> ZMQ z ()
• setCurveServer :: Bool -> Socket z t -> ZMQ z ()
• setCurvePublicKey :: KeyFormat f -> Restricted f ByteString -> Socket z t -> ZMQ z ()
• setCurveSecretKey :: KeyFormat f -> Restricted f ByteString -> Socket z t -> ZMQ z ()
• setCurveServerKey :: KeyFormat f -> Restricted f ByteString -> Socket z t -> ZMQ z ()
• setDelayAttachOnConnect :: Bool -> Socket z t -> ZMQ z ()
• setIdentity :: Restricted (N1, N254) ByteString -> Socket z t -> ZMQ z ()
• setImmediate :: Bool -> Socket z t -> ZMQ z ()
• setIpv4Only :: Bool -> Socket z t -> ZMQ z ()
• setIpv6 :: Bool -> Socket z t -> ZMQ z ()
• setLinger :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z ()
• setMaxMessageSize :: Integral i => Restricted (Nneg1, Int64) i -> Socket z t -> ZMQ z ()
• setMcastHops :: Integral i => Restricted (N1, Int32) i -> Socket z t -> ZMQ z ()
• setPlainServer :: Bool -> Socket z t -> ZMQ z ()
• setPlainPassword :: Restricted (N1, N254) ByteString -> Socket z t -> ZMQ z ()
• setPlainUserName :: Restricted (N1, N254) ByteString -> Socket z t -> ZMQ z ()
• setProbeRouter :: SendProbe t => Bool -> Socket z t -> ZMQ z ()
• setRate :: Integral i => Restricted (N1, Int32) i -> Socket z t -> ZMQ z ()
• setReceiveBuffer :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setReceiveHighWM :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setReceiveTimeout :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z ()
• setReconnectInterval :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setReconnectIntervalMax :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setRecoveryInterval :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setReqCorrelate :: Bool -> Socket z Req -> ZMQ z ()
• setReqRelaxed :: Bool -> Socket z Req -> ZMQ z ()
• setRouterMandatory :: Bool -> Socket z Router -> ZMQ z ()
• setSendBuffer :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setSendHighWM :: Integral i => Restricted (N0, Int32) i -> Socket z t -> ZMQ z ()
• setSendTimeout :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z ()
• setTcpAcceptFilter :: Maybe ByteString -> Socket z t -> ZMQ z ()
• setTcpKeepAlive :: Switch -> Socket z t -> ZMQ z ()
• setTcpKeepAliveCount :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z ()
• setTcpKeepAliveIdle :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z ()
• setTcpKeepAliveInterval :: Integral i => Restricted (Nneg1, Int32) i -> Socket z t -> ZMQ z ()
• setXPubVerbose :: Bool -> Socket z XPub -> ZMQ z ()
• data ZMQError
• errno :: ZMQError -> Int
• source :: ZMQError -> String
• message :: ZMQError -> String
• liftIO :: MonadIO m => forall a. IO a -> m a
• restrict :: Restriction r v => v -> Restricted r v
• toRestricted :: Restriction r v => v -> Maybe (Restricted r v)
• waitRead :: Socket z t -> ZMQ z ()
• waitWrite :: Socket z t -> ZMQ z ()
• z85Encode :: MonadIO m => Restricted Div4 ByteString -> m ByteString
• z85Decode :: MonadIO m => Restricted Div5 ByteString -> m ByteString
• curveKeyPair :: MonadIO m => m (Restricted Div5 ByteString, Restricted Div5 ByteString)

Type Definitions

ZMQ_POLLERR

Socket type-classes

Socket Types

General Operations

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

ZMQ Options (Read)

ZMQ Options (Write)

Socket operations

Socket Options (Read)

Socket Options (Write)

Error Handling

Re-exports

Low-level Functions