Apache Pekko
1.2.1
API
Generated with
Apache Pekko/org.apache.pekko.stream.testkit/TestSubscriber/ManualProbe

ManualProbe

org.apache.pekko.stream.testkit.TestSubscriber.ManualProbe
See theManualProbe companion object
class ManualProbe[I] extends Subscriber[I]

Implementation of org.reactivestreams.Subscriber that allows various assertions.

All timeouts are dilated automatically, for more details about time dilation refer to pekko.testkit.TestKit.

Attributes

Companion
object
Source
StreamTestKit.scala
Graph
Supertypes
trait Subscriber[I]
class Object
trait Matchable
class Any
Known subtypes
class Probe[T]

Members list

Type members

Types

type Self <: ManualProbe[I]

Attributes

Source
StreamTestKit.scala

Value members

Concrete methods

def expectComplete(): Self

Fluent DSL

Fluent DSL

Expect completion.

Attributes

Source
StreamTestKit.scala
def expectError(): Throwable

Expect and return the signalled java.lang.Throwable.

Expect and return the signalled java.lang.Throwable.

Attributes

Source
StreamTestKit.scala
def expectError(cause: Throwable): Self

Fluent DSL

Fluent DSL

Expect given java.lang.Throwable.

Attributes

Source
StreamTestKit.scala
def expectEvent(): SubscriberEvent

Expect and return SubscriberEvent (any of: OnSubscribe, OnNext, OnError or OnComplete).

Expect and return SubscriberEvent (any of: OnSubscribe, OnNext, OnError or OnComplete).

Attributes

Source
StreamTestKit.scala
def expectEvent(max: FiniteDuration): SubscriberEvent

Expect and return SubscriberEvent (any of: OnSubscribe, OnNext, OnError or OnComplete).

Expect and return SubscriberEvent (any of: OnSubscribe, OnNext, OnError or OnComplete).

Attributes

Source
StreamTestKit.scala
def expectEvent(max: Duration): SubscriberEvent

JAVA API

JAVA API

Expect and return SubscriberEvent (any of: OnSubscribe, OnNext, OnError or OnComplete).

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectEvent(event: SubscriberEvent): Self

Fluent DSL

Fluent DSL

Expect SubscriberEvent (any of: OnSubscribe, OnNext, OnError or OnComplete).

Attributes

Source
StreamTestKit.scala
def expectEventWithTimeoutPF[T](max: Duration, f: PartialFunction[SubscriberEvent, T]): T

JAVA API

JAVA API

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNext(): I

Expect and return a stream element.

Expect and return a stream element.

Attributes

Source
StreamTestKit.scala
def expectNext(d: FiniteDuration): I

Expect and return a stream element during specified time or timeout.

Expect and return a stream element during specified time or timeout.

Attributes

Source
StreamTestKit.scala
def expectNext(d: Duration): I

JAVA API

JAVA API

Expect and return a stream element during specified time or timeout.

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNext(element: I): Self

Fluent DSL

Fluent DSL

Expect a stream element.

Attributes

Source
StreamTestKit.scala
def expectNext(d: FiniteDuration, element: I): Self

Fluent DSL

Fluent DSL

Expect a stream element during specified time or timeout.

Attributes

Source
StreamTestKit.scala
def expectNext(d: Duration, element: I): Self

JAVA PAI

JAVA PAI

Fluent DSL

Expect a stream element during specified time or timeout.

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNext(e1: I, e2: I, es: I*): Self

Fluent DSL

Fluent DSL

Expect multiple stream elements.

Attributes

Source
StreamTestKit.scala
def expectNextChainingPF(max: Duration, f: PartialFunction[Any, Any]): Self

Expect a stream element during specified time or timeout and test it with partial function.

Expect a stream element during specified time or timeout and test it with partial function.

Allows chaining probe methods.

Value parameters

max

wait no more than max time, otherwise throw AssertionError

Attributes

Source
StreamTestKit.scala
def expectNextChainingPF(max: Duration, f: PartialFunction[Any, Any]): Self

JAVA API

JAVA API

Expect a stream element during specified time or timeout and test it with partial function.

Allows chaining probe methods.

Value parameters

max

wait no more than max time, otherwise throw AssertionError

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNextChainingPF(f: PartialFunction[Any, Any]): Self

Expect a stream element during specified time or timeout and test it with partial function.

Expect a stream element during specified time or timeout and test it with partial function.

Allows chaining probe methods.

Attributes

Source
StreamTestKit.scala
def expectNextN(n: Long): Seq[I]

Expect and return the next n stream elements.

Expect and return the next n stream elements.

Attributes

Source
StreamTestKit.scala
def expectNextN(all: Seq[I]): Self

Fluent DSL Expect the given elements to be signalled in order.

Fluent DSL Expect the given elements to be signalled in order.

Attributes

Source
StreamTestKit.scala
def expectNextN(elems: List[I]): Self

Fluent DSL Expect the given elements to be signalled in order.

Fluent DSL Expect the given elements to be signalled in order.

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNextOrComplete(): Either[OnComplete.type, I]

Expect next element or stream completion - returning whichever was signalled.

Expect next element or stream completion - returning whichever was signalled.

Attributes

Source
StreamTestKit.scala
def expectNextOrComplete(element: I): Self

Fluent DSL

Fluent DSL

Expect given next element or stream completion.

Attributes

Source
StreamTestKit.scala
def expectNextOrError(): Either[Throwable, I]

Fluent DSL

Fluent DSL

Expect given next element or error signal, returning whichever was signalled.

Attributes

Source
StreamTestKit.scala
def expectNextOrError(element: I, cause: Throwable): Either[Throwable, I]

Fluent DSL Expect given next element or error signal.

Fluent DSL Expect given next element or error signal.

Attributes

Source
StreamTestKit.scala
def expectNextPF[T](f: PartialFunction[Any, T]): T

Expect a stream element and test it with partial function.

Expect a stream element and test it with partial function.

Attributes

Source
StreamTestKit.scala
def expectNextUnordered(e1: I, e2: I, es: I*): Self

Fluent DSL

Fluent DSL

Expect multiple stream elements in arbitrary order.

Attributes

Source
StreamTestKit.scala
def expectNextUnorderedN(all: Seq[I]): Self

Fluent DSL Expect the given elements to be signalled in any order.

Fluent DSL Expect the given elements to be signalled in any order.

Attributes

Source
StreamTestKit.scala
def expectNextUnorderedN(all: List[I]): Self

JAVA API

JAVA API

Fluent DSL Expect the given elements to be signalled in any order.

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNextWithTimeoutPF[T](max: Duration, f: PartialFunction[Any, T]): T

Expect a stream element and test it with partial function.

Expect a stream element and test it with partial function.

Value parameters

max

wait no more than max time, otherwise throw AssertionError

Attributes

Source
StreamTestKit.scala
def expectNextWithTimeoutPF[T](max: Duration, f: PartialFunction[Any, T]): T

JAVA API

JAVA API

Expect a stream element and test it with partial function.

Value parameters

max

wait no more than max time, otherwise throw AssertionError

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def expectNoMessage(remaining: FiniteDuration): Self

Fluent DSL

Fluent DSL

Assert that no message is received for the specified time.

Attributes

Source
StreamTestKit.scala
def expectNoMessage(): Self

Fluent DSL

Fluent DSL

Assert that no message is received for the specified time. Waits for the default period configured as pekko.test.expect-no-message-default. That timeout is scaled using the configuration entry "pekko.test.timefactor".

Attributes

Source
StreamTestKit.scala
def expectNoMessage(remaining: Duration): Self

Java API: Assert that no message is received for the specified time.

Java API: Assert that no message is received for the specified time.

Attributes

Source
StreamTestKit.scala
def expectSubscriptionAndComplete(): Self

Fluent DSL

Fluent DSL

Expect subscription followed by immediate stream completion. By default 1 demand will be signalled in order to wake up a possibly lazy upstream

See also #expectSubscriptionAndComplete(signalDemand: Boolean) if no demand should be signalled.

Attributes

Source
StreamTestKit.scala
def expectSubscriptionAndComplete(signalDemand: Boolean): Self

Fluent DSL

Fluent DSL

Expect subscription followed by immediate stream completion.

Depending on the signalDemand parameter demand may be signalled immediately after obtaining the subscription in order to wake up a possibly lazy upstream. You can disable this by setting the signalDemand parameter to false.

See also #expectSubscriptionAndComplete.

Attributes

Source
StreamTestKit.scala
def expectSubscriptionAndError(): Throwable

Expect subscription to be followed immediately by an error signal.

Expect subscription to be followed immediately by an error signal.

By default 1 demand will be signalled in order to wake up a possibly lazy upstream.

See also #expectSubscriptionAndError(signalDemand: Boolean) if no demand should be signalled.

Attributes

Source
StreamTestKit.scala
def expectSubscriptionAndError(signalDemand: Boolean): Throwable

Expect subscription to be followed immediately by an error signal.

Expect subscription to be followed immediately by an error signal.

Depending on the signalDemand parameter demand may be signalled immediately after obtaining the subscription in order to wake up a possibly lazy upstream. You can disable this by setting the signalDemand parameter to false.

See also #expectSubscriptionAndError().

Attributes

Source
StreamTestKit.scala
def expectSubscriptionAndError(cause: Throwable): Self

Fluent DSL

Fluent DSL

Expect subscription followed by immediate stream completion.

By default 1 demand will be signalled in order to wake up a possibly lazy upstream.

See also #expectSubscriptionAndError(cause: Throwable, signalDemand: Boolean) if no demand should be signalled.

Attributes

Source
StreamTestKit.scala
def expectSubscriptionAndError(cause: Throwable, signalDemand: Boolean): Self

Fluent DSL

Fluent DSL

Expect subscription followed by immediate stream completion. By default 1 demand will be signalled in order to wake up a possibly lazy upstream

See also #expectSubscriptionAndError(cause: Throwable).

Attributes

Source
StreamTestKit.scala
def onComplete(): Unit

Attributes

Source
StreamTestKit.scala
def onError(cause: Throwable): Unit

Attributes

Source
StreamTestKit.scala
def onNext(element: I): Unit

Attributes

Source
StreamTestKit.scala
def onSubscribe(subscription: Subscription): Unit

Attributes

Source
StreamTestKit.scala
def receiveWhile[T](max: Duration, idle: Duration, messages: Int)(f: PartialFunction[SubscriberEvent, T]): Seq[T]

Receive messages for a given duration or until one does not match a given partial function.

Receive messages for a given duration or until one does not match a given partial function.

Attributes

Source
StreamTestKit.scala
def receiveWhile[T](max: Duration, idle: Duration, messages: Int, f: PartialFunction[SubscriberEvent, T]): List[T]

JAVA API

JAVA API

Receive messages for a given duration or until one does not match a given partial function.

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def receiveWithin(max: FiniteDuration, messages: Int): Seq[I]

Drains a given number of messages

Drains a given number of messages

Attributes

Source
StreamTestKit.scala
def receiveWithin(max: Duration, messages: Int): List[I]

JAVA API

JAVA API

Drains a given number of messages

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def toStrict(atMost: FiniteDuration): Seq[I]

Attempt to drain the stream into a strict collection (by requesting Long.MaxValue elements).

Attempt to drain the stream into a strict collection (by requesting Long.MaxValue elements).

'''Use with caution: Be warned that this may not be a good idea if the stream is infinite or its elements are very large!'''

Attributes

Source
StreamTestKit.scala
def toStrict(atMost: Duration): List[I]

JAVA API

JAVA API

Attempt to drain the stream into a strict collection (by requesting Long.MaxValue elements).

'''Use with caution: Be warned that this may not be a good idea if the stream is infinite or its elements are very large!'''

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def within[T](min: FiniteDuration, max: FiniteDuration)(f: => T): T

Execute code block while bounding its execution time between min and max. within blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing within block.

Execute code block while bounding its execution time between min and max. within blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing within block.

Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "pekko.test.timefactor", while the min Duration is not.

val ret = within(50 millis) {
 test ! "ping"
 expectMsgClass(classOf[String])
}

Attributes

Source
StreamTestKit.scala
def within[T](min: Duration, max: Duration, creator: Creator[T]): T

JAVA API

JAVA API

Execute code block while bounding its execution time between min and max. within blocks may be nested. All methods in this trait which take maximum wait times are available in a version which implicitly uses the remaining time governed by the innermost enclosing within block.

Note that the timeout is scaled using Duration.dilated, which uses the configuration entry "pekko.test.timefactor", while the min Duration is not.

val ret = within(Duration.ofMillis(50)) {
 test ! "ping"
 expectMsgClass(classOf[String])
}

Attributes

Since

1.1.0

Source
StreamTestKit.scala
def within[T](max: FiniteDuration)(f: => T): T

Same as calling within(0 seconds, max)(f).

Same as calling within(0 seconds, max)(f).

Attributes

Source
StreamTestKit.scala
def within[T](max: Duration)(creator: Creator[T]): T

JAVA API

JAVA API

Same as calling within(Duration.ofSeconds(0), max)(f).

Attributes

Since

1.1.0

Source
StreamTestKit.scala

Deprecated methods

def expectNoMsg(): Self

Fluent DSL

Fluent DSL

Same as expectNoMsg(remaining), but correctly treating the timeFactor. NOTE! Timeout value is automatically multiplied by timeFactor.

Attributes

Deprecated
[Since version Akka 2.5.5] Use expectNoMessage instead
Source
StreamTestKit.scala
def expectNoMsg(remaining: FiniteDuration): Self

Fluent DSL

Fluent DSL

Assert that no message is received for the specified time. NOTE! Timeout value is automatically multiplied by timeFactor.

Attributes

Deprecated
[Since version Akka 2.5.5] Use expectNoMessage instead
Source
StreamTestKit.scala
Generated with