public interface AsyncFile extends 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
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the file.
|
void |
close(Handler<AsyncResult<Void>> handler)
Close the file.
|
AsyncFile |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Close the file, see
close(). |
void |
end(Handler<AsyncResult<Void>> handler)
Close the file, see
close(Handler). |
AsyncFile |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
AsyncFile |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
AsyncFile |
fetch(long amount)
Fetch the specified
amount of elements. |
AsyncFile |
flush()
Flush any writes made to this file to underlying persistent storage.
|
AsyncFile |
flush(Handler<AsyncResult<Void>> handler)
Same as
flush() but the handler will be called when the flush is complete or if an error occurs |
long |
getWritePos() |
AsyncFile |
handler(Handler<Buffer> handler)
Set a data handler.
|
AsyncFile |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
AsyncFile |
read(Buffer buffer,
int offset,
long position,
int length,
Handler<AsyncResult<Buffer>> handler)
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. |
AsyncFile |
write(Buffer data)
Write some data to the stream.
|
AsyncFile |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
write(Buffer) but with an handler called when the operation completes |
AsyncFile |
write(Buffer buffer,
long position,
Handler<AsyncResult<Void>> handler)
Write a
Buffer to the file at position position in the file, asynchronously. |
pipe, pipeTo, pipeToend, end, writeQueueFullAsyncFile handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>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>AsyncFile resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>AsyncFile endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>AsyncFile write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface WriteStream<Buffer>data - the data to writeAsyncFile write(Buffer data, Handler<AsyncResult<Void>> handler)
write(Buffer) but with an handler called when the operation completeswrite in interface WriteStream<Buffer>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 streamAsyncFile drainHandler(Handler<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 handlerAsyncFile exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerAsyncFile 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>void end()
close().end in interface WriteStream<Buffer>void end(Handler<AsyncResult<Void>> handler)
close(Handler).end in interface WriteStream<Buffer>void close()
void close(Handler<AsyncResult<Void>> handler)
handler - the handlerAsyncFile write(Buffer buffer, long position, Handler<AsyncResult<Void>> handler)
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 athandler - the handler to call when the write is completeAsyncFile read(Buffer buffer, int offset, long position, int length, Handler<AsyncResult<Buffer>> handler)
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 readhandler - the handler to call when the write is completeAsyncFile flush()
If the file was opened with flush set to true then calling this method will have no effect.
The actual flush will happen asynchronously.
AsyncFile flush(Handler<AsyncResult<Void>> handler)
flush() but the handler will be called when the flush is complete or if an error occursAsyncFile setReadPos(long readPos)
ReadStream.readPos - the position in the fileAsyncFile setReadLength(long readLength)
ReadStream.readLength - the bytes that will be read from the fileAsyncFile setWritePos(long writePos)
WriteStream.writePos - the position in the filelong getWritePos()
AsyncFile setReadBufferSize(int readBufferSize)
readBufferSize - the buffer sizeCopyright © 2023 Eclipse. All rights reserved.