-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A basic `reflex` host for backend work
--   
--   A basic <a>reflex</a> host for backend work.
@package reflex-basic-host
@version 0.2


-- | <a>BasicGuest</a> provides instances that most <tt>reflex</tt>
--   programs need:
--   
--   <ul>
--   <li><a>MonadIO</a></li>
--   <li><a>MonadFix</a></li>
--   <li><a>MonadSample</a></li>
--   <li><a>MonadHold</a></li>
--   <li><a>NotReady</a></li>
--   <li><a>PostBuild</a></li>
--   <li><a>PerformEvent</a> — <tt><a>Performable</a> (<a>BasicGuest</a> t
--   m)</tt> has <a>MonadIO</a></li>
--   <li><a>TriggerEvent</a></li>
--   <li><a>Adjustable</a></li>
--   </ul>
--   
--   For some usage examples, see <a>the example directory</a>
module Reflex.Host.Basic
data BasicGuest t (m :: * -> *) a
type BasicGuestConstraints t (m :: * -> *) = (MonadReflexHost t m, MonadHold t m, MonadSample t m, Ref m ~ Ref IO, MonadRef (HostFrame t), Ref (HostFrame t) ~ Ref IO, MonadIO (HostFrame t), PrimMonad (HostFrame t), MonadIO m, MonadFix m)

-- | Run a <a>BasicGuest</a>, and return when the <a>Event</a> returned by
--   the <a>BasicGuest</a> fires.
--   
--   Each call runs on a separate spider timeline, so you can launch
--   multiple hosts via <a>forkIO</a> or <a>forkOS</a> and they will not
--   mutex each other.
--   
--   NOTE: If you want to capture values from a build before the network
--   starts firing (e.g., to hand off event triggers to another thread),
--   populate an <a>MVar</a> (if threading) or <a>IORef</a> as you build
--   the network. If you receive errors about untouchable type variables
--   while doing this, add type annotations to constrain the <a>MVar</a> or
--   <a>IORef</a> contents before passing them to the function that returns
--   your <a>BasicGuest</a>. See the <tt>Multithread.hs</tt> example for a
--   demonstration of this pattern, and where to put the type annotations.
basicHostWithQuit :: (forall t m. BasicGuestConstraints t m => BasicGuest t m (Event t ())) -> IO ()

-- | Run a <a>BasicGuest</a> without a quit <a>Event</a>.
--   
--   <pre>
--   basicHostForever guest = <a>basicHostWithQuit</a> $ never &lt;$ guest
--   </pre>
basicHostForever :: (forall t m. BasicGuestConstraints t m => BasicGuest t m ()) -> IO ()

-- | Augment a <a>BasicGuest</a> with an action that is repeatedly run
--   until the provided <a>Event</a> fires. Each time the action completes,
--   the returned <a>Event</a> will fire.
--   
--   Example - providing a 'tick' <a>Event</a> to a network
--   
--   <pre>
--   myNetwork
--     :: (Reflex t, MonadHold t m, MonadFix m)
--     =&gt; Event t ()
--     -&gt; m (Dynamic t Int)
--   myNetwork = count
--   
--   myGuest :: BasicGuestConstraints t m =&gt; BasicGuest t m (Event t ())
--   myGuest = mdo
--     eTick &lt;- repeatUntilQuit (void $ threadDelay 1000000) eQuit
--     let
--       eCountUpdated = updated dCount
--       eQuit = () &lt;$ ffilter (==5) eCountUpdated
--     dCount &lt;- myNetwork eTick
--   
--     performEvent_ $ liftIO . print &lt;$&gt; eCountUpdated
--     pure eQuit
--   
--   main :: IO ()
--   main = basicHostWithQuit myGuest
--   </pre>
repeatUntilQuit :: BasicGuestConstraints t m => IO a -> Event t () -> BasicGuest t m (Event t a)

-- | Like <a>repeatUntilQuit</a>, but it doesn't do anything with the
--   result of the action. May be a little more efficient if you don't need
--   it.
repeatUntilQuit_ :: BasicGuestConstraints t m => IO a -> Event t () -> BasicGuest t m ()
instance Reflex.Host.Class.ReflexHost t => Control.Monad.Fix.MonadFix (Reflex.Host.Basic.BasicGuest t m)
instance Reflex.Host.Class.ReflexHost t => GHC.Base.Monad (Reflex.Host.Basic.BasicGuest t m)
instance Reflex.Host.Class.ReflexHost t => GHC.Base.Applicative (Reflex.Host.Basic.BasicGuest t m)
instance Reflex.Host.Class.ReflexHost t => GHC.Base.Functor (Reflex.Host.Basic.BasicGuest t m)
instance (Reflex.Host.Class.ReflexHost t, Control.Monad.IO.Class.MonadIO (Reflex.Host.Class.HostFrame t)) => Control.Monad.IO.Class.MonadIO (Reflex.Host.Basic.BasicGuest t m)
instance Reflex.Host.Class.ReflexHost t => Reflex.Class.MonadSample t (Reflex.Host.Basic.BasicGuest t m)
instance (Reflex.Host.Class.ReflexHost t, Reflex.Class.MonadHold t m) => Reflex.Class.MonadHold t (Reflex.Host.Basic.BasicGuest t m)
instance Reflex.Host.Class.ReflexHost t => Reflex.PostBuild.Class.PostBuild t (Reflex.Host.Basic.BasicGuest t m)
instance (Reflex.Host.Class.ReflexHost t, Control.Monad.Ref.MonadRef (Reflex.Host.Class.HostFrame t), Control.Monad.Ref.Ref (Reflex.Host.Class.HostFrame t) Data.Type.Equality.~ Control.Monad.Ref.Ref GHC.Types.IO) => Reflex.TriggerEvent.Class.TriggerEvent t (Reflex.Host.Basic.BasicGuest t m)
instance (Reflex.Host.Class.ReflexHost t, Control.Monad.Ref.Ref m Data.Type.Equality.~ Control.Monad.Ref.Ref GHC.Types.IO, Control.Monad.Ref.MonadRef (Reflex.Host.Class.HostFrame t), Control.Monad.Ref.Ref (Reflex.Host.Class.HostFrame t) Data.Type.Equality.~ Control.Monad.Ref.Ref GHC.Types.IO, Control.Monad.IO.Class.MonadIO (Reflex.Host.Class.HostFrame t), Control.Monad.Primitive.PrimMonad (Reflex.Host.Class.HostFrame t), Control.Monad.IO.Class.MonadIO m) => Reflex.PerformEvent.Class.PerformEvent t (Reflex.Host.Basic.BasicGuest t m)
instance (Reflex.Host.Class.ReflexHost t, Control.Monad.Ref.Ref m Data.Type.Equality.~ Control.Monad.Ref.Ref GHC.Types.IO, Reflex.Class.MonadHold t m, Control.Monad.Primitive.PrimMonad (Reflex.Host.Class.HostFrame t)) => Reflex.Adjustable.Class.Adjustable t (Reflex.Host.Basic.BasicGuest t m)
instance Reflex.Host.Class.ReflexHost t => Reflex.NotReady.Class.NotReady t (Reflex.Host.Basic.BasicGuest t m)