BoundedOrdering

Orders the stream within a sliding window of maxBounded elements. Each element passing through the BoundedOrdering has an id. The elements can be ordered by the ordering function and the next expected id can be derived from the current id.

It takes an element and emits downstream if the getId(elem) matches the currently stored id, if not enqueues to a priority queue. When an element is emitted, the stored id is updated by calling nextId to match the next expected element and an element is dequeued from the priority queue and emitted if it matches the updated id. If the out-of-order element arrives at a later point than maxBounded then it is emitted straight downstream.

A: The input and output type of this stream component.
B: The type of the element's id. Emits when getId(elem) matches the current state, if not enqueues it to priority queue Backpressures when downstream backpressures Completes when upstream completes Cancels when downstream cancels

Linear Supertypes

GraphStage[FlowShape[A, A]], GraphStageWithMaterializedValue[FlowShape[A, A], NotUsed], Graph[FlowShape[A, A], NotUsed], AnyRef, Any

Instance Constructors

new BoundedOrdering(maxBounded: Int, initialId: B, nextId: (B) ⇒ B, getId: (A) ⇒ B)(implicit ordering: Ordering[B])

maxBounded
The number of elements to wait for an out-of-order element.
initialId
The id of the first element getting to the BoundedOrdering.
nextId
Function to calculate the subsequent id from the current id.
getId
Function to get the id from an element.
ordering
Defines how the element ids are being ordered.

Type Members

type Shape = FlowShape[A, A]

Definition Classes
Graph

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addAttributes(attr: Attributes): Graph[FlowShape[A, A], NotUsed]

Definition Classes
Graph
final def asInstanceOf[T0]: T0

Definition Classes
Any
def async(dispatcher: String, inputBufferSize: Int): Graph[FlowShape[A, A], NotUsed]

Definition Classes
Graph
def async(dispatcher: String): Graph[FlowShape[A, A], NotUsed]

Definition Classes
Graph
def async: Graph[FlowShape[A, A], NotUsed]

Definition Classes
Graph
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createLogic(inheritedAttributes: Attributes): GraphStageLogic

Definition Classes
BoundedOrdering → GraphStage
final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)

Definition Classes
GraphStage → GraphStageWithMaterializedValue
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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val in: Inlet[A]
def initialAttributes: Attributes

Attributes
protected
Definition Classes
GraphStageWithMaterializedValue
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def named(name: String): Graph[FlowShape[A, A], NotUsed]

Definition Classes
Graph
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit val ordering: Ordering[B]

Defines how the element ids are being ordered.
val out: Outlet[A]
val shape: FlowShape[A, A]

Definition Classes
BoundedOrdering → Graph
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withAttributes(attr: Attributes): Graph[FlowShape[A, A], NotUsed]

Definition Classes
GraphStageWithMaterializedValue → Graph

Related Docs: object BoundedOrdering | package streams

class BoundedOrdering[A, B] extends GraphStage[FlowShape[A, A]]

Instance Constructors

new BoundedOrdering(maxBounded: Int, initialId: B, nextId: (B) ⇒ B, getId: (A) ⇒ B)(implicit ordering: Ordering[B])

Type Members

type Shape = FlowShape[A, A]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAttributes(attr: Attributes): Graph[FlowShape[A, A], NotUsed]

final def asInstanceOf[T0]: T0

def async(dispatcher: String, inputBufferSize: Int): Graph[FlowShape[A, A], NotUsed]

def async(dispatcher: String): Graph[FlowShape[A, A], NotUsed]

def async: Graph[FlowShape[A, A], NotUsed]

def clone(): AnyRef

def createLogic(inheritedAttributes: Attributes): GraphStageLogic

final def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, NotUsed)

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val in: Inlet[A]

def initialAttributes: Attributes

final def isInstanceOf[T0]: Boolean

def named(name: String): Graph[FlowShape[A, A], NotUsed]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit val ordering: Ordering[B]

val out: Outlet[A]

val shape: FlowShape[A, A]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def withAttributes(attr: Attributes): Graph[FlowShape[A, A], NotUsed]

Inherited from GraphStage[FlowShape[A, A]]

Inherited from GraphStageWithMaterializedValue[FlowShape[A, A], NotUsed]

Inherited from Graph[FlowShape[A, A], NotUsed]

Inherited from AnyRef

Inherited from Any

Ungrouped