Skip to content

HORIZON HASKELL Docs lts/ghc-9.14.x99ffbb82026-10-19Search packagesCtrl K

Theme: |

GHC 9.14.1 · lts/ghc-9.14.x · 99ffbb8 · 2026-10-19

Modulenetwork-mux-0.11.0.0Haskell2010

Network.Mux.Bearer

Synopsis

data Bearer
type MakeBearerCb
newtype MakeBearer
data BearerTrace
value makeSocketBearer
value makeSocketBearer'
value makePipeChannelBearer
value makeQueueChannelBearer
class MonadReadBuffer

Packagenetwork-mux-0.11.0.0
Exports9
LanguageHaskell2010
LicenceApache-2.0
SourceTypes.hs

datadata Bearer (m :: Type -> Type)

Low level access to underlying socket or pipe. There are three smart constructors:

Network.Socket.socketAsBearer
Network.Pipe.pipeAsBearer
```
Test.Mux.queuesAsBearer
```

Constructors

Bearer
- write :: Tracer m BearerTrace -> TimeoutFn m -> SDU -> m Time
  Timestamp and send SDU.
- writeMany :: Tracer m BearerTrace -> TimeoutFn m -> [SDU] -> m Time
  Timestamp and send many SDUs.
- read :: Tracer m BearerTrace -> TimeoutFn m -> m (SDU, Time)
  Read a SDU
- sduSize :: SDUSize
  Return a suitable SDU payload size.
- batchSize :: Int
  Return a suitable batch size
- name :: String
  Name of the bearer
- egressInterval :: DiffTime
  Egress poll interval

typetype MakeBearerCb (m :: Type -> Type) fd = DiffTime -> fd -> Maybe (ReadBuffer m) -> m (Bearer m)

Callback which constructs a bearer, see MakeBearer.

newtypenewtype MakeBearer (m :: Type -> Type) fd

Construct a bearer using a MakeBearerCb.

Constructors

MakeBearer
- getBearer :: MakeBearerCb m fd

datadata BearerTrace

Low-level bearer trace tags (these are not traced by the tracer which is passed to Mux).

Instances1Show

Show BearerTraceDefined in network-mux-0.11.0.0 · Network.Mux.Types

valuemakeSocketBearer :: MakeBearer IO Socket

Socket Bearer without egress interval.

valuemakeSocketBearer'

:: DiffTime
egress interval
-> MakeBearer IO Socket

valuemakePipeChannelBearer :: MakeBearer IO PipeChannel

valuemakeQueueChannelBearer :: (MonadSTM m, MonadMonotonicTime m, MonadThrow m) => MakeBearer m (QueueChannel m)

classclass MonadReadBuffer (m :: Type -> Type) where

Methods

withReadBufferIO :: (Maybe (ReadBuffer m) -> m a) -> m a

Instances1MonadReadBuffer

MonadReadBuffer IODefined in network-mux-0.11.0.0 · Network.Mux.Bearer