Network.Transport.InMemory.Internal

Internal part of the implementation. This module is for internal use or advanced debuging. There are no guarantees about stability of this module.

Documentation

createTransportExposeInternals :: IO (Transport, TransportInternals)

Create a new Transport exposing internal state.

Useful for testing and/or debugging purposes. Should not be used in production. No guarantee as to the stability of the internals API.

Internal structures

newtype TransportInternals

Constructors

TransportInternals (TVar TransportState)

data TransportState

Constructors

TransportValid !ValidTransportState

TransportClosed

data ValidTransportState

Constructors

ValidTransportState

Fields

• _localEndPoints :: !(Map EndPointAddress LocalEndPoint)
• _nextLocalEndPointId :: !Int

data LocalEndPoint

Constructors

LocalEndPoint

Fields

• localEndPointAddress :: !EndPointAddress
• localEndPointChannel :: !(TChan Event)
• localEndPointState :: !(TVar LocalEndPointState)

data LocalEndPointState

Constructors

LocalEndPointValid !ValidLocalEndPointState

LocalEndPointClosed

data ValidLocalEndPointState

Constructors

ValidLocalEndPointState

Fields

• _nextConnectionId :: !ConnectionId
• _connections :: !(Map (EndPointAddress, ConnectionId) LocalConnection)
• _multigroups :: Map MulticastAddress (TVar (Set EndPointAddress))

data LocalConnection

Constructors

LocalConnection

Fields

• localConnectionId :: !ConnectionId
• localConnectionLocalAddress :: !EndPointAddress
• localConnectionRemoteAddress :: !EndPointAddress
• localConnectionState :: !(TVar LocalConnectionState)

data LocalConnectionState

Constructors

LocalConnectionValid

LocalConnectionClosed

LocalConnectionFailed

Low level functionality

apiNewEndPoint :: TVar TransportState -> IO (Either (TransportError NewEndPointErrorCode) EndPoint)

Create a new end point.

apiCloseEndPoint :: TVar TransportState -> EndPointAddress -> IO ()

apiBreakConnection :: TVar TransportState -> EndPointAddress -> EndPointAddress -> String -> STM ()

Tear down functions that should be called in case if conncetion fails.

apiConnect :: EndPointAddress -> TVar TransportState -> EndPointAddress -> Reliability -> ConnectHints -> IO (Either (TransportError ConnectErrorCode) Connection)

Create a new connection

apiSend :: TChan Event -> TVar TransportState -> LocalConnection -> [ByteString] -> IO (Either (TransportError SendErrorCode) ())

Send a message over a connection

apiClose :: TChan Event -> TVar TransportState -> LocalConnection -> IO ()

Close a connection