SearchReadStream (georocket-client-api 1.4.0-SNAPSHOT API)

java.lang.Object
- io.georocket.client.SearchReadStream

All Implemented Interfaces:
io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>, io.vertx.core.streams.StreamBase
```
public class SearchReadStream
extends java.lang.Object
implements io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
```
A read stream from which merged chunks can be read
Since:
1.3.0
Author:
Michel Kraemer

Constructor Summary
Constructors
Constructor and Description
SearchReadStream(io.vertx.core.http.HttpClientResponse delegate)
Create a new read stream

Constructors
Constructor and Description
`SearchReadStream(io.vertx.core.http.HttpClientResponse delegate)` Create a new read stream

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchReadStream`	`endHandler(io.vertx.core.Handler<java.lang.Void> endHandler)`
`SearchReadStream`	`endHandlerWithResult(io.vertx.core.Handler<SearchReadStreamResult> endHandler)` Set an end handler.
`SearchReadStream`	`exceptionHandler(io.vertx.core.Handler<java.lang.Throwable> handler)`
`io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>`	`fetch(long amount)`
`SearchReadStreamResult`	`getResult()` Get a result object that contains information only available after the stream has ended.
`SearchReadStream`	`handler(io.vertx.core.Handler<io.vertx.core.buffer.Buffer> handler)`
`SearchReadStream`	`pause()`
`SearchReadStream`	`resume()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.core.streams.ReadStream
pipe, pipeTo, pipeTo

- Constructor Detail
  - SearchReadStream
```
public SearchReadStream(io.vertx.core.http.HttpClientResponse delegate)
```
    Create a new read stream
    Parameters:
    delegate - the actual read stream to delegate to
- Method Detail
  - exceptionHandler
```
public SearchReadStream exceptionHandler(io.vertx.core.Handler<java.lang.Throwable> handler)
```
    Specified by:
    exceptionHandler in interface io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
    Specified by:
    exceptionHandler in interface io.vertx.core.streams.StreamBase
  - handler
```
public SearchReadStream handler(io.vertx.core.Handler<io.vertx.core.buffer.Buffer> handler)
```
    Specified by:
    handler in interface io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
  - pause
```
public SearchReadStream pause()
```
    Specified by:
    pause in interface io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
  - resume
```
public SearchReadStream resume()
```
    Specified by:
    resume in interface io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
  - fetch
```
public io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer> fetch(long amount)
```
    Specified by:
    fetch in interface io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
  - endHandler
```
public SearchReadStream endHandler(io.vertx.core.Handler<java.lang.Void> endHandler)
```
    Specified by:
    endHandler in interface io.vertx.core.streams.ReadStream<io.vertx.core.buffer.Buffer>
  - endHandlerWithResult
```
public SearchReadStream endHandlerWithResult(io.vertx.core.Handler<SearchReadStreamResult> endHandler)
```
    Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called. The handler will receive a result object with information that is only available after the stream has ended.
    Parameters:
    endHandler - the handler to call
    Returns:
    a reference to this, so the API can be used fluently
  - getResult
```
public SearchReadStreamResult getResult()
```
    Get a result object that contains information only available after the stream has ended. The method will return null until the end of the stream has been reached.
    Returns:
    the result object
    Since:
    1.4.0

Class SearchReadStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.core.streams.ReadStream

Constructor Detail

SearchReadStream

Method Detail

exceptionHandler

handler

pause

resume

fetch

endHandler

endHandlerWithResult

getResult