fuchsia.io/AdvisoryLocking.AdvisoryLock
METHOD
fuchsia.io
sdk/fidl/fuchsia.io/locking.fidl:45
Acquires an advisory lock on the underlying file.
The lock lasts until either this connection is closed or
this method is called with |AdvisoryLockType.UNLOCK| to release the lock
explicitly.
Advisory locks are purely advisory. They do not prevent actual read or
write operations from occurring on the file, either through this
connection or through other connections.
This method requires the following rights:
* [`Rights.READ_BYTES`] if `request.type` is [`AdvisoryLockType.READ`].
* [`Rights.WRITE_BYTES`] if `request.type` is
[`AdvisoryLockType.WRITE`].
# Errors
* `ZX_ERR_BAD_STATE` The specified type of lock cannot be acquired. For
example, another connection might hold a conflicting lock type.
* `ZX_ERR_NOT_SUPPORTED` This file does not support advisory locking.
* `ZX_ERR_ACCESS_DENIED` This connection does not have sufficient rights
to acquire the given type of lock.
Relationships
-
ACCEPTS_TYPE→fuchsia.io/request -
ACCEPTS_TYPE→fuchsia.io/type -
ACCEPTS_TYPE→fuchsia.io/bug -
ACCEPTS_TYPE→fuchsia.io/state -
ACCEPTS_TYPE→fuchsia.io/READ -
ACCEPTS_TYPE→fuchsia.io/WRITE -
ACCEPTS_TYPE→fuchsia.io/UNLOCK -
ACCEPTS_TYPE→fuchsia.io/range -
ACCEPTS_TYPE→fuchsia.io/origin -
ACCEPTS_TYPE→fuchsia.io/SeekOrigin -
ACCEPTS_TYPE→fuchsia.io/offset -
ACCEPTS_TYPE→fuchsia.io/length -
ACCEPTS_TYPE→fuchsia.io/wait
Documentation (1)
-
SUBSTANTIVE
sdk/fidl/fuchsia.io/locking.fidl:45↗
Tests (0)
No test references.
Examples (0)
No example references.
Gaps
Missing categories:
- examples
- tests
Findings (2)
-
WARNING
DOCUMENTED_UNTESTEDelement is documented but has no test references -
WARNING
MISSING_IN_CATEGORYno references in category "tests.unit_tests"