Package io.vertx.rxjava3.grpc.client
Class GrpcClientResponse<Req,Resp>
- java.lang.Object
-
- io.vertx.rxjava3.grpc.common.GrpcReadStream<Resp>
-
- io.vertx.rxjava3.grpc.client.GrpcClientResponse<Req,Resp>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<Resp>,StreamBase
public class GrpcClientResponse<Req,Resp> extends GrpcReadStream<Resp> implements io.vertx.lang.rx.RxDelegate
A response from a gRPC server. You can set amessageHandler(io.vertx.core.Handler<io.vertx.grpc.common.GrpcMessage>)to receive and aendHandler(io.vertx.core.Handler<java.lang.Void>)to be notified of the end of the response.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<GrpcClientResponse>__TYPE_ARGio.vertx.lang.rx.TypeArg<Req>__typeArg_0io.vertx.lang.rx.TypeArg<Resp>__typeArg_1
-
Constructor Summary
Constructors Constructor Description GrpcClientResponse(GrpcClientResponse delegate)GrpcClientResponse(Object delegate, io.vertx.lang.rx.TypeArg<Req> typeArg_0, io.vertx.lang.rx.TypeArg<Resp> typeArg_1)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GrpcClientResponse<Req,Resp>endHandler(Handler<Void> handler)Set an end handler.booleanequals(Object o)GrpcClientResponse<Req,Resp>errorHandler(Handler<GrpcError> handler)Set a handler to be notified with gRPC errors.GrpcClientResponse<Req,Resp>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.GrpcClientResponse<Req,Resp>fetch(long amount)Fetch the specifiedamountof elements.GrpcClientResponsegetDelegate()GrpcClientResponse<Req,Resp>handler(Handler<Resp> handler)Set a data handler.inthashCode()GrpcReadStream<Resp>invalidMessageHandler(Handler<InvalidMessageException> handler)Set a message handler that is reported with invalid message errors.Single<Resp>last()GrpcClientResponse<Req,Resp>messageHandler(Handler<GrpcMessage> handler)Set a handler to be notified with incoming encoded messages.static <Req,Resp>
GrpcClientResponse<Req,Resp>newInstance(GrpcClientResponse arg)static <Req,Resp>
GrpcClientResponse<Req,Resp>newInstance(GrpcClientResponse arg, io.vertx.lang.rx.TypeArg<Req> __typeArg_Req, io.vertx.lang.rx.TypeArg<Resp> __typeArg_Resp)GrpcClientResponse<Req,Resp>pause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<Resp>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .CompletablepipeTo(WriteStream<Resp> dst)Pipe thisReadStreamto theWriteStream.GrpcClientResponse<Req,Resp>resume()Resume reading, and sets the buffer inflowingmode.Single<Resp>rxLast()CompletablerxPipeTo(WriteStream<Resp> dst)Pipe thisReadStreamto theWriteStream.GrpcStatusstatus()StringstatusMessage()Flowable<Resp>toFlowable()Observable<Resp>toObservable()StringtoString()MultiMaptrailers()-
Methods inherited from class io.vertx.rxjava3.grpc.common.GrpcReadStream
encoding, end, format, headers, newInstance, newInstance, rxEnd
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<GrpcClientResponse> __TYPE_ARG
-
__typeArg_0
public final io.vertx.lang.rx.TypeArg<Req> __typeArg_0
-
__typeArg_1
public final io.vertx.lang.rx.TypeArg<Resp> __typeArg_1
-
-
Constructor Detail
-
GrpcClientResponse
public GrpcClientResponse(GrpcClientResponse delegate)
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toStringin classGrpcReadStream<Resp>
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classGrpcReadStream<Resp>
-
hashCode
public int hashCode()
- Overrides:
hashCodein classGrpcReadStream<Resp>
-
getDelegate
public GrpcClientResponse getDelegate()
- Specified by:
getDelegatein interfaceReadStream<Req>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Overrides:
getDelegatein classGrpcReadStream<Resp>
-
toObservable
public Observable<Resp> toObservable()
- Specified by:
toObservablein interfaceReadStream<Req>- Overrides:
toObservablein classGrpcReadStream<Resp>
-
toFlowable
public Flowable<Resp> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<Req>- Overrides:
toFlowablein classGrpcReadStream<Resp>
-
pipe
public Pipe<Resp> 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<Req>- Overrides:
pipein classGrpcReadStream<Resp>- Returns:
- a pipe
-
pipeTo
public Completable pipeTo(WriteStream<Resp> 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<Req>- Overrides:
pipeToin classGrpcReadStream<Resp>- 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<Resp> 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<Req>- Overrides:
rxPipeToin classGrpcReadStream<Resp>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
last
public Single<Resp> last()
- Overrides:
lastin classGrpcReadStream<Resp>- Returns:
- the last element of the stream
-
rxLast
public Single<Resp> rxLast()
- Overrides:
rxLastin classGrpcReadStream<Resp>- Returns:
- the last element of the stream
-
status
public GrpcStatus status()
- Returns:
- the gRPC status or
nullwhen the status has not yet been received
-
statusMessage
public String statusMessage()
- Returns:
- the gRPC status message of
nullwhen the status has not yet been received or not transmitted
-
trailers
public MultiMap trailers()
- Returns:
- the to write metadata trailers
-
messageHandler
public GrpcClientResponse<Req,Resp> messageHandler(Handler<GrpcMessage> handler)
Description copied from class:GrpcReadStreamSet a handler to be notified with incoming encoded messages. Thehandleris responsible for fully decoding incoming messages, including compression.- Overrides:
messageHandlerin classGrpcReadStream<Resp>- Parameters:
handler- the message handler- Returns:
- a reference to this, so the API can be used fluently
-
errorHandler
public GrpcClientResponse<Req,Resp> errorHandler(Handler<GrpcError> handler)
Description copied from class:GrpcReadStreamSet a handler to be notified with gRPC errors.- Overrides:
errorHandlerin classGrpcReadStream<Resp>- Parameters:
handler- the error handler- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public GrpcClientResponse<Req,Resp> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Req>- Specified by:
exceptionHandlerin interfaceStreamBase- Overrides:
exceptionHandlerin classGrpcReadStream<Resp>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public GrpcClientResponse<Req,Resp> handler(Handler<Resp> 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<Req>- Overrides:
handlerin classGrpcReadStream<Resp>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public GrpcClientResponse<Req,Resp> 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<Req>- Overrides:
endHandlerin classGrpcReadStream<Resp>- Returns:
- a reference to this, so the API can be used fluently
-
pause
public GrpcClientResponse<Req,Resp> 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<Req>- Overrides:
pausein classGrpcReadStream<Resp>- Returns:
- a reference to this, so the API can be used fluently
-
resume
public GrpcClientResponse<Req,Resp> 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<Req>- Overrides:
resumein classGrpcReadStream<Resp>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public GrpcClientResponse<Req,Resp> fetch(long amount)
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<Req>- Overrides:
fetchin classGrpcReadStream<Resp>- Returns:
- a reference to this, so the API can be used fluently
-
invalidMessageHandler
public GrpcReadStream<Resp> 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.
- Overrides:
invalidMessageHandlerin classGrpcReadStream<Resp>- Parameters:
handler- the invalid message handler- Returns:
- a reference to this, so the API can be used fluently
-
newInstance
public static <Req,Resp> GrpcClientResponse<Req,Resp> newInstance(GrpcClientResponse arg)
-
newInstance
public static <Req,Resp> GrpcClientResponse<Req,Resp> newInstance(GrpcClientResponse arg, io.vertx.lang.rx.TypeArg<Req> __typeArg_Req, io.vertx.lang.rx.TypeArg<Resp> __typeArg_Resp)
-
-