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 | Method and Description |
|---|---|
void |
close()
Close the file.
|
void |
close(Handler<AsyncResult<Void>> handler)
Close the file.
|
rx.Observable<Void> |
closeObservable()
Close the file.
|
AsyncFile |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
AsyncFile |
endHandler(Handler<Void> endHandler)
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
flush() but the handler will be called when the flush is complete or if an error occurs |
rx.Observable<Void> |
flushObservable()
Same as
flush() but the handler will be called when the flush is complete or if an error occurs |
Object |
getDelegate() |
AsyncFile |
handler(Handler<Buffer> handler)
Set a data handler.
|
static AsyncFile |
newInstance(AsyncFile arg) |
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. |
rx.Observable<Buffer> |
readObservable(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.
|
AsyncFile |
setReadBufferSize(int readBufferSize)
Sets the buffer size that will be used to read the data from the file.
|
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. |
rx.Observable<Buffer> |
toObservable() |
AsyncFile |
write(Buffer data)
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. |
rx.Observable<Void> |
writeObservable(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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitnewInstancenewInstancenewInstancepublic AsyncFile(AsyncFile delegate)
public Object getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>public rx.Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>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 AsyncFile handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>public AsyncFile pause()
ReadStreamReadSupport. While it's paused, no data will be sent to the dataHandlerpause in interface ReadStream<Buffer>public AsyncFile resume()
ReadStreamReadSupport has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>public AsyncFile endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>public 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 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 WriteStream<Buffer>maxSize - the max size of the write streampublic AsyncFile drainHandler(Handler<Void> handler)
WriteStreamPump for an example of this being used.drainHandler in interface WriteStream<Buffer>handler - the handlerpublic AsyncFile exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerpublic void close()
public void close(Handler<AsyncResult<Void>> handler)
handler - the handlerpublic rx.Observable<Void> closeObservable()
public AsyncFile 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 completepublic rx.Observable<Void> writeObservable(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 AsyncFile 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 completepublic rx.Observable<Buffer> readObservable(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 AsyncFile 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.
public AsyncFile flush(Handler<AsyncResult<Void>> handler)
flush() but the handler will be called when the flush is complete or if an error occurshandler - public rx.Observable<Void> flushObservable()
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 setWritePos(long writePos)
WriteStream.writePos - the position in the filepublic AsyncFile setReadBufferSize(int readBufferSize)
readBufferSize - the buffer sizeCopyright © 2015. All rights reserved.