Google Cloud PHP shared dependency, providing functionality useful to all components. Client - Class FlockLock (1.60.0)

Version latest

• 1.60.0 (latest)
• 1.59.1
• 1.58.2
• 1.53.0
• 1.52.11
• 1.51.2
• 1.50.0
• 1.49.3
• 1.48.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class FlockLock.

Flock based lock implementation.

Namespace

Google \ Cloud \ Core \ Lock

Methods

__construct

Parameters
Name	Description
fileName	string The name of the file to use as a lock.
options	array Configuration options.
↳ exclusive	bool If true, acquire an excluse (write) lock. If false, acquire a shared (read) lock. Defaults to true.

acquire

Acquires a lock that will block until released.

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.

Constants

FILE_PATH_TEMPLATE

Value: '%s/%s.lock'