Package org.apache.pekko.stream.javadsl

Class Partition

java.lang.Object

org.apache.pekko.stream.javadsl.Partition

public class Partition
extends Object

Fan-out the stream to several streams. emitting an incoming upstream element to one downstream consumer according to the partitioner function applied to the element

Adheres to the ActorAttributes.SupervisionStrategy attribute.

'''Emits when''' all of the outputs stops backpressuring and there is an input element available

'''Backpressures when''' one of the outputs backpressure

'''Completes when''' upstream completes

'''Cancels when''' when any (eagerCancel=true) or all (eagerCancel=false) of the downstreams cancel

Constructor Summary

Constructors

Constructor	Description
Partition()

Method Summary

Modifier and Type	Method	Description
static <T> Graph<UniformFanOutShape<T,T>,NotUsed>	create(int outputCount, Function<T,Integer> partitioner)	Create a new Partition operator with the specified input type, eagerCancel is false.
static <T> Graph<UniformFanOutShape<T,T>,NotUsed>	create(int outputCount, Function<T,Integer> partitioner, boolean eagerCancel)	Create a new Partition operator with the specified input type.
static <T> Graph<UniformFanOutShape<T,T>,NotUsed>	create(Class<T> clazz, int outputCount, Function<T,Integer> partitioner)	Create a new Partition operator with the specified input type, eagerCancel is false.
static <T> Graph<UniformFanOutShape<T,T>,NotUsed>	create(Class<T> clazz, int outputCount, Function<T,Integer> partitioner, boolean eagerCancel)	Create a new Partition operator with the specified input type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Partition

public Partition()

Method Details

create

public static <T>
Graph<UniformFanOutShape<T,T>,NotUsed> create(int outputCount,
 Function<T,Integer> partitioner)

Create a new Partition operator with the specified input type, eagerCancel is false.

Parameters:

outputCount - number of output ports

partitioner - function deciding which output each element will be targeted

create

public static <T>
Graph<UniformFanOutShape<T,T>,NotUsed> create(int outputCount,
 Function<T,Integer> partitioner,
 boolean eagerCancel)

Create a new Partition operator with the specified input type.

Parameters:

outputCount - number of output ports

partitioner - function deciding which output each element will be targeted

eagerCancel - this operator cancels, when any (true) or all (false) of the downstreams cancel

create

public static <T>
Graph<UniformFanOutShape<T,T>,NotUsed> create(Class<T> clazz,
 int outputCount,
 Function<T,Integer> partitioner)

Create a new Partition operator with the specified input type, eagerCancel is false.

Parameters:

clazz - a type hint for this method

outputCount - number of output ports

partitioner - function deciding which output each element will be targeted

create

public static <T>
Graph<UniformFanOutShape<T,T>,NotUsed> create(Class<T> clazz,
 int outputCount,
 Function<T,Integer> partitioner,
 boolean eagerCancel)

Create a new Partition operator with the specified input type.

Parameters:

clazz - a type hint for this method

outputCount - number of output ports

partitioner - function deciding which output each element will be targeted

eagerCancel - this operator cancels, when any (true) or all (false) of the downstreams cancel