Safe Haskell	Safe-Inferred
Language	GHC2021

Navi.Event

Contents

Event type
Results
Caching previous events/errors

Description

This module provides functionality for handling events.

Synopsis

data Event result = MkEvent {
- name :: !Text
- serviceType :: !(ServiceType result)
- pollInterval :: !PollInterval
- raiseAlert :: result -> Maybe NaviNote
- repeatEvent :: !(RepeatEvent result)
- errorNote :: !ErrorNote
}
data AnyEvent where
- MkAnyEvent :: (Eq result, Show result) => Event result -> AnyEvent
runEvent :: (HasCallStack, MonadLoggerNamespace m, MonadSTM m, MonadSystemInfo m, Show result) => Event result -> m (EventSuccess result)
data EventSuccess result = MkEventSuccess {
- result :: result
- repeatEvent :: RepeatEvent result
- raiseAlert :: result -> Maybe NaviNote
}
data EventError = MkEventError {
- name :: !Text
- short :: !Text
- long :: !Text
}
data RepeatEvent a
- = NoRepeats !(IORef (Maybe a))
- | AllowRepeats
data ErrorNote
- = NoErrNote
- | AllowErrNote !(RepeatEvent ())
blockRepeat :: (Eq a, MonadLoggerNamespace m, MonadIORef m, Show a) => RepeatEvent a -> a -> m Bool
blockErr :: (MonadLoggerNamespace m, MonadIORef m) => ErrorNote -> m Bool
updatePrevTrigger :: (Eq a, MonadIORef m) => RepeatEvent a -> a -> m ()

Event type

data Event result Source #

Event represents sending notifications. An event will:

Query for information (i.e. run a shell command).
Parse the result.
Raise an alert if the result matches some condition.

Constructors

MkEvent

Fields

name :: !Text
The name of this event.
serviceType :: !(ServiceType result)
The service to run.
pollInterval :: !PollInterval
How often to poll for this event, in seconds.
raiseAlert :: result -> Maybe NaviNote
Conditionally raises an alert based on the result.
repeatEvent :: !(RepeatEvent result)
Determines how we handle repeat alerts.
errorNote :: !ErrorNote
Determines how we handle errors.

Instances

Instances details

(k ~ A_Lens, a ~ ErrorNote, b ~ ErrorNote) => LabelOptic "errorNote" k (Event result) (Event result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (Event result) (Event result) a b Source #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k (Event result) (Event result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (Event result) (Event result) a b Source #
(k ~ A_Lens, a ~ PollInterval, b ~ PollInterval) => LabelOptic "pollInterval" k (Event result) (Event result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (Event result) (Event result) a b Source #
(k ~ A_Lens, a ~ (result -> Maybe NaviNote), b ~ (result -> Maybe NaviNote)) => LabelOptic "raiseAlert" k (Event result) (Event result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (Event result) (Event result) a b Source #
(k ~ A_Lens, a ~ RepeatEvent result, b ~ RepeatEvent result) => LabelOptic "repeatEvent" k (Event result) (Event result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (Event result) (Event result) a b Source #
(k ~ A_Lens, a ~ ServiceType result, b ~ ServiceType result) => LabelOptic "serviceType" k (Event result) (Event result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (Event result) (Event result) a b Source #
Show (Event result) Source #
Instance details Defined in Navi.Event.Types Methods showsPrec :: Int -> Event result -> ShowS Source # show :: Event result -> String Source # showList :: [Event result] -> ShowS Source #

data AnyEvent where Source #

Existentially quantifies result type on an Event. Used so that we can store different events in the same list.

Constructors

MkAnyEvent :: (Eq result, Show result) => Event result -> AnyEvent

Instances

Instances details

Show AnyEvent Source #
Instance details Defined in Navi.Event.Types Methods showsPrec :: Int -> AnyEvent -> ShowS Source # show :: AnyEvent -> String Source # showList :: [AnyEvent] -> ShowS Source #

runEvent :: (HasCallStack, MonadLoggerNamespace m, MonadSTM m, MonadSystemInfo m, Show result) => Event result -> m (EventSuccess result) Source #

Runs an event, i.e.,

Queries the system via MonadSystemInfo.
Returns the parsed result.

Results

data EventSuccess result Source #

Holds the Event data used after an event is successfully run.

Since: 0.1

Constructors

MkEventSuccess
Fields result :: result repeatEvent :: RepeatEvent result raiseAlert :: result -> Maybe NaviNote

Instances

Instances details

(k ~ A_Lens, a ~ (result -> Maybe NaviNote), b ~ (result -> Maybe NaviNote)) => LabelOptic "raiseAlert" k (EventSuccess result) (EventSuccess result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (EventSuccess result) (EventSuccess result) a b Source #
(k ~ A_Lens, a ~ RepeatEvent result, b ~ RepeatEvent result) => LabelOptic "repeatEvent" k (EventSuccess result) (EventSuccess result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (EventSuccess result) (EventSuccess result) a b Source #
(k ~ A_Lens, a ~ result, b ~ result) => LabelOptic "result" k (EventSuccess result) (EventSuccess result) a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx (EventSuccess result) (EventSuccess result) a b Source #

data EventError Source #

Represents an error when querying an Event.

Constructors

MkEventError
Fields name :: !Text The name of the event. short :: !Text Short description of the error. long :: !Text Long description of the error.

Instances

Instances details

Exception EventError Source #
Instance details Defined in Navi.Event.Types Methods toException :: EventError -> SomeException Source # fromException :: SomeException -> Maybe EventError Source # displayException :: EventError -> String Source #
Show EventError Source #
Instance details Defined in Navi.Event.Types Methods showsPrec :: Int -> EventError -> ShowS Source # show :: EventError -> String Source # showList :: [EventError] -> ShowS Source #
Eq EventError Source #
Instance details Defined in Navi.Event.Types Methods (==) :: EventError -> EventError -> Bool Source # (/=) :: EventError -> EventError -> Bool Source #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "long" k EventError EventError a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx EventError EventError a b Source #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "name" k EventError EventError a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx EventError EventError a b Source #
(k ~ A_Lens, a ~ Text, b ~ Text) => LabelOptic "short" k EventError EventError a b Source #
Instance details Defined in Navi.Event.Types Methods labelOptic :: Optic k NoIx EventError EventError a b Source #

Caching previous events/errors

data RepeatEvent a Source #

Determines if we are allowed to send off duplicate notifications simultaneously. If we are not, then NoRepeats holds the last trigger so that we can detect duplicates.

Constructors

NoRepeats !(IORef (Maybe a))
AllowRepeats

Instances

Instances details

Show (RepeatEvent a) Source #
Instance details Defined in Navi.Event.Types Methods showsPrec :: Int -> RepeatEvent a -> ShowS Source # show :: RepeatEvent a -> String Source # showList :: [RepeatEvent a] -> ShowS Source #

data ErrorNote Source #

Determines if we should send notifications for errors and, if so, if we allow repeats.

Constructors

NoErrNote
AllowErrNote !(RepeatEvent ())

Instances

Instances details

Show ErrorNote Source #
Instance details Defined in Navi.Event.Types Methods showsPrec :: Int -> ErrorNote -> ShowS Source # show :: ErrorNote -> String Source # showList :: [ErrorNote] -> ShowS Source #

blockRepeat :: (Eq a, MonadLoggerNamespace m, MonadIORef m, Show a) => RepeatEvent a -> a -> m Bool Source #

Determines if we should block the event. The semantics are:

AllowRepeats: never block (returns False).
NoRepeats: block only if the parameter a equals the previous a stored in our ref.

blockErr :: (MonadLoggerNamespace m, MonadIORef m) => ErrorNote -> m Bool Source #

Determines if we should block the error event. The semantics are:

NoErrNote: always block (returns True).
AllowErrNote AllowRepeats: never block (returns False).
AllowErrNote NoRepeats: block only if we have sent a notifcation for this error before.

updatePrevTrigger :: (Eq a, MonadIORef m) => RepeatEvent a -> a -> m () Source #

If the reference is NoRepeats then we overwrite the previous reference with the new parameter. Otherwise we do nothing.