Safe Haskell	Safe-Inferred
Language	Haskell2010

IHaskell.IPython.ZeroMQ

Description

The ZeroMQ module abstracts away the low-level 0MQ based interface with IPython, replacing it instead with a Haskell Channel based interface. The serveProfile function takes a IPython profile specification and returns the channel interface to use.

Synopsis

data ZeroMQInterface = Channels {
- shellRequestChannel :: Chan Message
- shellReplyChannel :: Chan Message
- controlRequestChannel :: Chan Message
- controlReplyChannel :: Chan Message
- iopubChannel :: Chan Message
- hmacKey :: ByteString
}
data ZeroMQStdin = StdinChannel {
- stdinRequestChannel :: Chan Message
- stdinReplyChannel :: Chan Message
}
serveProfile :: Profile -> Bool -> IO ZeroMQInterface
serveStdin :: Profile -> IO ZeroMQStdin
data ZeroMQEphemeralPorts
withEphemeralPorts :: ByteString -> Bool -> (ZeroMQEphemeralPorts -> ZeroMQInterface -> IO a) -> IO a

Documentation

data ZeroMQInterface Source #

The channel interface to the ZeroMQ sockets. All communication is done via Messages, which are encoded and decoded into a lower level form before being transmitted to IPython. These channels should functionally serve as high-level sockets which speak Messages instead of ByteStrings.

Constructors

Channels

Fields

shellRequestChannel :: Chan Message
A channel populated with requests from the frontend.
shellReplyChannel :: Chan Message
Writing to this channel causes a reply to be sent to the frontend.
controlRequestChannel :: Chan Message
This channel is a duplicate of the shell request channel, though using a different backend socket.
controlReplyChannel :: Chan Message
This channel is a duplicate of the shell reply channel, though using a different backend socket.
iopubChannel :: Chan Message
Writing to this channel sends an iopub message to the frontend.
hmacKey :: ByteString
Key used to sign messages.

data ZeroMQStdin Source #

Constructors

StdinChannel
Fields stdinRequestChannel :: Chan Message stdinReplyChannel :: Chan Message

serveProfile Source #

Arguments

:: Profile	The profile specifying which ports and transport mechanisms to use.
-> Bool	Print debug output
-> IO ZeroMQInterface	The Message-channel based interface to the sockets.

Start responding on all ZeroMQ channels used to communicate with IPython | via the provided profile. Return a set of channels which can be used to | communicate with IPython in a more structured manner.

serveStdin :: Profile -> IO ZeroMQStdin Source #

data ZeroMQEphemeralPorts Source #

Describes ports used when creating an ephemeral ZeroMQ session. Used to generate the ipython JSON config file.

Instances

Instances details

ToJSON ZeroMQEphemeralPorts Source #
Instance details Defined in IHaskell.IPython.ZeroMQ Methods toJSON :: ZeroMQEphemeralPorts -> Value # toEncoding :: ZeroMQEphemeralPorts -> Encoding # toJSONList :: [ZeroMQEphemeralPorts] -> Value # toEncodingList :: [ZeroMQEphemeralPorts] -> Encoding #

withEphemeralPorts Source #

Arguments

:: ByteString	HMAC encryption key
-> Bool	Print debug output
-> (ZeroMQEphemeralPorts -> ZeroMQInterface -> IO a)	Callback that takes the interface to the sockets.
-> IO a

Run session for communicating with an IPython instance on ephemerally allocated ZMQ4 sockets. The sockets will be closed when the callback returns.