Class/Object

fs2.async.mutable

Topic

Related Docs: object Topic | package mutable

Permalink

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

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.

Self Type
Topic[F, A]
Source
Topic.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Topic
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Topic()

    Permalink

Abstract Value Members

  1. abstract def publish: Sink[F, A]

    Permalink

    Publishes elements from source of A to this topic.

    Publishes elements from source of A to this topic. Sink equivalent of publish1.

  2. abstract def publish1(a: A): F[Unit]

    Permalink

    Publishes one A to topic.

    Publishes one A to topic.

    This waits until a is published to all subscribers. If any of the subscribers is over the maxQueued limit, this will wait to complete until that subscriber processes enough of its elements such that a is enqueued.

  3. abstract def subscribe(maxQueued: Int): Stream[F, A]

    Permalink

    Subscribes for A values that are published to this topic.

    Subscribes for A values that are published to this topic.

    Pulling on the returned stream opens a "subscription", which allows up to maxQueued elements to be enqueued as a result of publication.

    The first element in the stream is always the last published A at the time the stream is first pulled from, followed by each published A value from that point forward.

    If at any point, the queue backing the subscription has maxQueued elements in it, any further publications semantically block until elements are dequeued from the subscription queue.

    maxQueued

    maximum number of elements to enqueue to the subscription queue before blocking publishers

  4. abstract def subscribeSize(maxQueued: Int): Stream[F, (A, Int)]

    Permalink

    Like subscribe but emits an approximate number of queued elements for this subscription with each emitted A value.

  5. abstract def subscribers: immutable.Signal[F, Int]

    Permalink

    Signal of current active subscribers.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to any2stringadd[Topic[F, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Topic[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to ArrowAssoc[Topic[F, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Topic[F, A]) ⇒ Boolean, msg: ⇒ Any): Topic[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to Ensuring[Topic[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Topic[F, A]) ⇒ Boolean): Topic[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to Ensuring[Topic[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Topic[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to Ensuring[Topic[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Topic[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to Ensuring[Topic[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to StringFormat[Topic[F, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A): Topic[F, B]

    Permalink

    Returns an alternate view of this Topic where its elements are of type B, given two functions, A => B and B => A.

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def [B](y: B): (Topic[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Topic[F, A] to ArrowAssoc[Topic[F, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Topic[F, A] to any2stringadd[Topic[F, A]]

Inherited by implicit conversion StringFormat from Topic[F, A] to StringFormat[Topic[F, A]]

Inherited by implicit conversion Ensuring from Topic[F, A] to Ensuring[Topic[F, A]]

Inherited by implicit conversion ArrowAssoc from Topic[F, A] to ArrowAssoc[Topic[F, A]]

Ungrouped