Admin.Component.Health

Documentation

type HealthAPI = "status" :> Get '[JSON] ApplicationState

type HealthComponent = Component "health" HealthAPI

health :: Show a => Async a -> HealthComponent

serveHealth :: (MonadIO m, Show a) => Async a -> m ApplicationState

async :: IO a -> IO (Async a)

Spawn an asynchronous action in a separate thread.

Like for forkIO, the action may be left running unintentinally (see module-level documentation for details).

Use withAsync style functions wherever you can instead!

data Async a

An asynchronous action spawned by async or withAsync. Asynchronous actions are executed in a separate thread, and operations are provided for waiting for asynchronous actions to complete and obtaining their results (see e.g. wait).

Instances

Functor Async

Defined in Control.Concurrent.Async

Methods

fmap :: (a -> b) -> Async a -> Async b

(<$) :: a -> Async b -> Async a

Eq (Async a)

Defined in Control.Concurrent.Async

Methods

(==) :: Async a -> Async a -> Bool

(/=) :: Async a -> Async a -> Bool

Ord (Async a)

Defined in Control.Concurrent.Async

Methods

compare :: Async a -> Async a -> Ordering

(<) :: Async a -> Async a -> Bool

(<=) :: Async a -> Async a -> Bool

(>) :: Async a -> Async a -> Bool

(>=) :: Async a -> Async a -> Bool

max :: Async a -> Async a -> Async a

min :: Async a -> Async a -> Async a

Hashable (Async a)

Defined in Control.Concurrent.Async

Methods

hashWithSalt :: Int -> Async a -> Int

hash :: Async a -> Int