| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
LiveCoding.RuntimeIO.Launch
Synopsis
- class Monad m => Launchable m where
- runIO :: LiveProgram m -> LiveProgram IO
- data LaunchedProgram (m :: * -> *) = LaunchedProgram {
- programVar :: MVar (LiveProgram IO)
- threadId :: ThreadId
- launch :: Launchable m => LiveProgram m -> IO (LaunchedProgram m)
- update :: Launchable m => LaunchedProgram m -> LiveProgram m -> IO ()
- stop :: Launchable m => LaunchedProgram m -> IO ()
- launchWithDebugger :: (Monad m, Launchable m) => LiveProgram m -> Debugger m -> IO (LaunchedProgram m)
- background :: MVar (LiveProgram IO) -> IO ()
- stepProgram :: Monad m => LiveProgram m -> m (LiveProgram m)
- stepLaunchedProgram :: (Monad m, Launchable m) => LaunchedProgram m -> IO ()
Documentation
class Monad m => Launchable m where Source #
Monads in which live programs can be launched in IO,
for example when you have special effects that have to be handled on every reload.
The only thing necessary is to transform the LiveProgram
into one in the IO monad, and the rest is taken care of in the framework.
Methods
runIO :: LiveProgram m -> LiveProgram IO Source #
Instances
| Launchable IO Source # | |
Defined in LiveCoding.RuntimeIO.Launch Methods runIO :: LiveProgram IO -> LiveProgram IO Source # | |
| Launchable (StateT (HandlingState IO) IO) Source # | |
Defined in LiveCoding.RuntimeIO.Launch Methods runIO :: LiveProgram (StateT (HandlingState IO) IO) -> LiveProgram IO Source # | |
data LaunchedProgram (m :: * -> *) Source #
Constructors
| LaunchedProgram | |
Fields
| |
launch :: Launchable m => LiveProgram m -> IO (LaunchedProgram m) Source #
Launch a LiveProgram in a separate thread.
The MVar can be used to update the program while automatically migrating it.
The ThreadId represents the thread where the program runs in.
You're advised not to kill it directly, but to run stop instead.
update :: Launchable m => LaunchedProgram m -> LiveProgram m -> IO () Source #
Migrate (using hotCodeSwap) the LiveProgram to a new version.
stop :: Launchable m => LaunchedProgram m -> IO () Source #
Stops a thread where a LiveProgram is being executed.
Before the thread is killed, an empty program (in the monad m) is first inserted and stepped.
This can be used to call cleanup actions encoded in the monad.
launchWithDebugger :: (Monad m, Launchable m) => LiveProgram m -> Debugger m -> IO (LaunchedProgram m) Source #
Launch a LiveProgram, but first attach a debugger to it.
background :: MVar (LiveProgram IO) -> IO () Source #
This is the background task executed by launch.
stepProgram :: Monad m => LiveProgram m -> m (LiveProgram m) Source #
Advance a LiveProgram by a single step.
stepLaunchedProgram :: (Monad m, Launchable m) => LaunchedProgram m -> IO () Source #
Advance a launched LiveProgram by a single step and store the result.