api/laravel/Cache/DynamoDbLock.yaml
2024-09-26 02:03:21 -07:00

59 lines
1.3 KiB
YAML

name: DynamoDbLock
class_comment: null
dependencies: []
properties:
- name: dynamo
visibility: protected
comment: '# * The DynamoDB client instance.
# *
# * @var \Illuminate\Cache\DynamoDbStore'
methods:
- name: __construct
visibility: public
parameters:
- name: dynamo
- name: name
- name: seconds
- name: owner
default: 'null'
comment: "# * The DynamoDB client instance.\n# *\n# * @var \\Illuminate\\Cache\\\
DynamoDbStore\n# */\n# protected $dynamo;\n# \n# /**\n# * Create a new lock instance.\n\
# *\n# * @param \\Illuminate\\Cache\\DynamoDbStore $dynamo\n# * @param string\
\ $name\n# * @param int $seconds\n# * @param string|null $owner\n# * @return\
\ void"
- name: acquire
visibility: public
parameters: []
comment: '# * Attempt to acquire the lock.
# *
# * @return bool'
- name: release
visibility: public
parameters: []
comment: '# * Release the lock.
# *
# * @return bool'
- name: forceRelease
visibility: public
parameters: []
comment: '# * Release this lock in disregard of ownership.
# *
# * @return void'
- name: getCurrentOwner
visibility: protected
parameters: []
comment: '# * Returns the owner value written into the driver for this lock.
# *
# * @return mixed'
traits: []
interfaces: []