Inheritance diagram for Drupal\tripal_biodb\Lock\LockInfoInterface:
Public Member Functions | |
| getStartTime (string $name) | |
| getCurrentExpirationTime (string $name) | |
| getCurrentExpirationDelay (string $name) | |
| getOwner (string $name) | |
| getOwnerPid (string $name) | |
Detailed Description
Lock information interface.
Defines methods to get lock informations such as lock owner, expiration and such.
Member Function Documentation
◆ getCurrentExpirationDelay()
| Drupal\tripal_biodb\Lock\LockInfoInterface::getCurrentExpirationDelay | ( | string | $name | ) |
Returns the lock time remaining in seconds.
Note: this delay may be extended by the lock owner.
- Parameters
-
string $name Name of the lock.
- Returns
- float The lock remaining time in seconds or 0 if not available or expired.
Implemented in Drupal\tripal_biodb\Lock\PersistentDatabaseSharedLockBackend.
◆ getCurrentExpirationTime()
| Drupal\tripal_biodb\Lock\LockInfoInterface::getCurrentExpirationTime | ( | string | $name | ) |
Returns the lock expiration time in seconds.
Note: this time may be extended by the lock owner.
- Parameters
-
string $name Name of the lock.
- Returns
- float The lock expiration time in seconds or 0 if not available.
Implemented in Drupal\tripal_biodb\Lock\PersistentDatabaseSharedLockBackend.
◆ getOwner()
| Drupal\tripal_biodb\Lock\LockInfoInterface::getOwner | ( | string | $name | ) |
Returns the lock owner name.
- Parameters
-
string $name Name of the lock.
- Returns
- string The lock owner name or an empty string if not available.
Implemented in Drupal\tripal_biodb\Lock\PersistentDatabaseSharedLockBackend.
◆ getOwnerPid()
| Drupal\tripal_biodb\Lock\LockInfoInterface::getOwnerPid | ( | string | $name | ) |
Returns the system process identifier using the lock.
- Parameters
-
string $name Name of the lock.
- Returns
- int The system process identifier using this lock or 0 if not available.
◆ getStartTime()
| Drupal\tripal_biodb\Lock\LockInfoInterface::getStartTime | ( | string | $name | ) |
Returns the time in seconds when the lock started.
- Parameters
-
string $name Name of the lock.
- Returns
- float The lock starting time in seconds or 0 if not available.
The documentation for this interface was generated from the following file:
- tripal_biodb/src/Lock/LockInfoInterface.php
