Package io.vertx.reactivex.grpc.client
Class GrpcClientResponse<Req,Resp>
- java.lang.Object
-
- io.vertx.reactivex.grpc.common.GrpcReadStream<Resp>
-
- io.vertx.reactivex.grpc.client.GrpcClientResponse<Req,Resp>
-
- All Implemented Interfaces:
ReadStream<Resp>
,StreamBase
public class GrpcClientResponse<Req,Resp> extends GrpcReadStream<Resp>
A response from a gRPC server. You can set amessageHandler(io.vertx.core.Handler<io.vertx.reactivex.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 theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<GrpcClientResponse>
__TYPE_ARG
TypeArg<Req>
__typeArg_0
TypeArg<Resp>
__typeArg_1
-
Constructor Summary
Constructors Constructor Description GrpcClientResponse(GrpcClientResponse delegate)
GrpcClientResponse(Object delegate, TypeArg<Req> typeArg_0, TypeArg<Resp> typeArg_1)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <R,A>
Future<R>collecting(Collector<Resp,A,R> collector)
GrpcClientResponse<Req,Resp>
endHandler(Handler<Void> handler)
Set an end handler.boolean
equals(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 specifiedamount
of elements.GrpcClientResponse
getDelegate()
GrpcClientResponse<Req,Resp>
handler(Handler<Resp> handler)
Set a data handler.int
hashCode()
Future<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, TypeArg<Req> __typeArg_Req, TypeArg<Resp> __typeArg_Resp)
GrpcClientResponse<Req,Resp>
pause()
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.Pipe<Resp>
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .void
pipeTo(WriteStream<Resp> dst)
Pipe thisReadStream
to theWriteStream
.void
pipeTo(WriteStream<Resp> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.GrpcClientResponse<Req,Resp>
resume()
Resume reading, and sets the buffer inflowing
mode.<R,A>
io.reactivex.Single<R>rxCollecting(Collector<Resp,A,R> collector)
io.reactivex.Single<Resp>
rxLast()
io.reactivex.Completable
rxPipeTo(WriteStream<Resp> dst)
Pipe thisReadStream
to theWriteStream
.GrpcStatus
status()
String
statusMessage()
io.reactivex.Flowable<Resp>
toFlowable()
io.reactivex.Observable<Resp>
toObservable()
String
toString()
MultiMap
trailers()
-
Methods inherited from class io.vertx.reactivex.grpc.common.GrpcReadStream
encoding, end, headers, newInstance, newInstance, rxEnd
-
-
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toString
in classGrpcReadStream<Resp>
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classGrpcReadStream<Resp>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classGrpcReadStream<Resp>
-
getDelegate
public GrpcClientResponse getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Req>
- Specified by:
getDelegate
in interfaceStreamBase
- Overrides:
getDelegate
in classGrpcReadStream<Resp>
-
toObservable
public io.reactivex.Observable<Resp> toObservable()
- Specified by:
toObservable
in interfaceReadStream<Req>
- Overrides:
toObservable
in classGrpcReadStream<Resp>
-
toFlowable
public io.reactivex.Flowable<Resp> toFlowable()
- Specified by:
toFlowable
in interfaceReadStream<Req>
- Overrides:
toFlowable
in 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:
pipe
in interfaceReadStream<Req>
- Overrides:
pipe
in classGrpcReadStream<Resp>
- Returns:
- a pipe
-
pipeTo
public void pipeTo(WriteStream<Resp> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
pipeTo
in interfaceReadStream<Req>
- Overrides:
pipeTo
in classGrpcReadStream<Resp>
- Parameters:
dst
- the destination write streamhandler
-
-
pipeTo
public void pipeTo(WriteStream<Resp> dst)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
pipeTo
in interfaceReadStream<Req>
- Overrides:
pipeTo
in classGrpcReadStream<Resp>
- Parameters:
dst
- the destination write stream
-
rxPipeTo
public io.reactivex.Completable rxPipeTo(WriteStream<Resp> dst)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
rxPipeTo
in interfaceReadStream<Req>
- Overrides:
rxPipeTo
in classGrpcReadStream<Resp>
- Parameters:
dst
- the destination write stream- Returns:
-
last
public Future<Resp> last()
- Overrides:
last
in classGrpcReadStream<Resp>
- Returns:
- the last element of the stream
-
rxLast
public io.reactivex.Single<Resp> rxLast()
- Overrides:
rxLast
in classGrpcReadStream<Resp>
- Returns:
- the last element of the stream
-
status
public GrpcStatus status()
- Returns:
- the gRPC status or
null
when the status has not yet been received
-
statusMessage
public String statusMessage()
- Returns:
- the gRPC status message of
null
when 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:GrpcReadStream
Set a handler to be notified with incoming encoded messages. Thehandler
is responsible for fully decoding incoming messages, including compression.- Overrides:
messageHandler
in 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:GrpcReadStream
Set a handler to be notified with gRPC errors.- Overrides:
errorHandler
in 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:ReadStream
Set an exception handler on the read stream.- Specified by:
exceptionHandler
in interfaceReadStream<Req>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Overrides:
exceptionHandler
in 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:ReadStream
Set a data handler. As data is read, the handler will be called with the data.- Specified by:
handler
in interfaceReadStream<Req>
- Overrides:
handler
in 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:ReadStream
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandler
in interfaceReadStream<Req>
- Overrides:
endHandler
in classGrpcReadStream<Resp>
- Returns:
- a reference to this, so the API can be used fluently
-
pause
public GrpcClientResponse<Req,Resp> pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<Req>
- Overrides:
pause
in classGrpcReadStream<Resp>
- Returns:
- a reference to this, so the API can be used fluently
-
resume
public GrpcClientResponse<Req,Resp> resume()
Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<Req>
- Overrides:
resume
in 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:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<Req>
- Overrides:
fetch
in classGrpcReadStream<Resp>
- Returns:
- a reference to this, so the API can be used fluently
-
collecting
public <R,A> Future<R> collecting(Collector<Resp,A,R> collector)
- Overrides:
collecting
in classGrpcReadStream<Resp>
- Parameters:
collector
-- Returns:
- the result of applying a collector on the stream
-
rxCollecting
public <R,A> io.reactivex.Single<R> rxCollecting(Collector<Resp,A,R> collector)
- Overrides:
rxCollecting
in classGrpcReadStream<Resp>
- Parameters:
collector
-- Returns:
- the result of applying a collector on the stream
-
newInstance
public static <Req,Resp> GrpcClientResponse<Req,Resp> newInstance(GrpcClientResponse arg)
-
newInstance
public static <Req,Resp> GrpcClientResponse<Req,Resp> newInstance(GrpcClientResponse arg, TypeArg<Req> __typeArg_Req, TypeArg<Resp> __typeArg_Resp)
-
-