Signal.Connection

Documentation

data Connection s v

Multicasts a signal to many subscribers, without triggering any side effects more than once.

multicast :: Scheduler s => Signal s v -> Channel s v -> IO (Connection s v)

Creates a connection that will subscribe to the given base signal, and forward all events onto the given channel.

publish :: Scheduler s => Signal s v -> IO (Connection s v)

Multicasts to a simple channel.

connect :: forall s v. Scheduler s => Connection s v -> SchedulerIO s Disposable

Activates a connection by subscribing to its underlying signal. Calling this function multiple times just returns the existing disposable.

multicastedSignal :: Connection s v -> Signal s v

Returns the multicasted signal of a connection.

No events will be sent on the resulting signal until connect is invoked.

replay :: Scheduler s => Signal s v -> SchedulerIO s (Signal s v)

Multicasts to a replay channel of unlimited capacity, then connects immediately.

replayLast :: Scheduler s => Signal s v -> SchedulerIO s (Signal s v)

Multicasts to a replay channel of capacity 1, then connects immediately.

type Channel s v = (Subscriber s v, Signal s v)

A controllable signal, represented by a Subscriber and Signal pair.

Values sent to the subscriber will automatically be broadcast to all of the signal's subscribers. In effect, the subscriber is the write end, while the signal is the read end.

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)

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.

data Disposable

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

Instances

Eq Disposable