io.vertx.grpc.common

Interface GrpcReadStream<T>

All Superinterfaces:

ReadStream<T>, StreamBase

public interface GrpcReadStream<T>
extends ReadStream<T>

Method Summary

Modifier and Type	Method and Description
<R,A> Future<R>	collecting(Collector<T,A,R> collector)
String	encoding()
Future<Void>	end()
GrpcReadStream<T>	endHandler(Handler<Void> handler)
GrpcReadStream<T>	errorHandler(Handler<GrpcError> handler) Set a handler to be notified with gRPC errors.
GrpcReadStream<T>	exceptionHandler(Handler<Throwable> handler)
GrpcReadStream<T>	fetch(long l)
GrpcReadStream<T>	handler(Handler<T> handler)
MultiMap	headers()
Future<T>	last()
GrpcReadStream<T>	messageHandler(Handler<GrpcMessage> handler) Set a handler to be notified with incoming encoded messages.
GrpcReadStream<T>	pause()
GrpcReadStream<T>	resume()

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

pipe, pipeTo, pipeTo

Method Detail

headers

MultiMap headers()

Returns:

the MultiMap to read metadata headers

encoding

String encoding()

Returns:

the stream encoding, e.g identity or gzip

messageHandler

GrpcReadStream<T> messageHandler(Handler<GrpcMessage> handler)

Set a handler to be notified with incoming encoded messages. The handler is responsible for fully decoding incoming messages, including compression.

Parameters:

handler - the message handler

Returns:

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

errorHandler

GrpcReadStream<T> errorHandler(Handler<GrpcError> handler)

Set a handler to be notified with gRPC errors.

Parameters:

handler - the error handler

Returns:

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

exceptionHandler

GrpcReadStream<T> exceptionHandler(Handler<Throwable> handler)

Specified by:

exceptionHandler in interface ReadStream<T>

Specified by:

exceptionHandler in interface StreamBase

handler

GrpcReadStream<T> handler(Handler<T> handler)

Specified by:

handler in interface ReadStream<T>

pause

GrpcReadStream<T> pause()

Specified by:

pause in interface ReadStream<T>

resume

GrpcReadStream<T> resume()

Specified by:

resume in interface ReadStream<T>

fetch

GrpcReadStream<T> fetch(long l)

Specified by:

fetch in interface ReadStream<T>

endHandler

GrpcReadStream<T> endHandler(Handler<Void> handler)

Specified by:

endHandler in interface ReadStream<T>

last

Future<T> last()

Returns:

the last element of the stream

end

Future<Void> end()

Returns:

a future signaling when the response has been fully received successfully or failed

collecting

<R,A> Future<R> collecting(Collector<T,A,R> collector)

Returns:

the result of applying a collector on the stream