Network.Transport.ZMQ.Internal.Types

Contents

• Internal types
  • ValidTransportState
  • RemoteEndPoint
  • LocalEndPoint
  • ZeroMQ connection
  • ZeroMQ multicast
• ZeroMQ specific types
• Internal data structures

Description

Synopsis

• data ZMQParameters = ZMQParameters {
  • zmqHighWaterMark :: Word64
  • zmqSecurityMechanism :: Maybe SecurityMechanism
  }
• data SecurityMechanism = SecurityPlain {
  • plainPassword :: ByteString
  • plainUsername :: ByteString
  }
• defaultZMQParameters :: ZMQParameters
• data TransportInternals = TransportInternals {
  • transportAddress :: !TransportAddress
  • transportState :: !(MVar TransportState)
  • transportParameters :: !ZMQParameters
  }
• data TransportState
  • = TransportValid !ValidTransportState
  • | TransportClosed
• mkTransportState :: Context -> Maybe (Async ()) -> IO TransportState
• data ValidTransportState
• 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 ())))
• data RemoteEndPoint = RemoteEndPoint {
  • remoteEndPointAddress :: !EndPointAddress
  • remoteEndPointState :: !(MVar RemoteEndPointState)
  • remoteEndPointOpened :: !(IORef Bool)
  }
• data RemoteEndPointState
  • = RemoteEndPointValid ValidRemoteEndPoint
  • | RemoteEndPointClosed
  • | RemoteEndPointFailed
  • | RemoteEndPointPending (IORef [RemoteEndPointState -> IO RemoteEndPointState])
  • | RemoteEndPointClosing ClosingRemoteEndPoint
• data ValidRemoteEndPoint = ValidRemoteEndPoint {
  • remoteEndPointSocket :: !(Socket Push)
  • _remoteEndPointPendingConnections :: !(Counter ConnectionId ZMQConnection)
  • _remoteEndPointIncommingConnections :: !(Set ConnectionId)
  • _remoteEndPointOutgoingCount :: !Int
  }
• data ClosingRemoteEndPoint = ClosingRemoteEndPoint {
  • _remoteEndPointClosingSocket :: !(Socket Push)
  • _remoteEndPointDone :: !(MVar ())
  }
• remoteEndPointPendingConnections :: Accessor ValidRemoteEndPoint (Counter ConnectionId ZMQConnection)
• data LocalEndPoint = LocalEndPoint {
  • localEndPointAddress :: !EndPointAddress
  • localEndPointState :: !(MVar LocalEndPointState)
  • localEndPointPort :: !Int
  }
• data LocalEndPointState
  • = LocalEndPointValid !ValidLocalEndPoint
  • | LocalEndPointClosed
• data ValidLocalEndPoint = ValidLocalEndPoint {
  • localEndPointChan :: !(TMChan Event)
  • _localEndPointConnections :: !(Counter ConnectionId ZMQConnection)
  • _localEndPointRemotes :: !(Map EndPointAddress RemoteEndPoint)
  • localEndPointThread :: !(Async ())
  • localEndPointOpened :: !(IORef Bool)
  • _localEndPointMulticastGroups :: !(Map MulticastAddress ZMQMulticastGroup)
  }
• 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)
• data ZMQConnection = ZMQConnection {
  • connectionLocalEndPoint :: !LocalEndPoint
  • connectionRemoteEndPoint :: !RemoteEndPoint
  • connectionReliability :: !Reliability
  • connectionState :: !(MVar ZMQConnectionState)
  • connectionReady :: !(MVar ())
  }
• data ZMQConnectionState
  • = ZMQConnectionInit
  • | ZMQConnectionValid !ValidZMQConnection
  • | ZMQConnectionClosed
  • | ZMQConnectionFailed
• data ValidZMQConnection = ValidZMQConnection {
  • _connectionSocket :: !(Maybe (Socket Push))
  • _connectionId :: !Word64
  }
• data ZMQMulticastGroup = ZMQMulticastGroup {
  • multicastGroupState :: MVar MulticastGroupState
  • multicastGroupClose :: IO ()
  }
• data MulticastGroupState
  • = MulticastGroupValid ValidMulticastGroup
  • | MulticastGroupClosed
• data ValidMulticastGroup = ValidMulticastGroup {
  • _multicastGroupSubscribed :: IORef Bool
  }
• data Hints = Hints {
  • hintsPort :: Maybe Int
  • hintsControlPort :: Maybe Int
  }
• defaultHints :: Hints
• data Counter a b = Counter {
  • _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))

Documentation

Internal types

ValidTransportState

RemoteEndPoint

LocalEndPoint

ZeroMQ connection

ZeroMQ multicast

ZeroMQ specific types

Internal data structures