platform/api/symfony/Component/Lock/Lock.yaml

102 lines
2.8 KiB
YAML
Raw Normal View History

2024-09-02 17:44:11 +00:00
name: Lock
class_comment: null
dependencies:
- name: LoggerAwareInterface
type: class
source: Psr\Log\LoggerAwareInterface
- name: LoggerAwareTrait
type: class
source: Psr\Log\LoggerAwareTrait
- name: InvalidArgumentException
type: class
source: Symfony\Component\Lock\Exception\InvalidArgumentException
- name: LockAcquiringException
type: class
source: Symfony\Component\Lock\Exception\LockAcquiringException
- name: LockConflictedException
type: class
source: Symfony\Component\Lock\Exception\LockConflictedException
- name: LockExpiredException
type: class
source: Symfony\Component\Lock\Exception\LockExpiredException
- name: LockReleasingException
type: class
source: Symfony\Component\Lock\Exception\LockReleasingException
- name: LoggerAwareTrait
type: class
source: LoggerAwareTrait
properties: []
methods:
- name: __construct
visibility: public
parameters:
- name: key
- name: store
- name: ttl
default: 'null'
- name: autoRelease
default: 'true'
comment: "# * Lock is the default implementation of the LockInterface.\n# *\n# *\
\ @author J\xE9r\xE9my Deruss\xE9 <jeremy@derusse.com>\n# */\n# final class Lock\
\ implements SharedLockInterface, LoggerAwareInterface\n# {\n# use LoggerAwareTrait;\n\
# \n# private bool $dirty = false;\n# \n# /**\n# * @param float|null $ttl \
\ Maximum expected lock duration in seconds\n# * @param bool $autoRelease\
\ Whether to automatically release the lock or not when the lock instance is destroyed"
- name: __sleep
visibility: public
parameters: []
comment: null
- name: __wakeup
visibility: public
parameters: []
comment: null
- name: __destruct
visibility: public
parameters: []
comment: '# * Automatically releases the underlying lock when the object is destructed.'
- name: acquire
visibility: public
parameters:
- name: blocking
default: 'false'
comment: null
- name: acquireRead
visibility: public
parameters:
- name: blocking
default: 'false'
comment: null
- name: refresh
visibility: public
parameters:
- name: ttl
default: 'null'
comment: null
- name: isAcquired
visibility: public
parameters: []
comment: null
- name: release
visibility: public
parameters: []
comment: null
- name: isExpired
visibility: public
parameters: []
comment: null
- name: getRemainingLifetime
visibility: public
parameters: []
comment: null
traits:
- Psr\Log\LoggerAwareInterface
- Psr\Log\LoggerAwareTrait
- Symfony\Component\Lock\Exception\InvalidArgumentException
- Symfony\Component\Lock\Exception\LockAcquiringException
- Symfony\Component\Lock\Exception\LockConflictedException
- Symfony\Component\Lock\Exception\LockExpiredException
- Symfony\Component\Lock\Exception\LockReleasingException
- LoggerAwareTrait
interfaces:
- SharedLockInterface