[Lock] Add an auto release tips #8845
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jderusse
force-pushed
the
lock-auto-destruct
branch
from
13d8cb2 to
69bdba4
Compare
xabbuh
reviewed
Jan 2, 2018
components/lock.rst
Outdated
| @@ -62,6 +62,13 @@ method can be safely called repeatedly, even if the lock is already acquired. | |||
| to be used by several services, they should share the same ``Lock`` instance | |||
| returned by the ``Factory::createLock`` method. | |||
|
|
|||
| .. tip:: | |||
| While it's recommended to release the ``Lock`` as soon as it is no longer | |||
There was a problem hiding this comment.
I would reword the paragraph a bit:
.. tip::
While it's recommended to release the lock as soon as it is no longer
required, it will automatically be released on instance destruction. In
some cases, it can be useful to lock a resource across several requests.
To disable the automatic release behavior, set the third argument of
the ``createLock()`` method to ``false``.
|
Thanks Jérémy. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.