arvenil/ninja-mutex

View on GitHub
src/Lock/LockInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/**
 * This file is part of ninja-mutex.
 *
 * (C) Kamil Dziedzic <arvenil@klecza.pl>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NinjaMutex\Lock;

/**
 * Lock implementor
 *
 * @author Kamil Dziedzic <arvenil@klecza.pl>
 */
interface LockInterface
{
    /**
     * @param  string   $name
     * @param  null|int $timeout
     * @return bool
     */
    public function acquireLock($name, $timeout = null);

    /**
     * @param  string $name
     * @return bool
     */
    public function releaseLock($name);

    /**
     * @param  string $name
     * @return bool
     */
    public function isLocked($name);
}