Meziantou.FrameworkLockOptions Class
The options of LockManager.Request (https://w3c.github.io/web-locks/#dictdef-lockoptions).
public sealed class LockOptionsConstructors
| Name | Description |
|---|---|
| LockOptions() |
LockOptions()
LockManager.cspublic LockOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| IfAvailable | Gets whether the callback is called with null, instead of waiting, when the lock cannot be granted at once. |
| Mode | Gets the mode of the lock. |
| Signal | Gets the signal that aborts the request while the lock is not granted. |
| Steal | Gets whether the held locks of the resource are released (their requests fail with an AbortError) and the lock is granted before the pending requests. |
IfAvailable
LockManager.csGets whether the callback is called with null, instead of waiting, when the lock cannot be granted at once.
public bool IfAvailable { get; init; }Mode
LockManager.csGets the mode of the lock.
public LockMode Mode { get; init; }Signal
LockManager.csGets the signal that aborts the request while the lock is not granted.
public AbortSignal? Signal { get; init; }Steal
LockManager.csGets whether the held locks of the resource are released (their requests fail with an AbortError) and the lock is granted before the pending requests.
public bool Steal { get; init; }