Class GrpcServerResponse<Req,Resp>
- java.lang.Object
-
- io.vertx.rxjava3.grpc.common.GrpcWriteStream<Resp>
-
- io.vertx.rxjava3.grpc.server.GrpcServerResponse<Req,Resp>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,StreamBase,WriteStream<Resp>
public class GrpcServerResponse<Req,Resp> extends GrpcWriteStream<Resp> implements io.vertx.lang.rx.RxDelegate
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<GrpcServerResponse>__TYPE_ARGio.vertx.lang.rx.TypeArg<Req>__typeArg_0io.vertx.lang.rx.TypeArg<Resp>__typeArg_1
-
Constructor Summary
Constructors Constructor Description GrpcServerResponse(GrpcServerResponse delegate)GrpcServerResponse(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 GrpcServerResponse<Req,Resp>drainHandler(Handler<Void> handler)Set a drain handler on the stream.GrpcServerResponse<Req,Resp>encoding(String encoding)Set the stream encoding, e.g.Completableend()Ends the stream.Completableend(Resp data)Same asWriteStream.end()but writes some data to the stream before ending.booleanequals(Object o)GrpcServerResponse<Req,Resp>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the write stream.voidfail(Throwable failure)End the stream with an appropriate status message, whenfailureisStatusException, set status toStatusExceptionand status message toStatusExceptionUnsupportedOperationExceptionreturns otherwise returnsGrpcServerResponse<Req,Resp>format(WireFormat format)Set the stream format, e.g.GrpcServerResponsegetDelegate()inthashCode()static <Req,Resp>
GrpcServerResponse<Req,Resp>newInstance(GrpcServerResponse arg)static <Req,Resp>
GrpcServerResponse<Req,Resp>newInstance(GrpcServerResponse arg, io.vertx.lang.rx.TypeArg<Req> __typeArg_Req, io.vertx.lang.rx.TypeArg<Resp> __typeArg_Resp)CompletablerxEnd()Ends the stream.CompletablerxEnd(Resp data)Same asWriteStream.end()but writes some data to the stream before ending.CompletablerxSend(Flowable<Resp> body)CompletablerxSend(Resp item)CompletablerxWrite(Resp data)Write some data to the stream.Completablesend(Flowable<Resp> body)Completablesend(Resp item)GrpcServerResponse<Req,Resp>setWriteQueueMaxSize(int maxSize)Set the maximum size of the write queue tomaxSize.GrpcServerResponse<Req,Resp>status(GrpcStatus status)Set the grpc status responseGrpcServerResponse<Req,Resp>statusMessage(String msg)Set the grpc status response messageWriteStreamObserver<Resp>toObserver()StringtoString()WriteStreamSubscriber<Resp>toSubscriber()MultiMaptrailers()Completablewrite(Resp data)Write some data to the stream.booleanwriteQueueFull()This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)-
Methods inherited from class io.vertx.rxjava3.grpc.common.GrpcWriteStream
cancel, endMessage, headers, newInstance, newInstance, rxEndMessage, rxWriteMessage, writeMessage
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<GrpcServerResponse> __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
-
GrpcServerResponse
public GrpcServerResponse(GrpcServerResponse delegate)
-
-
Method Detail
-
toString
public String toString()
- Overrides:
toStringin classGrpcWriteStream<Resp>
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classGrpcWriteStream<Resp>
-
hashCode
public int hashCode()
- Overrides:
hashCodein classGrpcWriteStream<Resp>
-
getDelegate
public GrpcServerResponse getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Specified by:
getDelegatein interfaceWriteStream<Req>- Overrides:
getDelegatein classGrpcWriteStream<Resp>
-
toObserver
public WriteStreamObserver<Resp> toObserver()
- Specified by:
toObserverin interfaceWriteStream<Req>- Overrides:
toObserverin classGrpcWriteStream<Resp>
-
toSubscriber
public WriteStreamSubscriber<Resp> toSubscriber()
- Specified by:
toSubscriberin interfaceWriteStream<Req>- Overrides:
toSubscriberin classGrpcWriteStream<Resp>
-
write
public Completable write(Resp data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
writein interfaceWriteStream<Req>- Overrides:
writein classGrpcWriteStream<Resp>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
rxWrite
public Completable rxWrite(Resp data)
Write some data to the stream.The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the
WriteStream.writeQueueFull()method before writing. This is done automatically if using a .When the
datais moved from the queue to the actual medium, the returned will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.- Specified by:
rxWritein interfaceWriteStream<Req>- Overrides:
rxWritein classGrpcWriteStream<Resp>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
end
public Completable end()
Ends the stream.Once the stream has ended, it cannot be used any more.
- Specified by:
endin interfaceWriteStream<Req>- Overrides:
endin classGrpcWriteStream<Resp>- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd()
Ends the stream.Once the stream has ended, it cannot be used any more.
- Specified by:
rxEndin interfaceWriteStream<Req>- Overrides:
rxEndin classGrpcWriteStream<Resp>- Returns:
- a future completed with the result
-
end
public Completable end(Resp data)
Same asWriteStream.end()but writes some data to the stream before ending.- Specified by:
endin interfaceWriteStream<Req>- Overrides:
endin classGrpcWriteStream<Resp>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd(Resp data)
Same asWriteStream.end()but writes some data to the stream before ending.- Specified by:
rxEndin interfaceWriteStream<Req>- Overrides:
rxEndin classGrpcWriteStream<Resp>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
writeQueueFull
public boolean writeQueueFull()
This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)- Specified by:
writeQueueFullin interfaceWriteStream<Req>- Overrides:
writeQueueFullin classGrpcWriteStream<Resp>- Returns:
trueif write queue is full
-
status
public GrpcServerResponse<Req,Resp> status(GrpcStatus status)
Set the grpc status response- Parameters:
status- the status- Returns:
- a reference to this, so the API can be used fluently
-
statusMessage
public GrpcServerResponse<Req,Resp> statusMessage(String msg)
Set the grpc status response message- Parameters:
msg- the message- Returns:
- a reference to this, so the API can be used fluently
-
encoding
public GrpcServerResponse<Req,Resp> encoding(String encoding)
Description copied from class:GrpcWriteStreamSet the stream encoding, e.g.identityorgzip. It must be called before sending any message, otherwiseidentitywill be used.- Overrides:
encodingin classGrpcWriteStream<Resp>- Parameters:
encoding- the target message encoding- Returns:
- a reference to this, so the API can be used fluently
-
format
public GrpcServerResponse<Req,Resp> format(WireFormat format)
Description copied from class:GrpcWriteStreamSet the stream format, e.g.protoorjson. It must be called before sending any message, otherwiseprotowill be used.- Overrides:
formatin classGrpcWriteStream<Resp>- Parameters:
format- the message format- Returns:
- a reference to this, so the API can be used fluently
-
trailers
public MultiMap trailers()
- Returns:
- the to write metadata trailers
-
exceptionHandler
public GrpcServerResponse<Req,Resp> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:WriteStreamSet an exception handler on the write stream.- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWriteStream<Req>- Overrides:
exceptionHandlerin classGrpcWriteStream<Resp>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
public GrpcServerResponse<Req,Resp> setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStreamSet the maximum size of the write queue tomaxSize. You will still be able to write to the stream even if there is more thanmaxSizeitems in the write queue. This is used as an indicator by classes such asPipeto provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket, etc...- Specified by:
setWriteQueueMaxSizein interfaceWriteStream<Req>- Overrides:
setWriteQueueMaxSizein classGrpcWriteStream<Resp>- Parameters:
maxSize- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public GrpcServerResponse<Req,Resp> drainHandler(Handler<Void> handler)
Description copied from interface:WriteStreamSet a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. SeePipefor an example of this being used.The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to
maxSize / 2.- Specified by:
drainHandlerin interfaceWriteStream<Req>- Overrides:
drainHandlerin classGrpcWriteStream<Resp>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
send
public Completable send(Resp item)
-
rxSend
public Completable rxSend(Resp item)
-
send
public Completable send(Flowable<Resp> body)
-
rxSend
public Completable rxSend(Flowable<Resp> body)
-
fail
public void fail(Throwable failure)
End the stream with an appropriate status message, whenfailureisStatusException, set status toStatusExceptionand status message toStatusExceptionUnsupportedOperationExceptionreturns- otherwise returns
- Parameters:
failure- the failure
-
newInstance
public static <Req,Resp> GrpcServerResponse<Req,Resp> newInstance(GrpcServerResponse arg)
-
newInstance
public static <Req,Resp> GrpcServerResponse<Req,Resp> newInstance(GrpcServerResponse arg, io.vertx.lang.rx.TypeArg<Req> __typeArg_Req, io.vertx.lang.rx.TypeArg<Resp> __typeArg_Resp)
-
-