vertx-lang-scala-docs_2.12 3.5.2.CR2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package core
  Definition Classes
    scala
-  package streams
  Definition Classes
    core
- Pump
- ReadStream
- StreamBase
- WriteStream

t

io.vertx.scala.core.streams

# WriteStream 

###
Companion object WriteStream

#### trait WriteStream[T] extends StreamBase

Represents a stream of data that can be written to.

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

Linear Supertypes
StreamBase, AnyRef, Any
Known Subclasses
MessageProducer, AsyncFile, HttpClientRequest, HttpServerResponse, ServerWebSocket, WebSocket, WebSocketBase, NetSocket, SockJSSocket, KafkaProducer
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. WriteStream
2. StreamBase
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def asJava: AnyRef
   Definition Classes
     WriteStream → StreamBase
2.  abstract def drainHandler(handler: Handler[Unit]): WriteStream[T]

   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 is ready to accept buffers again. See io.vertx.scala.core.streams.Pump for an example of this being used.

   The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to `maxSize / 2`.

   handler

     the handler

   returns

     a reference to this, so the API can be used fluently

3.  abstract def end(t: T): Unit

   Same as io.vertx.scala.core.streams.WriteStream#end but writes some data to the stream before ending.

4.  abstract def end(): Unit

   Ends the stream.

   Ends the stream.

   Once the stream has ended, it cannot be used any more.

5.  abstract def exceptionHandler(handler: Handler[Throwable]): WriteStream[T]

   Set an exception handler on the write stream.

   Set an exception handler on the write stream.

   handler

     the exception handler

   returns

     a reference to this, so the API can be used fluently

   Definition Classes
     WriteStream → StreamBase
6.  abstract def setWriteQueueMaxSize(maxSize: Int): WriteStream[T]

   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` items in the write queue. This is used as an indicator by classes such as `Pump` to provide flow control.

   The value is defined by the implementation of the stream, e.g in bytes for a io.vertx.scala.core.net.NetSocket, the number of io.vertx.scala.core.eventbus.Message for a io.vertx.scala.core.eventbus.MessageProducer, etc...

   maxSize

     the max size of the write stream

   returns

     a reference to this, so the API can be used fluently

7.  abstract def write(data: T): WriteStream[T]

   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 io.vertx.scala.core.streams.WriteStream#writeQueueFull method before writing. This is done automatically if using a io.vertx.scala.core.streams.Pump.

   data

     the data to write

   returns

     a reference to this, so the API can be used fluently

8.  abstract def writeQueueFull(): Boolean

   This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.streams.WriteStream#setWriteQueueMaxSize

   This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.streams.WriteStream#setWriteQueueMaxSize

   returns

     true if write queue is full

### 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
     @native() @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
   Annotations
     @native()
10.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
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
    Annotations
      @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
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
      @native() @throws( ... )

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped