Class GrpcServerResponse<Req,Resp>
- java.lang.Object
-
- io.vertx.reactivex.grpc.common.GrpcWriteStream<Resp>
-
- io.vertx.reactivex.grpc.server.GrpcServerResponse<Req,Resp>
-
- All Implemented Interfaces:
StreamBase
,WriteStream<Resp>
public class GrpcServerResponse<Req,Resp> extends GrpcWriteStream<Resp>
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<GrpcServerResponse>
__TYPE_ARG
io.vertx.lang.rx.TypeArg<Req>
__typeArg_0
io.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.Future<Void>
end()
Ends the stream.Future<Void>
end(Resp data)
Same asWriteStream.end()
but writes some data to the stream before ending.boolean
equals(Object o)
GrpcServerResponse<Req,Resp>
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.GrpcWriteStream<Resp>
format(WireFormat format)
Set the stream format, e.g.GrpcServerResponse
getDelegate()
int
hashCode()
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)
Completable
rxEnd()
Ends the stream.Completable
rxEnd(Resp data)
Same asWriteStream.end()
but writes some data to the stream before ending.Completable
rxSend(Flowable<Resp> body)
Completable
rxSend(ReadStream<Resp> body)
Completable
rxSend(Resp item)
Completable
rxWrite(Resp data)
Write some data to the stream.Future<Void>
send(Flowable<Resp> body)
Future<Void>
send(ReadStream<Resp> body)
Future<Void>
send(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()
String
toString()
WriteStreamSubscriber<Resp>
toSubscriber()
MultiMap
trailers()
Future<Void>
write(Resp data)
Write some data to the stream.boolean
writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
Methods inherited from class io.vertx.reactivex.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:
toString
in classGrpcWriteStream<Resp>
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classGrpcWriteStream<Resp>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classGrpcWriteStream<Resp>
-
getDelegate
public GrpcServerResponse getDelegate()
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWriteStream<Req>
- Overrides:
getDelegate
in classGrpcWriteStream<Resp>
-
toObserver
public WriteStreamObserver<Resp> toObserver()
- Specified by:
toObserver
in interfaceWriteStream<Req>
- Overrides:
toObserver
in classGrpcWriteStream<Resp>
-
toSubscriber
public WriteStreamSubscriber<Resp> toSubscriber()
- Specified by:
toSubscriber
in interfaceWriteStream<Req>
- Overrides:
toSubscriber
in classGrpcWriteStream<Resp>
-
write
public Future<Void> 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
data
is 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:
write
in interfaceWriteStream<Req>
- Overrides:
write
in 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
data
is 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:
rxWrite
in interfaceWriteStream<Req>
- Overrides:
rxWrite
in classGrpcWriteStream<Resp>
- Parameters:
data
- the data to write- Returns:
- a future completed with the write result
-
end
public Future<Void> end()
Ends the stream.Once the stream has ended, it cannot be used any more.
- Specified by:
end
in interfaceWriteStream<Req>
- Overrides:
end
in 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:
rxEnd
in interfaceWriteStream<Req>
- Overrides:
rxEnd
in classGrpcWriteStream<Resp>
- Returns:
- a future completed with the result
-
end
public Future<Void> end(Resp data)
Same asWriteStream.end()
but writes some data to the stream before ending.- Specified by:
end
in interfaceWriteStream<Req>
- Overrides:
end
in 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:
rxEnd
in interfaceWriteStream<Req>
- Overrides:
rxEnd
in classGrpcWriteStream<Resp>
- Parameters:
data
- the data to write- Returns:
- a future completed with the result
-
writeQueueFull
public boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
- Specified by:
writeQueueFull
in interfaceWriteStream<Req>
- Overrides:
writeQueueFull
in classGrpcWriteStream<Resp>
- Returns:
true
if write queue is full
-
format
public GrpcWriteStream<Resp> format(WireFormat format)
Set the stream format, e.g.proto
orjson
. It must be called before sending any message, otherwiseproto
will be used.- Overrides:
format
in classGrpcWriteStream<Resp>
- Parameters:
format
- the message format- Returns:
- a reference to this, so the API can be used fluently
-
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:GrpcWriteStream
Set the stream encoding, e.g.identity
orgzip
. It must be called before sending any message, otherwiseidentity
will be used.- Overrides:
encoding
in classGrpcWriteStream<Resp>
- Parameters:
encoding
- the target message encoding- 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:WriteStream
Set an exception handler on the write stream.- Specified by:
exceptionHandler
in interfaceStreamBase
- Specified by:
exceptionHandler
in interfaceWriteStream<Req>
- Overrides:
exceptionHandler
in 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:WriteStream
Set the maximum size of the write queue tomaxSize
. You will still be able to write to the stream even if there is more thanmaxSize
items in the write queue. This is used as an indicator by classes such asPipe
to provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket
, etc...- Specified by:
setWriteQueueMaxSize
in interfaceWriteStream<Req>
- Overrides:
setWriteQueueMaxSize
in 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:WriteStream
Set 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. SeePipe
for 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:
drainHandler
in interfaceWriteStream<Req>
- Overrides:
drainHandler
in classGrpcWriteStream<Resp>
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
rxSend
public Completable rxSend(Resp item)
-
send
public Future<Void> send(ReadStream<Resp> body)
-
rxSend
public Completable rxSend(ReadStream<Resp> body)
-
rxSend
public Completable rxSend(Flowable<Resp> body)
-
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)
-
-