io.vertx.grpc.common

Interface GrpcReadStream<T>

All Superinterfaces:

io.vertx.core.streams.ReadStream<T>, io.vertx.core.streams.StreamBase

public interface GrpcReadStream<T>
extends io.vertx.core.streams.ReadStream<T>

Method Summary

Modifier and Type	Method and Description
default <R,A> io.vertx.core.Future<R>	collecting(Collector<T,A,R> collector) Deprecated. instead use ReadStream.collect(Collector)
String	encoding()
io.vertx.core.Future<Void>	end()
GrpcReadStream<T>	endHandler(io.vertx.core.Handler<Void> handler)
GrpcReadStream<T>	errorHandler(io.vertx.core.Handler<GrpcError> handler) Set a handler to be notified with gRPC errors.
GrpcReadStream<T>	exceptionHandler(io.vertx.core.Handler<Throwable> handler)
GrpcReadStream<T>	fetch(long l)
GrpcReadStream<T>	handler(io.vertx.core.Handler<T> handler)
io.vertx.core.MultiMap	headers()
GrpcReadStream<T>	invalidMessageHandler(io.vertx.core.Handler<InvalidMessageException> handler) Set a message handler that is reported with invalid message errors.
io.vertx.core.Future<T>	last()
GrpcReadStream<T>	messageHandler(io.vertx.core.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

collect, pipe, pipeTo, pipeTo

Method Detail

headers

io.vertx.core.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(io.vertx.core.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

invalidMessageHandler

GrpcReadStream<T> invalidMessageHandler(io.vertx.core.Handler<InvalidMessageException> handler)

Set a message handler that is reported with invalid message errors.

Warning: setting this handler overwrite the default handler which takes appropriate measure when an invalid message is encountered such as cancelling the stream. This handler should be set when control over invalid messages is required.

Parameters:

handler - the invalid message handler

Returns:

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

errorHandler

GrpcReadStream<T> errorHandler(io.vertx.core.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(io.vertx.core.Handler<Throwable> handler)

Specified by:

exceptionHandler in interface io.vertx.core.streams.ReadStream<T>

Specified by:

exceptionHandler in interface io.vertx.core.streams.StreamBase

handler

GrpcReadStream<T> handler(io.vertx.core.Handler<T> handler)

Specified by:

handler in interface io.vertx.core.streams.ReadStream<T>

pause

GrpcReadStream<T> pause()

Specified by:

pause in interface io.vertx.core.streams.ReadStream<T>

resume

GrpcReadStream<T> resume()

Specified by:

resume in interface io.vertx.core.streams.ReadStream<T>

fetch

GrpcReadStream<T> fetch(long l)

Specified by:

fetch in interface io.vertx.core.streams.ReadStream<T>

endHandler

GrpcReadStream<T> endHandler(io.vertx.core.Handler<Void> handler)

Specified by:

endHandler in interface io.vertx.core.streams.ReadStream<T>

last

io.vertx.core.Future<T> last()

Returns:

the last element of the stream

end

io.vertx.core.Future<Void> end()

Returns:

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

collecting

@Deprecated
default <R,A> io.vertx.core.Future<R> collecting(Collector<T,A,R> collector)

Deprecated. instead use ReadStream.collect(Collector)

Returns:

the result of applying a collector on the stream