Package io.vertx.rxjava3.grpc.common
Class GrpcReadStream<T>
- java.lang.Object
-
- io.vertx.rxjava3.grpc.common.GrpcReadStream<T>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<T>,StreamBase
- Direct Known Subclasses:
GrpcClientResponse,GrpcServerRequest
public class GrpcReadStream<T> extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<T>
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<GrpcReadStream>__TYPE_ARGio.vertx.lang.rx.TypeArg<T>__typeArg_0
-
Constructor Summary
Constructors Constructor Description GrpcReadStream(GrpcReadStream delegate)GrpcReadStream(Object delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringencoding()Completableend()GrpcReadStream<T>endHandler(Handler<Void> handler)Set an end handler.booleanequals(Object o)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()GrpcReadStreamgetDelegate()GrpcReadStream<T>handler(Handler<T> handler)Set a data handler.inthashCode()MultiMapheaders()GrpcReadStream<T>invalidMessageHandler(Handler<InvalidMessageException> handler)Set a message handler that is reported with invalid message errors.Single<T>last()GrpcReadStream<T>messageHandler(Handler<GrpcMessage> handler)Set a handler to be notified with incoming encoded messages.static <T> GrpcReadStream<T>newInstance(GrpcReadStream arg)static <T> GrpcReadStream<T>newInstance(GrpcReadStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)GrpcReadStream<T>pause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<T>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .CompletablepipeTo(WriteStream<T> dst)Pipe thisReadStreamto theWriteStream.GrpcReadStream<T>resume()Resume reading, and sets the buffer inflowingmode.CompletablerxEnd()Single<T>rxLast()CompletablerxPipeTo(WriteStream<T> dst)Pipe thisReadStreamto theWriteStream.Flowable<T>toFlowable()Observable<T>toObservable()StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<GrpcReadStream> __TYPE_ARG
-
__typeArg_0
public final io.vertx.lang.rx.TypeArg<T> __typeArg_0
-
-
Constructor Detail
-
GrpcReadStream
public GrpcReadStream(GrpcReadStream delegate)
-
-
Method Detail
-
getDelegate
public GrpcReadStream getDelegate()
- Specified by:
getDelegatein interfaceReadStream<T>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<T> toObservable()
- Specified by:
toObservablein interfaceReadStream<T>
-
toFlowable
public Flowable<T> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<T>
-
pipe
public Pipe<T> pipe()
Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream.- Specified by:
pipein interfaceReadStream<T>- Returns:
- a pipe
-
pipeTo
public Completable pipeTo(WriteStream<T> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<T>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<T> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<T>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
headers
public MultiMap headers()
- Returns:
- the to read metadata headers
-
encoding
public String encoding()
- Returns:
- the stream encoding, e.g.
identityorgzip
-
format
public WireFormat format()
- Returns:
- the message format, e.g.
protoorjson
-
messageHandler
public 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
-
errorHandler
public 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
public 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
public 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
public 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
public 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
public 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
public 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
-
end
public Completable end()
- Returns:
- a future signaling when the response has been fully received successfully or failed
-
rxEnd
public Completable rxEnd()
- Returns:
- a future signaling when the response has been fully received successfully or failed
-
invalidMessageHandler
public 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
-
newInstance
public static <T> GrpcReadStream<T> newInstance(GrpcReadStream arg)
-
newInstance
public static <T> GrpcReadStream<T> newInstance(GrpcReadStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)
-
-