\OCP\LockILockingProvider

Interface ILockingProvider

Summary

Methods
Constants
isLocked()
acquireLock()
releaseLock()
changeLock()
releaseAll()
LOCK_SHARED
LOCK_EXCLUSIVE
No protected methods found
N/A
No private methods found
N/A

Constants

LOCK_SHARED

LOCK_SHARED

LOCK_EXCLUSIVE

LOCK_EXCLUSIVE

Methods

isLocked()

isLocked(string  $path, integer  $type) : boolean

Parameters

string $path
integer $type

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Returns

boolean

acquireLock()

acquireLock(string  $path, integer  $type) 

Parameters

string $path
integer $type

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Throws

\OCP\Lock\LockedException

releaseLock()

releaseLock(string  $path, integer  $type) 

Parameters

string $path
integer $type

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

changeLock()

changeLock(string  $path, integer  $targetType) 

Change the type of an existing lock

Parameters

string $path
integer $targetType

self::LOCK_SHARED or self::LOCK_EXCLUSIVE

Throws

\OCP\Lock\LockedException

releaseAll()

releaseAll() 

release all lock acquired by this instance