Packages

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 akka.testkit.TestKit.

Source
StreamTestKit.scala
Linear Supertypes
Subscriber[I], AnyRef, Any
Known Subclasses
Probe
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ManualProbe
  2. Subscriber
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Self <: ManualProbe[I]

Value Members

  1. def expectComplete(): Self

    Fluent DSL

    Fluent DSL

    Expect completion.

  2. def expectError(cause: Throwable): Self

    Fluent DSL

    Fluent DSL

    Expect given Throwable.

  3. def expectError(): Throwable

    Expect and return the signalled Throwable.

  4. def expectEvent(event: SubscriberEvent): Self

    Fluent DSL

    Fluent DSL

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

  5. def expectEvent(max: FiniteDuration): SubscriberEvent

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

  6. def expectEvent(): SubscriberEvent

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

  7. def expectEventPF[T](f: PartialFunction[SubscriberEvent, T]): T
  8. def expectEventWithTimeoutPF[T](max: Duration, f: PartialFunction[SubscriberEvent, T]): T
  9. def expectNext(e1: I, e2: I, es: I*): Self

    Fluent DSL

    Fluent DSL

    Expect multiple stream elements.

    Annotations
    @varargs()
  10. def expectNext(d: FiniteDuration, element: I): Self

    Fluent DSL

    Fluent DSL

    Expect a stream element during specified time or timeout.

  11. def expectNext(element: I): Self

    Fluent DSL

    Fluent DSL

    Expect a stream element.

  12. def expectNext(d: FiniteDuration): I

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

  13. def expectNext(): I

    Expect and return a stream element.

  14. 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.

  15. 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.

    max

    wait no more than max time, otherwise throw AssertionError

  16. def expectNextN(all: Seq[I]): Self

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

  17. def expectNextN(n: Long): Seq[I]

    Expect and return the next n stream elements.

  18. def expectNextOrComplete(element: I): Self

    Fluent DSL

    Fluent DSL

    Expect given next element or stream completion.

  19. def expectNextOrComplete(): Either[OnComplete.type, I]

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

  20. def expectNextOrError(element: I, cause: Throwable): Either[Throwable, I]

    Fluent DSL Expect given next element or error signal.

  21. def expectNextOrError(): Either[Throwable, I]

    Fluent DSL

    Fluent DSL

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

  22. def expectNextPF[T](f: PartialFunction[Any, T]): T

    Expect a stream element and test it with partial function.

  23. def expectNextUnordered(e1: I, e2: I, es: I*): Self

    Fluent DSL

    Fluent DSL

    Expect multiple stream elements in arbitrary order.

    Annotations
    @varargs()
  24. def expectNextUnorderedN(all: Seq[I]): Self

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

  25. 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.

    max

    wait no more than max time, otherwise throw AssertionError

  26. def expectNoMessage(remaining: Duration): Self

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

  27. def expectNoMessage(): Self

    Fluent DSL

    Fluent DSL

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

  28. def expectNoMessage(remaining: FiniteDuration): Self

    Fluent DSL

    Fluent DSL

    Assert that no message is received for the specified time.

  29. def expectSubscription(): Subscription

    Expect and return a org.reactivestreams.Subscription.

  30. 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.

  31. 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 Boolean) if no demand should be signalled.

  32. 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 Throwable).

  33. 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 Throwable, signalDemand: Boolean) if no demand should be signalled.

  34. 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.

  35. 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(Boolean) if no demand should be signalled.

  36. def onComplete(): Unit
    Definition Classes
    ManualProbe → Subscriber
  37. def onError(cause: Throwable): Unit
    Definition Classes
    ManualProbe → Subscriber
  38. def onNext(element: I): Unit
    Definition Classes
    ManualProbe → Subscriber
  39. def onSubscribe(subscription: Subscription): Unit
    Definition Classes
    ManualProbe → Subscriber
  40. def receiveWhile[T](max: Duration = Duration.Undefined, idle: Duration = Duration.Inf, messages: Int = Int.MaxValue)(f: PartialFunction[SubscriberEvent, T]): Seq[T]

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

  41. def receiveWithin(max: FiniteDuration, messages: Int = Int.MaxValue): Seq[I]

    Drains a given number of messages

  42. 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!

  43. def within[T](max: FiniteDuration)(f: => T): T

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

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

    Execute code block while bounding its execution time between min and max.

    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 "akka.test.timefactor", while the min Duration is not.

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

Deprecated Value Members

  1. 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.5) Use expectNoMessage instead

  2. def expectNoMsg(): Self

    Fluent DSL

    Fluent DSL

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.5) Use expectNoMessage instead