| Copyright | (c) Tamar Christina 2019 |
|---|---|
| License | see libraries/base/LICENSE |
| Maintainer | ghc-devs@haskell.org |
| Stability | internal |
| Portability | non-portable (GHC Extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
GHC.IOPort
Contents
Description
The IOPort type. This is a facility used by the Windows IO subsystem.
The API of this module is unstable and not meant to be consumed by the general public.
If you absolutely must depend on it, make sure to use a tight upper
bound, e.g., base < 4.X rather than base < 5, because the interface can
change rapidly without much warning.
We have strict rules with an I/O Port: * writing more than once is an error * reading more than once is an error
It gives us the ability to have one thread to block, wait for a result from another thread and then being woken up. *Nothing* more.
This type is very much GHC internal. It might be changed or removed without notice in future releases.
Synopsis
- data IOPort a = IOPort (IOPort# RealWorld a)
- newIOPort :: a -> IO (IOPort a)
- newEmptyIOPort :: IO (IOPort a)
- readIOPort :: IOPort a -> IO a
- writeIOPort :: IOPort a -> a -> IO Bool
- doubleReadException :: SomeException
IOPorts
An IOPort is a synchronising variable, used
for communication between concurrent threads, where one of the threads is
controlled by an external state. e.g. by an I/O action that is serviced by the
runtime. It can be thought of as a box, which may be empty or full.
It is mostly similar to the behavior of MVar
except writeIOPort doesn't block if the variable is full and the GC
won't forcibly release the lock if it thinks
there's a deadlock.
The properties of IOPorts are: * Writing to an empty IOPort will not block. * Writing to an full IOPort will not block. It might throw an exception. * Reading from an IOPort for the second time might throw an exception. * Reading from a full IOPort will not block, return the value and empty the port. * Reading from an empty IOPort will block until a write. * Reusing an IOPort (that is, reading or writing twice) is not supported and might throw an exception. Even if reads and writes are interleaved.
This type is very much GHC internal. It might be changed or removed without notice in future releases.
readIOPort :: IOPort a -> IO a Source #
Atomically read the contents of the IOPort. If the IOPort is
currently empty, readIOPort will wait until it is full. After a
readIOPort, the IOPort is left empty.
There is one important property of readIOPort:
- Only a single threads can be blocked on an
IOPort.
writeIOPort :: IOPort a -> a -> IO Bool Source #
Put a value into an IOPort. If the IOPort is currently full,
writeIOPort will throw an exception.
There is one important property of writeIOPort:
- Only a single thread can be blocked on an
IOPort.