Packages

class Probe[T] extends ManualProbe[T]

Single subscription tracking for ManualProbe.

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

Type Members

  1. type Self = Probe[T]
    Definition Classes
    Probe → ManualProbe

Value Members

  1. def cancel(): Self
  2. def ensureSubscription(): Self

    Asserts that a subscription has been received or will be received

  3. def expectComplete(): Self

    Fluent DSL

    Fluent DSL

    Expect completion.

    Definition Classes
    ManualProbe
  4. def expectError(cause: Throwable): Self

    Fluent DSL

    Fluent DSL

    Expect given Throwable.

    Definition Classes
    ManualProbe
  5. def expectError(): Throwable

    Expect and return the signalled Throwable.

    Expect and return the signalled Throwable.

    Definition Classes
    ManualProbe
  6. def expectEvent(event: SubscriberEvent): Self

    Fluent DSL

    Fluent DSL

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

    Definition Classes
    ManualProbe
  7. 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).

    Definition Classes
    ManualProbe
  8. 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).

    Definition Classes
    ManualProbe
  9. def expectEventPF[T](f: PartialFunction[SubscriberEvent, T]): T
    Definition Classes
    ManualProbe
  10. def expectEventWithTimeoutPF[T](max: Duration, f: PartialFunction[SubscriberEvent, T]): T
    Definition Classes
    ManualProbe
  11. def expectNext(e1: T, e2: T, es: T*): Self

    Fluent DSL

    Fluent DSL

    Expect multiple stream elements.

    Definition Classes
    ManualProbe
    Annotations
    @varargs()
  12. def expectNext(d: FiniteDuration, element: T): Self

    Fluent DSL

    Fluent DSL

    Expect a stream element during specified time or timeout.

    Definition Classes
    ManualProbe
  13. def expectNext(element: T): Self

    Fluent DSL

    Fluent DSL

    Expect a stream element.

    Definition Classes
    ManualProbe
  14. def expectNext(d: FiniteDuration): T

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

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

    Definition Classes
    ManualProbe
  15. def expectNext(): T

    Expect and return a stream element.

    Expect and return a stream element.

    Definition Classes
    ManualProbe
  16. 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.

    Definition Classes
    ManualProbe
  17. 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

    Definition Classes
    ManualProbe
  18. def expectNextN(all: Seq[T]): Self

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

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

    Definition Classes
    ManualProbe
  19. def expectNextN(n: Long): Seq[T]

    Expect and return the next n stream elements.

    Expect and return the next n stream elements.

    Definition Classes
    ManualProbe
  20. def expectNextOrComplete(element: T): Self

    Fluent DSL

    Fluent DSL

    Expect given next element or stream completion.

    Definition Classes
    ManualProbe
  21. def expectNextOrComplete(): Either[OnComplete.type, T]

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

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

    Definition Classes
    ManualProbe
  22. def expectNextOrError(element: T, cause: Throwable): Either[Throwable, T]

    Fluent DSL Expect given next element or error signal.

    Fluent DSL Expect given next element or error signal.

    Definition Classes
    ManualProbe
  23. def expectNextOrError(): Either[Throwable, T]

    Fluent DSL

    Fluent DSL

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

    Definition Classes
    ManualProbe
  24. 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.

    Definition Classes
    ManualProbe
  25. def expectNextUnordered(e1: T, e2: T, es: T*): Self

    Fluent DSL

    Fluent DSL

    Expect multiple stream elements in arbitrary order.

    Definition Classes
    ManualProbe
    Annotations
    @varargs()
  26. def expectNextUnorderedN(all: Seq[T]): 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.

    Definition Classes
    ManualProbe
  27. 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

    Definition Classes
    ManualProbe
  28. 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.

    Definition Classes
    ManualProbe
  29. def expectNoMessage(remaining: FiniteDuration): Self

    Fluent DSL

    Fluent DSL

    Assert that no message is received for the specified time.

    Definition Classes
    ManualProbe
  30. def expectSubscription(): Subscription

    Expect and return a org.reactivestreams.Subscription.

    Expect and return a org.reactivestreams.Subscription.

    Definition Classes
    ManualProbe
  31. 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.

    Definition Classes
    ManualProbe
  32. 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.

    Definition Classes
    ManualProbe
  33. 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).

    Definition Classes
    ManualProbe
  34. 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.

    Definition Classes
    ManualProbe
  35. 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().

    Definition Classes
    ManualProbe
  36. 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.

    Definition Classes
    ManualProbe
  37. def onComplete(): Unit
    Definition Classes
    ManualProbe → Subscriber
  38. def onError(cause: Throwable): Unit
    Definition Classes
    ManualProbe → Subscriber
  39. def onNext(element: T): Unit
    Definition Classes
    ManualProbe → Subscriber
  40. def onSubscribe(subscription: Subscription): Unit
    Definition Classes
    ManualProbe → Subscriber
  41. 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.

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

    Definition Classes
    ManualProbe
  42. def receiveWithin(max: FiniteDuration, messages: Int = Int.MaxValue): Seq[T]

    Drains a given number of messages

    Drains a given number of messages

    Definition Classes
    ManualProbe
  43. def request(n: Long): Self
  44. def requestNext(d: FiniteDuration): T

    Request and expect a stream element during the specified time or timeout.

  45. def requestNext(): T

    Request and expect a stream element.

  46. def requestNext(element: T): Self

    Request and expect a stream element.

  47. def toStrict(atMost: FiniteDuration): Seq[T]

    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!

    Definition Classes
    ManualProbe
  48. def within[T](max: FiniteDuration)(f: ⇒ T): T

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

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

    Definition Classes
    ManualProbe
  49. 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])
}
    Definition Classes
    ManualProbe

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.

    Definition Classes
    ManualProbe
    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.

    Definition Classes
    ManualProbe
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.5) Use expectNoMessage instead