vertx-lang-scala-docs_2.12 3.4.1 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

# ReadStream 

###
Companion object ReadStream

#### trait ReadStream[T] extends StreamBase

Represents a stream of items that can be read from.

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

Linear Supertypes
StreamBase, AnyRef, Any
Known Subclasses
TimeoutStream, DatagramSocket, MessageConsumer, AsyncFile, HttpClientRequest, HttpClientResponse, HttpServerFileUpload, HttpServerRequest, ServerWebSocket, WebSocket, WebSocketBase, NetSocket, SQLRowStream, SockJSSocket, KafkaConsumer
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. ReadStream
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
     ReadStream → StreamBase
2.  abstract def endHandler(endHandler: Handler[Unit]): ReadStream[T]

   Set an end handler.

   Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

   returns

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

3.  abstract def exceptionHandler(handler: Handler[Throwable]): ReadStream[T]

   Set an exception handler on the read stream.

   Set an exception handler on the read stream.

   handler

     the exception handler

   returns

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

   Definition Classes
     ReadStream → StreamBase
4.  abstract def handler(handler: Handler[T]): ReadStream[T]

   Set a data handler.

   Set a data handler. As data is read, the handler will be called with the data.

   returns

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

5.  abstract def pause(): ReadStream[T]

   Pause the `ReadSupport`.

   Pause the `ReadSupport`. While it's paused, no data will be sent to the `dataHandler`

   returns

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

6.  abstract def resume(): ReadStream[T]

   Resume reading.

   Resume reading. If the `ReadSupport` has been paused, reading will recommence on it.

   returns

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

### 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 StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped