Package org.reactfx

Class BiSuspendable

java.lang.Object
org.reactfx.BiSuspendable
All Implemented Interfaces:
Suspendable

class BiSuspendable extends Object implements Suspendable
  • Field Details

  • Constructor Details

  • Method Details

    • suspend

      public Guard suspend()
      Description copied from interface: Suspendable
      Suspends this suspendable object.

      In case of suspendable Observable, suspends notification delivery for this observable object. Notifications produced while suspended may be queued for later delivery, accumulated into a single cumulative notification, or discarded completely, depending on the concrete implementation.

      Specified by:
      suspend in interface Suspendable
      Returns:
      a Guard instance that can be released to end suspension. In case of suspended notifications, releasing the returned Guard will trigger delivery of queued or accumulated notifications, if any.

      The returned Guard is AutoCloseable, which makes it convenient to use in try-with-resources.