1. interface
  2. Illuminate
  3. \
  4. Contracts
  5. \
  6. Cache
  7. \
  8. Lock

Lock

interface Lock (View source)

Methods

mixed
get(callable|null $callback = null)

Attempt to acquire the lock.

mixed
block(int $seconds, callable|null $callback = null)

Attempt to acquire the lock for the given number of seconds.

bool
release()

Release the lock.

string
owner()

Returns the current owner of the lock.

void
forceRelease()

Releases this lock in disregard of ownership.

Details

at line 13
mixed get(callable|null $callback = null)

Attempt to acquire the lock.

Parameters

callable|null $callback

Return Value

mixed

at line 24
mixed block(int $seconds, callable|null $callback = null)

Attempt to acquire the lock for the given number of seconds.

Parameters

int $seconds
callable|null $callback

Return Value

mixed

Exceptions

LockTimeoutException

at line 31
bool release()

Release the lock.

Return Value

bool

at line 38
string owner()

Returns the current owner of the lock.

Return Value

string

at line 45
void forceRelease()

Releases this lock in disregard of ownership.

Return Value

void