public interface AsyncFile extends ReadStream<Buffer>, WriteStream<Buffer>
This class also implements ReadStream
and
WriteStream
. This allows the data to be piped to and from
other streams, e.g. an HttpClientRequest
instance,
using the Pipe
class
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.
|
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. |
Future<Void> |
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 |
getReadLength() |
long |
getWritePos() |
AsyncFile |
handler(Handler<Buffer> handler)
Set a data handler.
|
Future<AsyncFileLock> |
lock()
Acquire a non-shared lock on the entire file.
|
void |
lock(Handler<AsyncResult<AsyncFileLock>> handler)
Like
lock() but the handler will be called when the operation is complete or if an error occurs. |
Future<AsyncFileLock> |
lock(long position,
long size,
boolean shared)
Acquire a lock on a portion of this file.
|
void |
lock(long position,
long size,
boolean shared,
Handler<AsyncResult<AsyncFileLock>> handler)
Like
lock(long, long, boolean) but the handler will be called when the operation is complete or if an error occurs. |
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
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<Long> |
size() |
default void |
size(Handler<AsyncResult<Long>> handler)
Like
size() but the handler will be called when the operation is complete or if an error occurs. |
long |
sizeBlocking()
Like
size() but blocking. |
AsyncFileLock |
tryLock()
Try to acquire a non-shared lock on the entire file.
|
AsyncFileLock |
tryLock(long position,
long size,
boolean shared)
Try to acquire a lock on a portion of this file.
|
Future<Void> |
write(Buffer buffer,
long position)
Like
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. |
pipe, pipeTo, pipeTo
end, end, end, end, write, write, writeQueueFull
AsyncFile handler(Handler<Buffer> handler)
ReadStream
handler
in interface ReadStream<Buffer>
AsyncFile pause()
ReadStream
ReadStream
, 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()
ReadStream
flowing
mode.
If the ReadStream
has been paused, reading will recommence on it.resume
in interface ReadStream<Buffer>
AsyncFile endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface ReadStream<Buffer>
AsyncFile setWriteQueueMaxSize(int maxSize)
WriteStream
maxSize
. 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 WriteStream<Buffer>
maxSize
- the max size of the write streamAsyncFile drainHandler(Handler<Void> handler)
WriteStream
Pipe
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)
ReadStream
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerAsyncFile fetch(long amount)
ReadStream
amount
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>
Future<Void> close()
void close(Handler<AsyncResult<Void>> handler)
handler
- the handlervoid 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 completeFuture<Void> write(Buffer buffer, long position)
write(Buffer, long, Handler)
but returns a Future
of the asynchronous resultAsyncFile 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 completeFuture<Buffer> read(Buffer buffer, int offset, long position, int length)
read(Buffer, int, long, int, Handler)
but returns a Future
of the asynchronous resultFuture<Void> 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 filelong getReadLength()
ReadStream
AsyncFile setWritePos(long writePos)
WriteStream
.writePos
- the position in the filelong getWritePos()
AsyncFile setReadBufferSize(int readBufferSize)
readBufferSize
- the buffer sizelong sizeBlocking()
size()
but blocking.FileSystemException
- if an error occursdefault void size(Handler<AsyncResult<Long>> handler)
size()
but the handler
will be called when the operation is complete or if an error occurs.@Unstable AsyncFileLock tryLock()
null
@Unstable AsyncFileLock tryLock(long position, long size, boolean shared)
position
- where the region startssize
- the size of the regionshared
- whether the lock should be sharednull
@Unstable Future<AsyncFileLock> lock()
@Unstable void lock(Handler<AsyncResult<AsyncFileLock>> handler)
lock()
but the handler
will be called when the operation is complete or if an error occurs.@Unstable Future<AsyncFileLock> lock(long position, long size, boolean shared)
position
- where the region startssize
- the size of the regionshared
- whether the lock should be shared@Unstable void lock(long position, long size, boolean shared, Handler<AsyncResult<AsyncFileLock>> handler)
lock(long, long, boolean)
but the handler
will be called when the operation is complete or if an error occurs.Copyright © 2023 Eclipse. All rights reserved.