Concurrent.Channel.Stream

streamChannel :: Duplex -> Effect (Channel Buffer Buffer)

Creates a new Channel with a provided duplex Stream as backend. Closing the Channel will destroy the Stream.

streamInput :: forall a. Readable a -> Effect (Input Buffer)

Creates a new Input with a provided readable Stream as backend.

streamOutput :: forall a. Writable a -> Effect (Output Buffer)

Creates a new Output with a provided writable Stream as backend.

newtype Output a

An Output is a wrapper around a function that sends values to a Channel.

Constructors

• Output (a -> Aff Boolean)

Instances

• Newtype (Output a) _
• Contravariant Output
• Divide Output
• Divisible Output
• Decide Output
• Semigroup (Output a)

  Will try to send to the first Output and if it is closed, then to the second.

• Monoid (Output a)

newtype Input a

An Input is a wrapper around a function that receive values from a Channel.

Constructors

• Input (Aff (Maybe a))

Instances

• Newtype (Input a) _
• Functor Input
• Apply Input
• Applicative Input
• Bind Input
• Monad Input
• Alt Input

  Will try to receive from the first Input and if it is closed, then from the second.

• Plus Input
• Alternative Input
• MonadPlus Input
• Semigroup (Input a)

  Same as Alt

• Monoid (Input a)
• MonadEffect Input
• MonadAff Input

type Channel o i = { close :: Aff Unit, input :: Input i, output :: Output o }

A Channel is an abstraction over a var, queue or stream backend and can be used as a communication channel between async threads.

send :: forall a. Output a -> a -> Aff Boolean

Sends a value to an Output. Will return false if the Output is closed and true if not.

recv :: forall a. Input a -> Aff (Maybe a)

Receives a value from an Input. If the Input is closed, the result will be Nothing.