Signal

Documentation

data Signal s v

A signal which will send values of type v on a scheduler of type s.

Instances

Scheduler s => Monad (Signal s)

Scheduler s => Functor (Signal s)

Scheduler s => MonadPlus (Signal s)

Scheduler s => Applicative (Signal s)

Scheduler s => MonadZip (Signal s)

Scheduler s => Monoid (Signal s v)

signal

Arguments

:: Scheduler s

=> (Subscriber s v -> SchedulerIO s Disposable)

An action to run on each subscription.

-> Signal s v

The constructed signal.

Constructs a signal which sends its values to new subscribers synchronously.

subscribe

Arguments

:: Scheduler s

=> Signal s v

The signal to subscribe to.

-> Subscriber s v

The subscriber to attach.

-> SchedulerIO s Disposable

A disposable which can be used to terminate the subscription.

Subscribes to a signal.

(>>:)

Arguments

:: Scheduler s

=> Signal s v

The signal to subscribe to.

-> (Event v -> SchedulerIO s ())

An action to run when each event is received.

-> SchedulerIO s Disposable

A disposable which can be used to terminate the subscription.

Creates a subscriber and subscribes to the signal.

never :: Scheduler s => Signal s v

Returns a signal which never sends any events.

empty :: Scheduler s => Signal s v

Returns a signal which immediately completes.

data Event v

Represents an event that a signal might send.

Signals may send any number of NextEvents, followed by one ErrorEvent or CompletedEvent.

Constructors

NextEvent v

A value v in the monad.

ErrorEvent IOException

Sent when an error or exception occurs in the signal. Outside of the monad.

CompletedEvent

Sent when the signal completes successfully. Outside of the monad.

Instances

Eq v => Eq (Event v)

Show v => Show (Event v)

data Disposable

Allows disposal of a resource by running an action in the monad m.

Instances

Eq Disposable

class Scheduler s

Represents a queue of IO actions which can be executed in FIFO order.

Instances

Scheduler BackgroundScheduler

Scheduler MainScheduler

data SchedulerIO s a

An IO computation that must be performed in a scheduler of type s.

Instances

Scheduler s => Monad (SchedulerIO s)

Functor (SchedulerIO s)

Scheduler s => Applicative (SchedulerIO s)

Scheduler s => MonadIO (SchedulerIO s)

Show v => Show (SchedulerIO BackgroundScheduler v)

Show v => Show (SchedulerIO MainScheduler v)

Unsafely executes a SchedulerIO action and shows the result. This is for DEBUGGING PURPOSES ONLY.