Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class LockInterface.
Contract for a basic locking mechanism.
Namespace
Google \ Cloud \ Core \ LockMethods
acquire
Acquires a lock.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Configuration options. |
↳ blocking |
bool
Whether the process should block while waiting to acquire the lock. Defaults to true. |
| Returns | |
|---|---|
| Type | Description |
bool |
|
release
Releases the lock.
synchronize
Execute a callable within a lock.
| Parameters | |
|---|---|
| Name | Description |
func |
callable
The callable to execute. |
options |
array
Configuration options. |
↳ blocking |
bool
Whether the process should block while waiting to acquire the lock. Defaults to true. |
| Returns | |
|---|---|
| Type | Description |
mixed |
|