Topic

fs2.concurrent.Topic
See theTopic companion object
abstract class Topic[F[_], A]

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

Topic has built-in back-pressure support implemented as the maximum number of elements (maxQueued) that a subscriber is allowed to enqueue.

Once that bound is hit, any publishing action will semantically block until the lagging subscriber consumes some of its queued elements.

Attributes

Companion:
object
Source:
Topic.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Topic[F, A]

Members list

Concise view

Value members

Abstract methods

This method achieves graceful shutdown: when the topics gets closed, its subscribers will terminate naturally after consuming all currently enqueued elements.

This method achieves graceful shutdown: when the topics gets closed, its subscribers will terminate naturally after consuming all currently enqueued elements.

"Termination" here means that subscribers no longer wait for new elements on the topic, and not that they will be interrupted while performing another action: if you want to interrupt a subscriber, without first processing enqueued elements, you should use interruptWhen on it instead.

After a call to close, any further calls to publish1 or close will be no-ops.

Note that close does not automatically unblock producers which might be blocked on a bound, they will only become unblocked if/when subscribers naturally finish to consume the respective elements. You can race the publish with close to interrupt them immediately.

Attributes

Source:
Topic.scala
def closed: F[Unit]

Semantically blocks until the topic gets closed.

Semantically blocks until the topic gets closed.

Attributes

Source:
Topic.scala

Returns true if this topic is closed

Returns true if this topic is closed

Attributes

Source:
Topic.scala
def publish: (F, A) => Nothing

Publishes elements from source of A to this topic. Pipe equivalent of publish1. Closes the topic when the input stream terminates. Especially useful when the topic has a single producer.

Publishes elements from source of A to this topic. Pipe equivalent of publish1. Closes the topic when the input stream terminates. Especially useful when the topic has a single producer.

Attributes

Source:
Topic.scala
def publish1(a: A): F[Either[Closed, Unit]]

Publishes one A to topic. No-op if the channel is closed, see close for further info.

Publishes one A to topic. No-op if the channel is closed, see close for further info.

This operation does not complete until after the given element has been enqued on all subscribers, which means that if any subscriber is at its maxQueued limit, publish1 will semantically block until that subscriber consumes an element.

A semantically blocked publication can be interrupted, but there is no guarantee of atomicity, and it could result in the A being received by some subscribers only.

Note: if publish1 is called concurrently by multiple producers, different subscribers may receive messages from different producers in a different order.

Attributes

Source:
Topic.scala

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.

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.

Attributes

maxQueued

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

Source:
Topic.scala

Like subscribe, but represents the subscription explicitly as a Resource which returns after the subscriber is subscribed, but before it has started pulling elements.

Like subscribe, but represents the subscription explicitly as a Resource which returns after the subscriber is subscribed, but before it has started pulling elements.

Attributes

Source:
Topic.scala

Signal of current active subscribers.

Signal of current active subscribers.

Attributes

Source:
Topic.scala

Concrete methods

def imap[B](f: A => B)(g: B => A): Topic[F, B]

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

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

Attributes

Source:
Topic.scala

Like subscribeAwait, but allows an unbounded number of elements to enqueue to the subscription queue.

Like subscribeAwait, but allows an unbounded number of elements to enqueue to the subscription queue.

Attributes

Source:
Topic.scala

Like subscribe, but allows an unbounded number of elements to enqueue to the subscription queue.

Like subscribe, but allows an unbounded number of elements to enqueue to the subscription queue.

Attributes

Source:
Topic.scala