Trait

org.reactivestreams

Subscription

Related Doc: package reactivestreams

Permalink

trait Subscription extends AnyRef

Represents a one-to-one lifecycle of a Subscriber subscribing to a Publisher and mirrors the Subscription interface from the Reactive Streams specification.

It can be used only once by a single Subscriber. It is used for both signaling demand for data and for canceling demand (and allow resource cleanup).

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Subscription
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cancel(): Unit

    Permalink

    Request the Publisher to stop sending data and clean up resources.

    Request the Publisher to stop sending data and clean up resources.

    Data may still be sent to meet previously signalled demand after calling cancel as this request is asynchronous.

  2. abstract def request(n: Long): Unit

    Permalink

    No events will be sent by a Publisher until demand is signaled via this method.

    No events will be sent by a Publisher until demand is signaled via this method.

    It can be called however often and whenever needed. Whatever has been requested can be sent by the Publisher so only signal demand for what can be safely handled.

    A Publisher can send less than is requested if the stream ends but then must emit either onError or onComplete.

    The Subscriber MAY call this method synchronously in the implementation of its onSubscribe / onNext methods, therefore the effects of this function must be asynchronous, otherwise it could lead to a stack overflow.

    n

    signals demand for the number of onNext events that the Subscriber wants, if positive, then the Publisher is bound by contract to not send more than this number of onNext events and if negative, then this signals to the Publisher that it may send an infinite number of events, until the subscription gets cancelled or the stream is complete.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped