akka.stream.scaladsl

Class Partition<T>

java.lang.Object

akka.stream.stage.GraphStageWithMaterializedValue<S,NotUsed>

akka.stream.stage.GraphStage<UniformFanOutShape<T,T>>

akka.stream.scaladsl.Partition<T>

All Implemented Interfaces:

Graph<UniformFanOutShape<T,T>,NotUsed>

public final class Partition<T>
extends GraphStage<UniformFanOutShape<T,T>>

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

'''Emits when''' emits when an element is available from the input and the chosen output has demand

'''Backpressures when''' the currently chosen output back-pressures

'''Completes when''' upstream completes and no output is pending

'''Cancels when''' when all downstreams cancel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Partition.PartitionOutOfBoundsException
static class	Partition.PartitionOutOfBoundsException$

Constructor Summary

Constructors

Constructor and Description
Partition(int outputPorts, scala.Function1<T,java.lang.Object> partitioner)

Method Summary

Modifier and Type	Method and Description
static Graph<S,M>	addAttributes(Attributes attr)
static <T> Partition<T>	apply(int outputPorts, scala.Function1<T,java.lang.Object> partitioner) Create a new Partition stage with the specified input type.
static Graph<S,M>	async()
GraphStageLogic	createLogic(Attributes inheritedAttributes)
static scala.Tuple2<GraphStageLogic,NotUsed>	createLogicAndMaterializedValue(Attributes inheritedAttributes)
Inlet<T>	in()
protected static Attributes	initialAttributes()
static StreamLayout.Module	module()
static Graph<S,M>	named(java.lang.String name)
scala.collection.Seq<Outlet<T>>	out()
int	outputPorts()
scala.Function1<T,java.lang.Object>	partitioner()
UniformFanOutShape<T,T>	shape() The shape of a graph is all that is externally visible: its inlets and outlets.
java.lang.String	toString()
static Graph<S,M>	withAttributes(Attributes attr)

Methods inherited from class akka.stream.stage.GraphStage

createLogicAndMaterializedValue

Methods inherited from class akka.stream.stage.GraphStageWithMaterializedValue

initialAttributes, module, withAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.stream.Graph

addAttributes, async, named

Constructor Detail

Partition

public Partition(int outputPorts,
                 scala.Function1<T,java.lang.Object> partitioner)

Method Detail

apply

public static <T> Partition<T> apply(int outputPorts,
                                     scala.Function1<T,java.lang.Object> partitioner)

Create a new Partition stage with the specified input type.

Parameters:

outputPorts - number of output ports

partitioner - function deciding which output each element will be targeted

Returns:

(undocumented)

named

public static Graph<S,M> named(java.lang.String name)

async

public static Graph<S,M> async()

addAttributes

public static Graph<S,M> addAttributes(Attributes attr)

initialAttributes

protected static Attributes initialAttributes()

module

public static final StreamLayout.Module module()

withAttributes

public static final Graph<S,M> withAttributes(Attributes attr)

createLogicAndMaterializedValue

public static final scala.Tuple2<GraphStageLogic,NotUsed> createLogicAndMaterializedValue(Attributes inheritedAttributes)

outputPorts

public int outputPorts()

partitioner

public scala.Function1<T,java.lang.Object> partitioner()

in

public Inlet<T> in()

out

public scala.collection.Seq<Outlet<T>> out()

shape

public UniformFanOutShape<T,T> shape()

Description copied from interface: Graph

The shape of a graph is all that is externally visible: its inlets and outlets.

Returns:

(undocumented)

createLogic

public GraphStageLogic createLogic(Attributes inheritedAttributes)

Specified by:

createLogic in class GraphStage<UniformFanOutShape<T,T>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object