public class AsyncFileImpl extends Object implements AsyncFile
| Modifier and Type | Field and Description |
|---|---|
static int |
BUFFER_SIZE |
| 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.
|
AsyncFile |
endHandler(Handler<Void> handler)
Set an end handler.
|
AsyncFile |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
AsyncFile |
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 |
AsyncFile |
handler(Handler<Buffer> handler)
Set a data handler.
|
AsyncFile |
pause()
Pause the
ReadSupport. |
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.
|
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 buffer)
Write some data to the stream.
|
AsyncFile |
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) |
public static final int BUFFER_SIZE
public void close()
AsyncFilepublic void close(Handler<AsyncResult<Void>> handler)
AsyncFilepublic 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 AsyncFile 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 AsyncFile write(Buffer buffer)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface AsyncFilewrite in interface WriteStream<Buffer>buffer - the data to writepublic AsyncFile setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize bytes in the write queue. This is used as an indicator by classes such as
Pump to provide flow control.setWriteQueueMaxSize in interface AsyncFilesetWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic 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>public AsyncFile drainHandler(Handler<Void> handler)
WriteStreamPump for an example of this being used.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()
ReadStreamReadSupport. While it's paused, no data will be sent to the dataHandlerpause in interface AsyncFilepause in interface ReadStream<Buffer>public AsyncFile resume()
ReadStreamReadSupport has been paused, reading will recommence on it.resume in interface AsyncFileresume in interface ReadStream<Buffer>public AsyncFile 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 setWritePos(long writePos)
AsyncFileWriteStream.setWritePos in interface AsyncFilewritePos - the position in the fileCopyright © 2015. All Rights Reserved.