public class AsyncFile extends Object implements ReadStream<Buffer>, WriteStream<Buffer>
This class also implements ReadStream and
WriteStream. This allows the data to be pumped to and from
other streams, e.g. an HttpClientRequest instance,
using the Pump class
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static TypeArg<AsyncFile> |
__TYPE_ARG |
| Constructor and Description |
|---|
AsyncFile(io.vertx.core.file.AsyncFile delegate) |
| Modifier and Type | Method and Description |
|---|---|
CompletionStage<Void> |
close()
Close the file.
|
AsyncFile |
drainHandler(Consumer<Void> handler)
Set a drain handler on the stream.
|
CompletionStage<Void> |
end()
Close the file, see
close(). |
CompletionStage<Void> |
end(Buffer data)
Same as but with an
handler called when the operation completes |
AsyncFile |
endHandler(Consumer<Void> endHandler)
Set an end handler.
|
boolean |
equals(Object o) |
AsyncFile |
exceptionHandler(Consumer<Throwable> handler)
Set an exception handler on the read stream.
|
AsyncFile |
fetch(long amount)
Fetch the specified
amount of elements. |
CompletionStage<Void> |
flush()
Same as
flush() but the handler will be called when the flush is complete or if an error occurs |
io.vertx.core.file.AsyncFile |
getDelegate() |
long |
getWritePos() |
AsyncFile |
handler(Consumer<Buffer> handler)
Set a data handler.
|
int |
hashCode() |
static AsyncFile |
newInstance(io.vertx.core.file.AsyncFile arg) |
AsyncFile |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
CompletionStage<Void> |
pipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
CompletionStage<Buffer> |
read(Buffer buffer,
int offset,
long position,
int length)
Reads
length bytes of data from the file at position position in the file, asynchronously. |
AsyncFile |
resume()
Resume reading, and sets the buffer in
flowing mode. |
AsyncFile |
setReadBufferSize(int readBufferSize)
Sets the buffer size that will be used to read the data from the file.
|
AsyncFile |
setReadLength(long readLength)
Sets the number of bytes that will be read when using the file as a
ReadStream. |
AsyncFile |
setReadPos(long readPos)
Sets the position from which data will be read from when using the file as a
ReadStream. |
AsyncFile |
setWritePos(long writePos)
Sets the position from which data will be written when using the file as a
WriteStream. |
AsyncFile |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
org.reactivestreams.Publisher<Buffer> |
toPublisher() |
org.eclipse.microprofile.reactive.streams.operators.PublisherBuilder<Buffer> |
toPublisherBuilder() |
String |
toString() |
CompletionStage<Void> |
write(Buffer data)
Same as
write(io.vertx.axle.core.buffer.Buffer) but with an handler called when the operation completes |
CompletionStage<Void> |
write(Buffer buffer,
long position)
Write a
Buffer to the file at position position in the file, asynchronously. |
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstance, newInstancenewInstance, newInstancenewInstancepublic io.vertx.core.file.AsyncFile getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>public org.reactivestreams.Publisher<Buffer> toPublisher()
toPublisher in interface ReadStream<Buffer>public org.eclipse.microprofile.reactive.streams.operators.PublisherBuilder<Buffer> toPublisherBuilder()
public CompletionStage<Void> end(Buffer data)
handler called when the operation completesend in interface WriteStream<Buffer>data - public boolean writeQueueFull()
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)writeQueueFull in interface WriteStream<Buffer>public Pipe<Buffer> pipe()
WriteStream.pipe in interface ReadStream<Buffer>public CompletionStage<Void> pipeTo(WriteStream<Buffer> dst)
ReadStream to the WriteStream.
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.
pipeTo in interface ReadStream<Buffer>dst - the destination write streampublic AsyncFile handler(Consumer<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>public AsyncFile pause()
ReadStreamReadStream, it sets the buffer in fetch mode and clears the actual demand.
While it's paused, no data will be sent to the data handler.
pause in interface ReadStream<Buffer>public AsyncFile resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>public AsyncFile endHandler(Consumer<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>public CompletionStage<Void> write(Buffer data)
write(io.vertx.axle.core.buffer.Buffer) but with an handler called when the operation completeswrite in interface WriteStream<Buffer>data - public AsyncFile setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
Pump to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, the number of Message for a
MessageProducer, etc...setWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic AsyncFile drainHandler(Consumer<Void> handler)
WriteStreamPump 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.drainHandler in interface WriteStream<Buffer>handler - the handlerpublic AsyncFile exceptionHandler(Consumer<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerpublic AsyncFile fetch(long amount)
ReadStreamamount of elements. If the ReadStream has been paused, reading will
recommence with the specified amount of items, otherwise the specified amount will
be added to the current stream demand.fetch in interface ReadStream<Buffer>public CompletionStage<Void> end()
close().end in interface WriteStream<Buffer>public CompletionStage<Void> close()
public CompletionStage<Void> write(Buffer buffer, long position)
Buffer to the file at position position in the file, asynchronously.
If position lies outside of the current size
of the file, the file will be enlarged to encompass it.
When multiple writes are invoked on the same file there are no guarantees as to order in which those writes actually occur
The handler will be called when the write is complete, or if an error occurs.
buffer - the buffer to writeposition - the position in the file to write it atpublic CompletionStage<Buffer> read(Buffer buffer, int offset, long position, int length)
length bytes of data from the file at position position in the file, asynchronously.
The read data will be written into the specified Buffer buffer at position offset.
If data is read past the end of the file then zero bytes will be read.
When multiple reads are invoked on the same file there are no guarantees as to order in which those reads actually occur.
The handler will be called when the close is complete, or if an error occurs.
buffer - the buffer to read intooffset - the offset into the buffer where the data will be readposition - the position in the file where to start readinglength - the number of bytes to readpublic CompletionStage<Void> flush()
flush() but the handler will be called when the flush is complete or if an error occurspublic AsyncFile setReadPos(long readPos)
ReadStream.readPos - the position in the filepublic AsyncFile setReadLength(long readLength)
ReadStream.readLength - the bytes that will be read from the filepublic AsyncFile setWritePos(long writePos)
WriteStream.writePos - the position in the filepublic long getWritePos()
public AsyncFile setReadBufferSize(int readBufferSize)
readBufferSize - the buffer sizepublic static AsyncFile newInstance(io.vertx.core.file.AsyncFile arg)
Copyright © 2019 SmallRye. All rights reserved.