Packages

t

org.mongodb.scala

Subscription

trait Subscription extends com.mongodb.async.client.Subscription

A Subscription represents a one-to-one lifecycle of a Observer subscribing to an Observable.

Instances can only be used once by a single Observer.

It is used to both signal desire for data and to allow for unsubscribing.

Linear Supertypes
com.mongodb.async.client.Subscription, AnyRef, Any
Known Subclasses
BoxedSubscription
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Subscription
  2. Subscription
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def isUnsubscribed(): Boolean

    Indicates whether this Subscription is currently unsubscribed.

    Indicates whether this Subscription is currently unsubscribed.

    returns

    true if this Subscription is currently unsubscribed, false otherwise

    Definition Classes
    Subscription → Subscription
  2. abstract def request(n: Long): Unit

    No operation will be sent to MongoDB from the Observable until demand is signaled via this method.

    No operation will be sent to MongoDB from the Observable until demand is signaled via this method.

    It can be called however often and whenever needed, but the outstanding cumulative demand must never exceed Long.MaxValue. An outstanding cumulative demand of Long.MaxValue may be treated by the Observable as "effectively unbounded".

    Whatever has been requested might be sent, so only signal demand for what can be safely handled.

    An Observable can send less than is requested if the stream ends but then must emit either Observer.onError or Observer.onComplete.

    n

    the strictly positive number of elements to requests to the upstream Observable

    Definition Classes
    Subscription → Subscription
  3. abstract def unsubscribe(): Unit

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

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

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

    Definition Classes
    Subscription → Subscription

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from com.mongodb.async.client.Subscription

Inherited from AnyRef

Inherited from Any

Ungrouped