wyrihaximus/react-mutex

Mutex locking for ReactPHP projects

1.0.0 2019-02-25 20:23 UTC

README

Build Status Latest Stable Version Total Downloads Code Coverage License

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-mutex

About

This package provides two things:

  • An interface for mutex locking
  • A in-memory implementation of that interface

Usage

$key = 'key'; // Unique key for this operation
$mutex = new Memory();
$mutex->acquire($key)->then(function ($lock) use ($mutex) {
    if (!($lock instanceof Lock)) {
        // We couldn't aquired the lock on this key
        return;
    }
    
    // We aquired the lock on this key
    // Do long running non-blocking thing
    $mutex->release($lock);
});

License

The MIT License (MIT)

Copyright (c) 2019 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.