TimeoutSettings

Timeout functionality requires each element to be uniquely identified, so it requires a Context, of any type defined by the application, to be carried along with the flow's input and output as a Tuple2 (Scala) or Pair (Java). The requirement is that either the Context itself or a mapping from Context should be able to uniquely identify an element. Here is the ways how a unique id can be retrieved:

Context itself is a type that can be used as a unique id, e.g., Int, Long, java.util.UUID
Context extends UniqueId.Provider and implements UniqueId.Provider.uniqueId method
Context is of type UniqueId.Envelope
Context can be mapped to a unique id by calling

uniqueIdMapper

In: the type of the elements pulled from the upstream along with the Context
Out: the type of the elements that are pushed to downstream along with the Context
Context: the type of the context that is carried around along with the elements.
returns: a BidiFlow with timeout functionality

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
val cleanUp: (Out) ⇒ Unit

an optional clean up function to be applied on timed out elements when pushed
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: FiniteDuration

the duration after which the processing of an element would be considered timed out
val uniqueIdMapper: Option[(Context) ⇒ Any]

the function that maps Context to a unique id
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( ... )
def withCleanUp(cleanUp: Consumer[Out]): TimeoutSettings[In, Out, Context]
def withUniqueIdMapper(uniqueIdMapper: (Context) ⇒ Any): TimeoutSettings[In, Out, Context]

Related Docs: object TimeoutSettings | package streams

case class TimeoutSettings[In, Out, Context] extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val cleanUp: (Out) ⇒ Unit

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val timeout: FiniteDuration

val uniqueIdMapper: Option[(Context) ⇒ Any]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withCleanUp(cleanUp: Consumer[Out]): TimeoutSettings[In, Out, Context]

def withUniqueIdMapper(uniqueIdMapper: (Context) ⇒ Any): TimeoutSettings[In, Out, Context]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped