public class AsyncFileImpl extends Object implements AsyncFile
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_READ_BUFFER_SIZE |
| Modifier and Type | Method and Description |
|---|---|
Future<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.
|
Future<Void> |
end()
Ends the stream.
|
void |
end(Handler<AsyncResult<Void>> handler)
Same as
WriteStream.end() but with an handler called when the operation completes |
AsyncFile |
endHandler(Handler<Void> handler)
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. |
Future<Void> |
flush()
Flush any writes made to this file to underlying persistent storage.
|
AsyncFile |
flush(Handler<AsyncResult<Void>> handler)
Same as
AsyncFile.flush() but the handler will be called when the flush is complete or if an error occurs |
long |
getReadLength() |
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. |
Future<Buffer> |
read(Buffer buffer,
int offset,
long position,
int length)
Like
AsyncFile.read(Buffer, int, long, int, Handler) but returns a Future of the asynchronous result |
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. |
Future<Void> |
write(Buffer buffer)
Write some data to the stream.
|
void |
write(Buffer buffer,
Handler<AsyncResult<Void>> handler)
Same as
#write(T) but with an handler called when the operation completes |
Future<Void> |
write(Buffer buffer,
long position)
Like
AsyncFile.write(Buffer, long, Handler) but returns a Future of the asynchronous result |
void |
write(Buffer buffer,
long position,
Handler<AsyncResult<Void>> handler)
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 WriteStream.setWriteQueueMaxSize(int) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpipe, pipeTo, pipeToend, endpublic static final int DEFAULT_READ_BUFFER_SIZE
public Future<Void> close()
AsyncFilepublic void close(Handler<AsyncResult<Void>> handler)
AsyncFilepublic Future<Void> end()
WriteStreamOnce the stream has ended, it cannot be used any more.
end in interface WriteStream<Buffer>public void end(Handler<AsyncResult<Void>> handler)
WriteStreamWriteStream.end() but with an handler called when the operation completesend in interface WriteStream<Buffer>public AsyncFile read(Buffer buffer, int offset, long position, int length, Handler<AsyncResult<Buffer>> handler)
AsyncFilelength 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.
read in interface AsyncFilebuffer - 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 completepublic Future<Buffer> read(Buffer buffer, int offset, long position, int length)
AsyncFileAsyncFile.read(Buffer, int, long, int, Handler) but returns a Future of the asynchronous resultpublic 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 AsyncFilefetch in interface ReadStream<Buffer>public void write(Buffer buffer, long position, Handler<AsyncResult<Void>> handler)
AsyncFileBuffer 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.
public Future<Void> write(Buffer buffer, long position)
AsyncFileAsyncFile.write(Buffer, long, Handler) but returns a Future of the asynchronous resultpublic Future<Void> write(Buffer buffer)
WriteStream 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 Pipe.
When the data is moved from the queue to the actual medium, the returned
Future 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.
write in interface WriteStream<Buffer>buffer - the data to writepublic void write(Buffer buffer, Handler<AsyncResult<Void>> handler)
WriteStream#write(T) but with an handler called when the operation completeswrite in interface WriteStream<Buffer>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
Pipe to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, etc...setWriteQueueMaxSize in interface AsyncFilesetWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic AsyncFile setReadBufferSize(int readBufferSize)
AsyncFilesetReadBufferSize in interface AsyncFilereadBufferSize - the buffer sizepublic boolean writeQueueFull()
WriteStreamtrue if there are more bytes in the write queue than the value set using WriteStream.setWriteQueueMaxSize(int)writeQueueFull in interface WriteStream<Buffer>true if write queue is fullpublic AsyncFile drainHandler(Handler<Void> handler)
WriteStreamPipe 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 AsyncFiledrainHandler in interface WriteStream<Buffer>handler - the handlerpublic AsyncFile exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface AsyncFileexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerpublic AsyncFile handler(Handler<Buffer> handler)
ReadStreamhandler in interface AsyncFilehandler in interface ReadStream<Buffer>public AsyncFile endHandler(Handler<Void> handler)
ReadStreamendHandler in interface AsyncFileendHandler 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 AsyncFilepause in interface ReadStream<Buffer>public AsyncFile resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface AsyncFileresume in interface ReadStream<Buffer>public Future<Void> flush()
AsyncFile
If the file was opened with flush set to true then calling this method will have no effect.
The actual flush will happen asynchronously.
public AsyncFile flush(Handler<AsyncResult<Void>> handler)
AsyncFileAsyncFile.flush() but the handler will be called when the flush is complete or if an error occurspublic AsyncFile setReadPos(long readPos)
AsyncFileReadStream.setReadPos in interface AsyncFilereadPos - the position in the filepublic AsyncFile setReadLength(long readLength)
AsyncFileReadStream.setReadLength in interface AsyncFilereadLength - the bytes that will be read from the filepublic long getReadLength()
getReadLength in interface AsyncFileReadStreampublic AsyncFile setWritePos(long writePos)
AsyncFileWriteStream.setWritePos in interface AsyncFilewritePos - the position in the filepublic long getWritePos()
getWritePos in interface AsyncFileCopyright © 2021. All rights reserved.