Class GrpcWriteStream<T>
- java.lang.Object
-
- io.vertx.reactivex.grpc.common.GrpcWriteStream<T>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,StreamBase,WriteStream<T>
- Direct Known Subclasses:
GrpcClientRequest,GrpcServerResponse
public class GrpcWriteStream<T> extends Object implements io.vertx.lang.rx.RxDelegate, WriteStream<T>
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<GrpcWriteStream>__TYPE_ARGio.vertx.lang.rx.TypeArg<T>__typeArg_0
-
Constructor Summary
Constructors Constructor Description GrpcWriteStream(GrpcWriteStream delegate)GrpcWriteStream(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 voidcancel()Cancel the stream.GrpcWriteStream<T>drainHandler(Handler<Void> handler)Set a drain handler on the stream.GrpcWriteStream<T>encoding(String encoding)Set the stream encoding, e.g.Future<Void>end()Ends the stream.Future<Void>end(T data)Same asWriteStream.end()but writes some data to the stream before ending.Future<Void>endMessage(GrpcMessage message)End the stream with an encoded gRPC message.booleanequals(Object o)GrpcWriteStream<T>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the write stream.GrpcWriteStream<T>format(WireFormat format)Set the stream format, e.g.GrpcWriteStreamgetDelegate()inthashCode()MultiMapheaders()static <T> GrpcWriteStream<T>newInstance(GrpcWriteStream arg)static <T> GrpcWriteStream<T>newInstance(GrpcWriteStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)CompletablerxEnd()Ends the stream.CompletablerxEnd(T data)Same asWriteStream.end()but writes some data to the stream before ending.CompletablerxEndMessage(GrpcMessage message)End the stream with an encoded gRPC message.CompletablerxWrite(T data)Write some data to the stream.CompletablerxWriteMessage(GrpcMessage message)Write an encoded gRPC message.GrpcWriteStream<T>setWriteQueueMaxSize(int i)Set the maximum size of the write queue tomaxSize.WriteStreamObserver<T>toObserver()StringtoString()WriteStreamSubscriber<T>toSubscriber()Future<Void>write(T data)Write some data to the stream.Future<Void>writeMessage(GrpcMessage message)Write an encoded gRPC message.booleanwriteQueueFull()This will returntrueif there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<GrpcWriteStream> __TYPE_ARG
-
__typeArg_0
public final io.vertx.lang.rx.TypeArg<T> __typeArg_0
-
-
Constructor Detail
-
GrpcWriteStream
public GrpcWriteStream(GrpcWriteStream delegate)
-
-
Method Detail
-
getDelegate
public GrpcWriteStream getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase- Specified by:
getDelegatein interfaceWriteStream<T>
-
toObserver
public WriteStreamObserver<T> toObserver()
- Specified by:
toObserverin interfaceWriteStream<T>
-
toSubscriber
public WriteStreamSubscriber<T> toSubscriber()
- Specified by:
toSubscriberin interfaceWriteStream<T>
-
write
public Future<Void> write(T 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<T>- Parameters:
data- the data to write- Returns:
- a future completed with the write result
-
rxWrite
public Completable rxWrite(T 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<T>- 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:
endin interfaceWriteStream<T>- 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<T>- Returns:
- a future completed with the result
-
end
public Future<Void> end(T data)
Same asWriteStream.end()but writes some data to the stream before ending.- Specified by:
endin interfaceWriteStream<T>- Parameters:
data- the data to write- Returns:
- a future completed with the result
-
rxEnd
public Completable rxEnd(T data)
Same asWriteStream.end()but writes some data to the stream before ending.- Specified by:
rxEndin interfaceWriteStream<T>- 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<T>- Returns:
trueif write queue is full
-
headers
public MultiMap headers()
- Returns:
- the to reader metadata headers
-
encoding
public GrpcWriteStream<T> encoding(String encoding)
Set the stream encoding, e.g.identityorgzip. It must be called before sending any message, otherwiseidentitywill be used.- Parameters:
encoding- the target message encoding- Returns:
- a reference to this, so the API can be used fluently
-
format
public GrpcWriteStream<T> format(WireFormat format)
Set the stream format, e.g.protoorjson. It must be called before sending any message, otherwiseprotowill be used.- Parameters:
format- the message format- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public GrpcWriteStream<T> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:WriteStreamSet an exception handler on the write stream.- Specified by:
exceptionHandlerin interfaceStreamBase- Specified by:
exceptionHandlerin interfaceWriteStream<T>- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
public GrpcWriteStream<T> setWriteQueueMaxSize(int i)
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<T>- Parameters:
i- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public GrpcWriteStream<T> 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<T>- Parameters:
handler- the handler- Returns:
- a reference to this, so the API can be used fluently
-
writeMessage
public Future<Void> writeMessage(GrpcMessage message)
Write an encoded gRPC message.- Parameters:
message- the message- Returns:
- a future completed with the result
-
rxWriteMessage
public Completable rxWriteMessage(GrpcMessage message)
Write an encoded gRPC message.- Parameters:
message- the message- Returns:
- a future completed with the result
-
endMessage
public Future<Void> endMessage(GrpcMessage message)
End the stream with an encoded gRPC message.- Parameters:
message- the message- Returns:
- a future completed with the result
-
rxEndMessage
public Completable rxEndMessage(GrpcMessage message)
End the stream with an encoded gRPC message.- Parameters:
message- the message- Returns:
- a future completed with the result
-
cancel
public void cancel()
Cancel the stream.
-
newInstance
public static <T> GrpcWriteStream<T> newInstance(GrpcWriteStream arg)
-
newInstance
public static <T> GrpcWriteStream<T> newInstance(GrpcWriteStream arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)
-
-