Vert.x 4.5.13 · io.vertx.core.file.impl.AsyncFileLockImpl

Modifier and Type	Field and Description
private final FileLock	fileLock
private final VertxInternal	vertx

Access	Constructor and Description
public	AsyncFileLockImpl(VertxInternal vertx, FileLock fileLock)

Method Summary

Modifier and Type	Method and Description
public boolean	isShared() Implements io.vertx.core.file.AsyncFileLock.isShared.
public Future<Boolean>	isValid() Implements io.vertx.core.file.AsyncFileLock.isValid. A lock remains valid until it is released or the file corresponding `AsyncFile` is closed.
public void	isValid(Handler<AsyncResult<Boolean>> handler) Implements io.vertx.core.file.AsyncFileLock.isValid. Like `isValid()` but the `handler` will be called when the operation completes or if an error occurs.
public boolean	isValidBlocking() Implements io.vertx.core.file.AsyncFileLock.isValidBlocking. Like `isValid()` but blocking.
public boolean	overlaps(long position, long size) Implements io.vertx.core.file.AsyncFileLock.overlaps.
public long	position() Implements io.vertx.core.file.AsyncFileLock.position.
public Future<Void>	release() Implements io.vertx.core.file.AsyncFileLock.release. Releases this lock;
public void	release(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.file.AsyncFileLock.release. Like `release()` but the `handler` will be called when the operation completes or if an error occurs.
public void	releaseBlocking() Implements io.vertx.core.file.AsyncFileLock.releaseBlocking. Like `release()` but blocking.
public long	size() Implements io.vertx.core.file.AsyncFileLock.size.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

fileLock	back to summary
private final FileLock fileLock

vertx	back to summary
private final VertxInternal vertx

AsyncFileLockImpl	back to summary
public AsyncFileLockImpl(VertxInternal vertx, FileLock fileLock)

Method Detail

isShared back to summary

isShared	back to summary
public boolean isShared() Implements io.vertx.core.file.AsyncFileLock.isShared. Returns:boolean Doc from io.vertx.core.file.AsyncFileLock.isShared. `true` if this lock is shared, otherwise `false` Annotations @Override

public boolean isShared()

Implements io.vertx.core.file.AsyncFileLock.isShared.

Returns:boolean

Doc from io.vertx.core.file.AsyncFileLock.isShared.

true if this lock is shared, otherwise false

Annotations

@Override

isValid back to summary

isValid	back to summary
public Future<Boolean> isValid() Implements io.vertx.core.file.AsyncFileLock.isValid. Doc from io.vertx.core.file.AsyncFileLock.isValid. A lock remains valid until it is released or the file corresponding `AsyncFile` is closed. Annotations @Override

public Future<Boolean> isValid()

Implements io.vertx.core.file.AsyncFileLock.isValid.

Doc from io.vertx.core.file.AsyncFileLock.isValid.

A lock remains valid until it is released or the file corresponding AsyncFile is closed.

Annotations

@Override

isValid back to summary

isValid	back to summary
public void isValid(Handler<AsyncResult<Boolean>> handler) Implements io.vertx.core.file.AsyncFileLock.isValid. Doc from io.vertx.core.file.AsyncFileLock.isValid. Like `isValid()` but the `handler` will be called when the operation completes or if an error occurs. Annotations @Override

public void isValid(Handler<AsyncResult<Boolean>> handler)

Implements io.vertx.core.file.AsyncFileLock.isValid.

Doc from io.vertx.core.file.AsyncFileLock.isValid.

Like isValid() but the handler will be called when the operation completes or if an error occurs.

Annotations

@Override

isValidBlocking back to summary

isValidBlocking	back to summary
public boolean isValidBlocking() Implements io.vertx.core.file.AsyncFileLock.isValidBlocking. Doc from io.vertx.core.file.AsyncFileLock.isValidBlocking. Like `isValid()` but blocking. Annotations @Override

public boolean isValidBlocking()

Implements io.vertx.core.file.AsyncFileLock.isValidBlocking.

Doc from io.vertx.core.file.AsyncFileLock.isValidBlocking.

Like isValid() but blocking.

Annotations

@Override

overlaps back to summary

overlaps	back to summary
public boolean overlaps(long position, long size) Implements io.vertx.core.file.AsyncFileLock.overlaps. Returns:boolean Doc from io.vertx.core.file.AsyncFileLock.overlaps. `true` if this lock overlaps with the range described by `position` and `size`, otherwise `false` Annotations @Override

public boolean overlaps(long position, long size)

Implements io.vertx.core.file.AsyncFileLock.overlaps.

Returns:boolean

Doc from io.vertx.core.file.AsyncFileLock.overlaps.

true if this lock overlaps with the range described by position and size, otherwise false

Annotations

@Override

position	back to summary
public long position() Implements io.vertx.core.file.AsyncFileLock.position. Returns:long Doc from io.vertx.core.file.AsyncFileLock.position. the position of the first byte of the locked region Annotations @Override

position

back to summary

public long position()

Implements io.vertx.core.file.AsyncFileLock.position.

Returns:long

Doc from io.vertx.core.file.AsyncFileLock.position.

the position of the first byte of the locked region

Annotations

@Override

release	back to summary
public Future<Void> release() Implements io.vertx.core.file.AsyncFileLock.release. Doc from io.vertx.core.file.AsyncFileLock.release. Releases this lock; Annotations @Override

release

back to summary

public Future<Void> release()

Implements io.vertx.core.file.AsyncFileLock.release.

Doc from io.vertx.core.file.AsyncFileLock.release.

Releases this lock;

Annotations

@Override

release back to summary

release	back to summary
public void release(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.file.AsyncFileLock.release. Doc from io.vertx.core.file.AsyncFileLock.release. Like `release()` but the `handler` will be called when the operation completes or if an error occurs. Annotations @Override

public void release(Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.file.AsyncFileLock.release.

Doc from io.vertx.core.file.AsyncFileLock.release.

Like release() but the handler will be called when the operation completes or if an error occurs.

Annotations

@Override

releaseBlocking back to summary

releaseBlocking	back to summary
public void releaseBlocking() Implements io.vertx.core.file.AsyncFileLock.releaseBlocking. Doc from io.vertx.core.file.AsyncFileLock.releaseBlocking. Like `release()` but blocking. Annotations @Override

public void releaseBlocking()

Implements io.vertx.core.file.AsyncFileLock.releaseBlocking.

Doc from io.vertx.core.file.AsyncFileLock.releaseBlocking.

Like release() but blocking.

Annotations

@Override

size	back to summary
public long size() Implements io.vertx.core.file.AsyncFileLock.size. Returns:long Doc from io.vertx.core.file.AsyncFileLock.size. the size in bytes of the locked region Annotations @Override

size

back to summary

public long size()

Implements io.vertx.core.file.AsyncFileLock.size.

Returns:long

Doc from io.vertx.core.file.AsyncFileLock.size.

the size in bytes of the locked region

Annotations

@Override

public Class AsyncFileLockImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail