MergeHub

org.apache.pekko.stream.javadsl.MergeHub
object MergeHub

A MergeHub is a special streaming hub that is able to collect streamed elements from a dynamic set of producers. It consists of two parts, a Source and a Sink. The Source streams the element to a consumer from its merged inputs. Once the consumer has been materialized, the Source returns a materialized value which is the corresponding Sink. This Sink can then be materialized arbitrary many times, where each of the new materializations will feed its consumed elements to the original Source.

Attributes

Source
Hub.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
MergeHub.type

Members list

Type members

Classlikes

A DrainingControl object is created during the materialization of a MergeHub and allows to initiate the draining and eventual completion of the Hub from the outside.

A DrainingControl object is created during the materialization of a MergeHub and allows to initiate the draining and eventual completion of the Hub from the outside.

Not for user extension

Attributes

Source
Hub.scala
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def of[T](clazz: Class[T], perProducerBufferSize: Int): Source[T, Sink[T, NotUsed]]

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrary many times and each of the materializations will feed the elements into the original Source.

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrary many times and each of the materializations will feed the elements into the original Source.

Every new materialization of the Source results in a new, independent hub, which materializes to its own Sink for feeding that materialization.

Completed or failed Sinks are simply removed. Once the Source is cancelled, the Hub is considered closed and any new producers using the Sink will be cancelled.

Value parameters

clazz

Type of elements this hub emits and consumes

perProducerBufferSize

Buffer space used per producer.

Attributes

Source
Hub.scala
def of[T](clazz: Class[T]): Source[T, Sink[T, NotUsed]]

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrary many times and each of the materializations will feed the elements into the original Source.

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrary many times and each of the materializations will feed the elements into the original Source.

Every new materialization of the Source results in a new, independent hub, which materializes to its own Sink for feeding that materialization.

Completed or failed Sinks are simply removed. Once the Source is cancelled, the Hub is considered closed and any new producers using the Sink will be cancelled.

Value parameters

clazz

Type of elements this hub emits and consumes

Attributes

Source
Hub.scala
def withDraining[T](clazz: Class[T], perProducerBufferSize: Int): Source[T, Pair[Sink[T, NotUsed], DrainingControl]]

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrarily many times and each of the materializations will feed the elements into the original Source.

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrarily many times and each of the materializations will feed the elements into the original Source.

Every new materialization of the Source results in a new, independent hub, which materializes to its own Sink for feeding that materialization.

Completed or failed Sinks are simply removed. Once the Source is cancelled, the Hub is considered closed and any new producers using the Sink will be cancelled.

The materialized DrainingControl can be used to drain the Hub: any new produces using the Sink will be cancelled and the Hub will be closed completing the Source as soon as all currently connected producers complete.

Value parameters

clazz

Type of elements this hub emits and consumes

perProducerBufferSize

Buffer space used per producer. Default value is 16.

Attributes

Source
Hub.scala
def withDraining[T](clazz: Class[T]): Source[T, Pair[Sink[T, NotUsed], DrainingControl]]

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrarily many times and each of the materializations will feed the elements into the original Source.

Creates a Source that emits elements merged from a dynamic set of producers. After the Source returned by this method is materialized, it returns a Sink as a materialized value. This Sink can be materialized arbitrarily many times and each of the materializations will feed the elements into the original Source.

Every new materialization of the Source results in a new, independent hub, which materializes to its own Sink for feeding that materialization.

Completed or failed Sinks are simply removed. Once the Source is cancelled, the Hub is considered closed and any new producers using the Sink will be cancelled.

The materialized DrainingControl can be used to drain the Hub: any new produces using the Sink will be cancelled and the Hub will be closed completing the Source as soon as all currently connected producers complete.

Value parameters

clazz

Type of elements this hub emits and consumes

Attributes

Source
Hub.scala