Package io.vertx.reactivex.core.streams
Interface WriteStream<T>
-
- All Superinterfaces:
StreamBase
- All Known Subinterfaces:
WebSocketBase
- All Known Implementing Classes:
AmqpSender
,AsyncFile
,GrpcClientRequest
,GrpcServerResponse
,GrpcWriteStream
,HttpClientRequest
,HttpServerResponse
,KafkaProducer
,NetSocket
,ServerWebSocket
,SockJSSocket
,WebSocket
public interface WriteStream<T> extends StreamBase
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description WriteStream<T>
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.void
end()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(Handler<AsyncResult<Void>> handler)
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(T data)
Same as but with anhandler
called when the operation completesvoid
end(T data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesWriteStream<T>
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.WriteStream
getDelegate()
static <T> WriteStream<T>
newInstance(WriteStream arg)
static <T> WriteStream<T>
newInstance(WriteStream arg, TypeArg<T> __typeArg_T)
io.reactivex.Completable
rxEnd()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxEnd(T data)
Same as but with anhandler
called when the operation completesio.reactivex.Completable
rxWrite(T data)
Same as but with anhandler
called when the operation completesWriteStream<T>
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue tomaxSize
.void
write(T data)
Same as but with anhandler
called when the operation completesvoid
write(T data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesboolean
writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
-
-
-
Method Detail
-
getDelegate
WriteStream getDelegate()
- Specified by:
getDelegate
in interfaceStreamBase
-
exceptionHandler
WriteStream<T> exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.- Specified by:
exceptionHandler
in interfaceStreamBase
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
write
void write(T data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Parameters:
data
-handler
-
-
write
void write(T data)
Same as but with anhandler
called when the operation completes- Parameters:
data
-
-
rxWrite
io.reactivex.Completable rxWrite(T data)
Same as but with anhandler
called when the operation completes- Parameters:
data
-- Returns:
-
end
void end(Handler<AsyncResult<Void>> handler)
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
handler
-
-
end
void end()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes
-
rxEnd
io.reactivex.Completable rxEnd()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Returns:
-
end
void end(T data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Parameters:
data
-handler
-
-
end
void end(T data)
Same as but with anhandler
called when the operation completes- Parameters:
data
-
-
rxEnd
io.reactivex.Completable rxEnd(T data)
Same as but with anhandler
called when the operation completes- Parameters:
data
-- Returns:
-
setWriteQueueMaxSize
WriteStream<T> setWriteQueueMaxSize(int maxSize)
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...- Parameters:
maxSize
- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
writeQueueFull
boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
- Returns:
true
if write queue is full
-
drainHandler
WriteStream<T> drainHandler(Handler<Void> handler)
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
.- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
newInstance
static <T> WriteStream<T> newInstance(WriteStream arg)
-
newInstance
static <T> WriteStream<T> newInstance(WriteStream arg, TypeArg<T> __typeArg_T)
-
-