Package io.vertx.grpc.common
Interface GrpcReadStream<T>
-
- All Superinterfaces:
ReadStream<T>,StreamBase
- All Known Subinterfaces:
GrpcClientResponse<Req,Resp>,GrpcServerRequest<Req,Resp>
public interface GrpcReadStream<T> extends ReadStream<T>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Stringencoding()Future<Void>end()GrpcReadStream<T>endHandler(Handler<Void> handler)Set an end handler.GrpcReadStream<T>errorHandler(Handler<GrpcError> handler)Set a handler to be notified with gRPC errors.GrpcReadStream<T>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.GrpcReadStream<T>fetch(long l)Fetch the specifiedamountof elements.WireFormatformat()GrpcReadStream<T>handler(Handler<T> handler)Set a data handler.MultiMapheaders()GrpcReadStream<T>invalidMessageHandler(Handler<InvalidMessageException> handler)Set a message handler that is reported with invalid message errors.Future<T>last()GrpcReadStream<T>messageHandler(Handler<GrpcMessage> handler)Set a handler to be notified with incoming encoded messages.GrpcReadStream<T>pause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.GrpcReadStream<T>resume()Resume reading, and sets the buffer inflowingmode.-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
-
-
-
Method Detail
-
encoding
String encoding()
- Returns:
- the stream encoding, e.g.
identityorgzip
-
format
WireFormat format()
- Returns:
- the message format, e.g.
protoorjson
-
messageHandler
GrpcReadStream<T> messageHandler(Handler<GrpcMessage> handler)
Set a handler to be notified with incoming encoded messages. Thehandleris 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(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(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)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<T>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
GrpcReadStream<T> handler(Handler<T> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
pause
GrpcReadStream<T> pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
resume
GrpcReadStream<T> resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
GrpcReadStream<T> fetch(long l)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
GrpcReadStream<T> endHandler(Handler<Void> handler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
-