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
- Alphabetic
- By Inheritance
- Topic
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Topic()
Abstract Value Members
- abstract def publish: Pipe[F, A, Unit]
Publishes elements from source of
Ato this topic.Publishes elements from source of
Ato this topic. Pipe equivalent ofpublish1. - abstract def publish1(a: A): F[Unit]
Publishes one
Ato topic.Publishes one
Ato topic.This waits until
ais published to all subscribers. If any of the subscribers is over themaxQueuedlimit, this will wait to complete until that subscriber processes enough of its elements such thatais enqueued. - abstract def subscribe(maxQueued: Int): Stream[F, A]
Subscribes for
Avalues that are published to this topic.Subscribes for
Avalues that are published to this topic.Pulling on the returned stream opens a "subscription", which allows up to
maxQueuedelements to be enqueued as a result of publication.The first element in the stream is always the last published
Aat the time the stream is first pulled from, followed by each publishedAvalue from that point forward.If at any point, the queue backing the subscription has
maxQueuedelements 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
- abstract def subscribeSize(maxQueued: Int): Stream[F, (A, Int)]
Like subscribe but emits an approximate number of queued elements for this subscription with each emitted
Avalue. - abstract def subscribers: Stream[F, Int]
Signal of current active subscribers.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Topic[F, A], B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws(classOf[java.lang.CloneNotSupportedException])
- def ensuring(cond: (Topic[F, A]) ⇒ Boolean, msg: ⇒ Any): Topic[F, A]
- def ensuring(cond: (Topic[F, A]) ⇒ Boolean): Topic[F, A]
- def ensuring(cond: Boolean, msg: ⇒ Any): Topic[F, A]
- def ensuring(cond: Boolean): Topic[F, A]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- final def getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A): Topic[F, B]
Returns an alternate view of this
Topicwhere its elements are of typeB, given two functions,A => BandB => A. - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws(classOf[java.lang.InterruptedException])
- def →[B](y: B): (Topic[F, A], B)