Network.Transport.ZMQ.Internal.Types

Documentation

data ZMQParameters

Parameters for ZeroMQ connection.

Constructors

ZMQParameters

Fields

zmqHighWaterMark :: Word64

zmqSecurityMechanism :: Maybe SecurityMechanism

data SecurityMechanism

A ZeroMQ "security mechanism".

Constructors

SecurityPlain

Clear-text authentication, using a (username, password) pair.

Fields

plainPassword :: ByteString

plainUsername :: ByteString

defaultZMQParameters :: ZMQParameters

Internal types

data TransportInternals

Transport data type.

Constructors

TransportInternals

Fields

transportAddress :: !TransportAddress

Transport address (used as identifier).

transportState :: !(MVar TransportState)

Internal state.

transportParameters :: !ZMQParameters

Parameters that were used to create the transport.

data TransportState

Transport state.

Constructors

TransportValid !ValidTransportState

Transport is in active state.

TransportClosed

Transport is closed.

mkTransportState :: Context -> Maybe (Async ()) -> IO TransportState

ValidTransportState

data ValidTransportState

Transport state.

transportContext :: Accessor ValidTransportState Context

transportEndPoints :: Accessor ValidTransportState (Map EndPointAddress LocalEndPoint)

transportEndPointAt :: EndPointAddress -> Accessor ValidTransportState (Maybe LocalEndPoint)

transportAuth :: Accessor ValidTransportState (Maybe (Async ()))

transportSockets :: Accessor ValidTransportState (IORef (IntMap (IO ())))

RemoteEndPoint

data RemoteEndPoint

Constructors

RemoteEndPoint

Fields

remoteEndPointAddress :: !EndPointAddress

remoteEndPointState :: !(MVar RemoteEndPointState)

remoteEndPointOpened :: !(IORef Bool)

data RemoteEndPointState

Constructors

RemoteEndPointValid ValidRemoteEndPoint

RemoteEndPointClosed

RemoteEndPointFailed

RemoteEndPointPending (IORef [RemoteEndPointState -> IO RemoteEndPointState])

RemoteEndPointClosing ClosingRemoteEndPoint

data ValidRemoteEndPoint

Constructors

ValidRemoteEndPoint

Fields

remoteEndPointSocket :: !(Socket Push)

_remoteEndPointPendingConnections :: !(Counter ConnectionId ZMQConnection)

_remoteEndPointIncommingConnections :: !(Set ConnectionId)

_remoteEndPointOutgoingCount :: !Int

data ClosingRemoteEndPoint

Constructors

ClosingRemoteEndPoint

Fields

_remoteEndPointClosingSocket :: !(Socket Push)

_remoteEndPointDone :: !(MVar ())

remoteEndPointPendingConnections :: Accessor ValidRemoteEndPoint (Counter ConnectionId ZMQConnection)

LocalEndPoint

data LocalEndPoint

Constructors

LocalEndPoint

Fields

localEndPointAddress :: !EndPointAddress

localEndPointState :: !(MVar LocalEndPointState)

localEndPointPort :: !Int

data LocalEndPointState

Constructors

LocalEndPointValid !ValidLocalEndPoint

LocalEndPointClosed

data ValidLocalEndPoint

Constructors

ValidLocalEndPoint

Fields

localEndPointChan :: !(TMChan Event)

channel for n-t - user communication

_localEndPointConnections :: !(Counter ConnectionId ZMQConnection)

list of incomming connections

_localEndPointRemotes :: !(Map EndPointAddress RemoteEndPoint)

list of remote end points

localEndPointThread :: !(Async ())

thread id

localEndPointOpened :: !(IORef Bool)

is remote endpoint opened

_localEndPointMulticastGroups :: !(Map MulticastAddress ZMQMulticastGroup)

list of multicast nodes

localEndPointConnections :: Accessor ValidLocalEndPoint (Counter ConnectionId ZMQConnection)

localEndPointConnectionAt :: ConnectionId -> Accessor ValidLocalEndPoint (Maybe ZMQConnection)

localEndPointRemotes :: Accessor ValidLocalEndPoint (Map EndPointAddress RemoteEndPoint)

localEndPointRemoteAt :: EndPointAddress -> Accessor ValidLocalEndPoint (Maybe RemoteEndPoint)

localEndPointMulticastGroups :: Accessor ValidLocalEndPoint (Map MulticastAddress ZMQMulticastGroup)

ZeroMQ connection

data ZMQConnection

Constructors

ZMQConnection

Fields

connectionLocalEndPoint :: !LocalEndPoint

connectionRemoteEndPoint :: !RemoteEndPoint

connectionReliability :: !Reliability

connectionState :: !(MVar ZMQConnectionState)

connectionReady :: !(MVar ())

data ZMQConnectionState

Constructors

ZMQConnectionInit

ZMQConnectionValid !ValidZMQConnection

ZMQConnectionClosed

ZMQConnectionFailed

data ValidZMQConnection

Constructors

ValidZMQConnection

Fields

_connectionSocket :: !(Maybe (Socket Push))

_connectionId :: !Word64

ZeroMQ multicast

data ZMQMulticastGroup

Constructors

ZMQMulticastGroup

Fields

multicastGroupState :: MVar MulticastGroupState

multicastGroupClose :: IO ()

data MulticastGroupState

Constructors

MulticastGroupValid ValidMulticastGroup

MulticastGroupClosed

data ValidMulticastGroup

Constructors

ValidMulticastGroup

Fields

_multicastGroupSubscribed :: IORef Bool

ZeroMQ specific types

data Hints

A list of Hints provided for connection

Constructors

Hints

Fields

hintsPort :: Maybe Int

The port to bind.

hintsControlPort :: Maybe Int

The port that is used to receive multicast messages.

defaultHints :: Hints

Internal data structures

data Counter a b

Constructors

Counter

Fields

_counterNext :: !a

_counterValue :: !(Map a b)

counterNextId :: Accessor (Counter a b) a

counterValues :: Accessor (Counter a b) (Map a b)

counterValueAt :: Ord a => a -> Accessor (Counter a b) (Maybe b)

nextElement :: (Enum a, Ord a) => (b -> IO Bool) -> b -> Counter a b -> IO (Counter a b, (a, b))

nextElement' :: (Enum a, Ord a) => (b -> IO Bool) -> (a -> b) -> Counter a b -> IO (Counter a b, (a, b))

nextElementM :: (Enum a, Ord a) => (b -> IO Bool) -> (a -> IO b) -> Counter a b -> IO (Counter a b, (a, b))

nextElementM' :: (Enum a, Ord a) => (b -> IO Bool) -> (a -> IO (b, c)) -> Counter a b -> IO (Counter a b, (a, c))