acquireWriteLock Method
Attempt to acquire the write lock for this CloudContainer. For this to succeed:
- it must be connected to a
CloudCache
- this CloudContainer must have been constructed with
writeable: true
- the
accessToken
must authorize write access - no other process may be holding an unexpired write lock
acquireWriteLock(user: string): void
throws exception if any of the above conditions fail
note Write locks expire after the duration specified in the durationSeconds
property of the constructor argument, in case a process
crashes or otherwise fails to release the lock. Calling acquireWriteLock
with the lock already held resets the lock duration from the current time,
so long running processes should call this method periodically to ensure their lock doesn't expire (they should also make sure their accessToken is refreshed
before it expires.)
note on success, the manifest is polled before the promise resolves.
Returns - void
Last Updated: 20 June, 2023