Packages

p

fs2

concurrent

package concurrent

Provides several concurrency primitives. *

Source
concurrent.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. concurrent
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Dequeue[F[_], A] extends AnyRef

    Provides the ability to dequeue chunks of elements from a Queue as streams.

  2. trait Dequeue1[F[_], A] extends AnyRef

    Provides the ability to dequeue individual elements from a Queue.

  3. trait DequeueChunk1[F[_], G[_], A] extends AnyRef

    Provides the ability to dequeue individual chunks from a Queue.

  4. trait Enqueue[F[_], A] extends AnyRef

    Provides the ability to enqueue elements to a Queue.

  5. trait NoneTerminatedQueue[F[_], A] extends Enqueue[F, Option[A]] with Dequeue1[F, Option[A]] with DequeueChunk1[F, Option, A] with Dequeue[F, A]

    Like Queue, but allows allows signalling of no further enqueues by enqueueing None.

    Like Queue, but allows allows signalling of no further enqueues by enqueueing None. Optimizes dequeue to minimum possible boxing.

  6. trait Signal[F[_], A] extends AnyRef

    Pure holder of a single value of type A that can be read in the effect F.

  7. abstract class SignallingRef[F[_], A] extends Ref[F, A] with Signal[F, A]

    Pure holder of a single value of type A that can be both read and updated in the effect F.

    Pure holder of a single value of type A that can be both read and updated in the effect F.

    The update methods have the same semantics as Ref, as well as propagating changes to discrete (with a last-update-wins policy in case of very fast updates).

    The access method differs slightly from Ref in that the update function, in the presence of discrete, can return false and need looping even without any other writers.

  8. abstract class Topic[F[_], A] extends AnyRef

    Asynchronous Topic.

    Asynchronous Topic.

    Topic allows you to distribute A published by arbitrary number of publishers to arbitrary number of subscribers.

    Topic has built-in back-pressure support implemented as maximum bound (maxQueued) that a subscriber is allowed to enqueue. Once that bound is hit, publishing may semantically block until the lagging subscriber consumes some of its queued elements.

    Additionally the subscriber has possibility to terminate whenever size of enqueued elements is over certain size by using subscribeSize.

Deprecated Type Members

  1. trait InspectableQueue[F[_], A] extends Queue[F, A]

    Extension of Queue that allows peeking and inspection of the current size.

    Extension of Queue that allows peeking and inspection of the current size.

    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use cats.effect.std.Queue instead

  2. trait Queue[F[_], A] extends Enqueue[F, A] with Dequeue1[F, A] with DequeueChunk1[F, Id, A] with Dequeue[F, A]

    A queue of elements.

    A queue of elements. Operations are all nonblocking in their implementations, but may be 'semantically' blocking. For instance, a queue may have a bound on its size, in which case enqueuing may block (be delayed asynchronously) until there is an offsetting dequeue.

    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use cats.effect.std.Queue instead

Value Members

  1. object Balance

    Provides mechanisms for balancing the distribution of chunks across multiple streams.

  2. object Broadcast

    Provides mechanisms for broadcast distribution of elements to multiple streams.

  3. object Signal extends SignalInstances
  4. object SignallingRef
  5. object Topic

Deprecated Value Members

  1. object InspectableQueue
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use cats.effect.std.Queue instead

  2. object Queue
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use cats.effect.std.Queue instead

Inherited from AnyRef

Inherited from Any

Ungrouped