public class AsyncFile extends Object implements 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
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<AsyncFile> |
__TYPE_ARG |
| Constructor and Description |
|---|
AsyncFile(AsyncFile delegate) |
AsyncFile(Object delegate) |
| 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()
Same as
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
void |
end(Buffer data)
Same as but with an
handler called when the operation completes |
void |
end(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as but with an
handler called when the operation completes |
void |
end(Handler<AsyncResult<Void>> handler)
Same as
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
AsyncFile |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
boolean |
equals(Object o) |
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()
Same as
flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the flush is complete or if an error occurs |
AsyncFile |
flush(Handler<AsyncResult<Void>> handler)
Same as
flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the flush is complete or if an error occurs |
AsyncFile |
getDelegate() |
long |
getReadLength() |
long |
getWritePos() |
AsyncFile |
handler(Handler<Buffer> handler)
Set a data handler.
|
int |
hashCode() |
void |
lock()
Like
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs. |
void |
lock(Handler<AsyncResult<AsyncFileLock>> handler)
Like
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs. |
void |
lock(long position,
long size,
boolean shared)
Like
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs. |
void |
lock(long position,
long size,
boolean shared,
Handler<AsyncResult<AsyncFileLock>> handler)
Like
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs. |
static AsyncFile |
newInstance(AsyncFile arg) |
AsyncFile |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
void |
pipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
void |
pipeTo(WriteStream<Buffer> dst,
Handler<AsyncResult<Void>> handler)
Pipe this
ReadStream to the WriteStream. |
AsyncFile |
read(Buffer buffer,
int offset,
long position,
int length)
Reads
length bytes of data from the file at position position in the file, asynchronously. |
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. |
Completable |
rxClose()
Close the file.
|
Completable |
rxEnd()
Same as
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes |
Completable |
rxEnd(Buffer data)
Same as but with an
handler called when the operation completes |
Completable |
rxFlush()
Same as
flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the flush is complete or if an error occurs |
Single<AsyncFileLock> |
rxLock()
Like
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs. |
Single<AsyncFileLock> |
rxLock(long position,
long size,
boolean shared)
Like
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs. |
Completable |
rxPipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
Single<Buffer> |
rxRead(Buffer buffer,
int offset,
long position,
int length)
Reads
length bytes of data from the file at position position in the file, asynchronously. |
Single<Long> |
rxSize()
Like
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but the handler will be called when the operation is complete or if an error occurs. |
Completable |
rxWrite(Buffer data)
Same as but with an
handler called when the operation completes |
Completable |
rxWrite(Buffer buffer,
long position)
Write a
Buffer to the file at position position in the file, asynchronously. |
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. |
void |
size()
Like
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but the handler will be called when the operation is complete or if an error occurs. |
void |
size(Handler<AsyncResult<Long>> handler)
Like
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but the handler will be called when the operation is complete or if an error occurs. |
long |
sizeBlocking()
Like
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but blocking. |
Flowable<Buffer> |
toFlowable() |
Observable<Buffer> |
toObservable() |
WriteStreamObserver<Buffer> |
toObserver() |
String |
toString() |
WriteStreamSubscriber<Buffer> |
toSubscriber() |
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.
|
void |
write(Buffer data)
Same as but with an
handler called when the operation completes |
void |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as but with an
handler called when the operation completes |
void |
write(Buffer buffer,
long position)
Write a
Buffer to the file at position position in the file, asynchronously. |
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 setWriteQueueMaxSize(int) |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstance, newInstancenewInstance, newInstancenewInstancepublic static final io.vertx.lang.rx.TypeArg<AsyncFile> __TYPE_ARG
public AsyncFile(AsyncFile delegate)
public AsyncFile(Object delegate)
public AsyncFile getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>public Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>public Flowable<Buffer> toFlowable()
toFlowable in interface ReadStream<Buffer>public WriteStreamObserver<Buffer> toObserver()
toObserver in interface WriteStream<Buffer>public WriteStreamSubscriber<Buffer> toSubscriber()
toSubscriber in interface WriteStream<Buffer>public void write(Buffer data, Handler<AsyncResult<Void>> handler)
handler called when the operation completeswrite in interface WriteStream<Buffer>data - handler - public void write(Buffer data)
handler called when the operation completeswrite in interface WriteStream<Buffer>data - public Completable rxWrite(Buffer data)
handler called when the operation completesrxWrite in interface WriteStream<Buffer>data - public void end(Handler<AsyncResult<Void>> handler)
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completesend in interface WriteStream<Buffer>handler - public void end()
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completesend in interface WriteStream<Buffer>public Completable rxEnd()
WriteStream.end(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completesrxEnd in interface WriteStream<Buffer>public void end(Buffer data, Handler<AsyncResult<Void>> handler)
handler called when the operation completesend in interface WriteStream<Buffer>data - handler - public void end(Buffer data)
handler called when the operation completesend in interface WriteStream<Buffer>data - public Completable rxEnd(Buffer data)
handler called when the operation completesrxEnd in interface WriteStream<Buffer>data - 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>true if write queue is fullpublic Pipe<Buffer> pipe()
WriteStream.pipe in interface ReadStream<Buffer>public void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
pipeTo in interface ReadStream<Buffer>dst - the destination write streamhandler - public void pipeTo(WriteStream<Buffer> dst)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
pipeTo in interface ReadStream<Buffer>dst - the destination write streampublic Completable rxPipeTo(WriteStream<Buffer> dst)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
rxPipeTo in interface ReadStream<Buffer>dst - the destination write streampublic AsyncFile handler(Handler<Buffer> handler)
ReadStreamhandler 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 ReadStream<Buffer>public AsyncFile resume()
ReadStreamflowing mode.
If the ReadStream 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 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 WriteStream<Buffer>maxSize - the max size of the write streampublic 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 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 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 ReadStream<Buffer>public void close(Handler<AsyncResult<Void>> handler)
handler - the handlerpublic void close()
public Completable rxClose()
public void 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 void write(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 Completable rxWrite(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 AsyncFile read(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 Single<Buffer> rxRead(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(Handler<AsyncResult<Void>> handler)
flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the flush is complete or if an error occurshandler - public AsyncFile flush()
flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but the handler will be called when the flush is complete or if an error occurspublic Completable rxFlush()
flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) 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 setReadLength(long readLength)
ReadStream.readLength - the bytes that will be read from the filepublic long getReadLength()
ReadStreampublic AsyncFile setWritePos(long writePos)
WriteStream.writePos - the position in the filepublic long getWritePos()
public AsyncFile setReadBufferSize(int readBufferSize)
readBufferSize - the buffer sizepublic long sizeBlocking()
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but blocking.public void size(Handler<AsyncResult<Long>> handler)
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but the handler will be called when the operation is complete or if an error occurs.handler - public void size()
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but the handler will be called when the operation is complete or if an error occurs.public Single<Long> rxSize()
size(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>>) but the handler will be called when the operation is complete or if an error occurs.public AsyncFileLock tryLock()
nullpublic AsyncFileLock tryLock(long position, long size, boolean shared)
position - where the region startssize - the size of the regionshared - whether the lock should be sharednullpublic void lock(Handler<AsyncResult<AsyncFileLock>> handler)
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs.handler - public void lock()
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs.public Single<AsyncFileLock> rxLock()
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs.public void lock(long position,
long size,
boolean shared,
Handler<AsyncResult<AsyncFileLock>> handler)
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs.position - size - shared - handler - public void lock(long position,
long size,
boolean shared)
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs.position - size - shared - public Single<AsyncFileLock> rxLock(long position, long size, boolean shared)
lock(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.file.AsyncFileLock>>) but the handler will be called when the operation is complete or if an error occurs.position - size - shared - Copyright © 2024 Eclipse. All rights reserved.