org.vertx.scala.core.streams

DrainSupport

trait DrainSupport extends Self with AsJava

Allows to set a Handler which is notified once the write queue is drained again. This way you can stop writing once the write queue consumes to much memory and so prevent an OutOfMemoryError.

Linear Supertypes
AsJava, Self, AnyRef, Any
Known Subclasses
DatagramSocket
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DrainSupport
  2. AsJava
  3. Self
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type J <: java.core.streams.DrainSupport[_]

    The internal type of the Java wrapped class.

    The internal type of the Java wrapped class.

    Definition Classes
    DrainSupport → AsJava

Abstract Value Members

  1. abstract val asJava: J

    The internal instance of the Java wrapped class.

    The internal instance of the Java wrapped class.

    Definition Classes
    AsJava

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. def drainHandler(handler: ⇒ Unit): DrainSupport.this.type

    Set a drain handler on the stream.

    Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue has been reduced to maxSize / 2. See Pump for an example of this being used.

  7. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  16. def setWriteQueueMaxSize(maxSize: Int): DrainSupport.this.type

    Set the maximum size of the write queue to maxSize.

    Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize bytes in the write queue. This is used as an indicator by classes such as Pump to provide flow control.

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. def wrap[X](doStuff: ⇒ X): DrainSupport.this.type

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types

    Attributes
    protected[this]
    Definition Classes
    Self

  23. def writeQueueFull: Boolean

    This will return true if there are more bytes in the write queue than the value set using org.vertx.scala.core.streams.DrainSupport.setWriteQueueMaxSize

Inherited from AsJava

Inherited from Self

Inherited from AnyRef

Inherited from Any

Ungrouped