rych/lock

Simple lockfile management class.

Maintainers

Details

github.com/rchouinard/lock

Source

Issues

Installs: 218

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 3

Open Issues: 1

1.0.0 2014-07-16 01:08 UTC

Requires

  • php: >=5.3.0

Requires (Dev)

MIT 4d345a1c09dbb4f36b9ceb81cda59aac32d82833

  • Ryan Chouinard <rchouinard.woop@gmail.com>

This package is auto-updated.

Last update: 2024-11-23 11:41:02 UTC

README

Simple process lock management library.

Installation

Installation is best managed via Composer.

{
    "require": {
        "rych/lock": "1.0.*"
    }
}

Or:

composer require rych/lock=1.0.*

Usage

<?php

$lock = new \Rych\Lock\Lock("lock-name", "/path/to/locks");
if ($lock->lock()) {
    // Do work here
} else {
    die ("Unable to acquire lock! Make sure no other process is running!");
}

$lock->unlock();

Methods

  • bool \Rych\Lock\Lock::__construct( string $name [, string $bucket = null ] )
  • bool \Rych\Lock\Lock::lock( [ bool $block = false ] )
  • bool \Rych\Lock\Lock::unlock()
  • bool \Rych\Lock\Lock::check( [ string &$pidof = null ] )