org.vertx.scala.core.streams

WriteStream

trait WriteStream extends Self with ExceptionSupport with AsJava

Represents a stream of data that can be written to

Any class that implements this interface can be used by a org.vertx.scala.core.streams.Pump to pump data from a org.vertx.scala.core.streams.ReadStream to it.

This interface exposes a fluent api and the type T represents the type of the object that implements the interface to allow method chaining

Linear Supertypes
ExceptionSupport, AsJava, Self, AnyRef, Any
Known Subclasses
AsyncFile, HttpClientRequest, HttpServerResponse, NetSocket, ServerWebSocket, SockJSSocket, WebSocket, WebSocketBase
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WriteStream
  2. ExceptionSupport
  3. AsJava
  4. Self
  5. AnyRef
  6. 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.WriteStream[_]

    The internal type of the Java wrapped class.

    The internal type of the Java wrapped class.

    Definition Classes
    WriteStream → ExceptionSupport → 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: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. def drainHandler(handler: ⇒ Unit): WriteStream.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 org.vertx.scala.core.streams.Pump for an example of this being used.

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

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def exceptionHandler(handler: (Throwable) ⇒ Unit): WriteStream.this.type

    Set an exception handler.

    Set an exception handler.

    Definition Classes
    ExceptionSupport

  12. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  19. def setWriteQueueMaxSize(maxSize: Int): WriteStream.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.

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

    Definition Classes
    AnyRef

  21. def toString(): String

    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def wrap[X](doStuff: ⇒ X): WriteStream.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

  26. def write(data: Buffer): WriteStream.this.type

    Write some data to the stream.

    Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the org.vertx.scala.core.streams.WriteStream.writeQueueFull() method before writing. This is done automatically if using a org.vertx.scala.core.streams.Pump.

  27. 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.WriteStream.setWriteQueueMaxSize()

Inherited from ExceptionSupport

Inherited from AsJava

Inherited from Self

Inherited from AnyRef

Inherited from Any

Ungrouped