# flexihash

**Repository Path**: dz/flexihash

## Basic Information

- **Project Name**: flexihash
- **Description**: No description available
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-19
- **Last Updated**: 2022-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Flexihash

[![Build Status](https://travis-ci.org/pda/flexihash.svg?branch=master)](https://travis-ci.org/pda/flexihash) [![Coverage Status](https://coveralls.io/repos/github/pda/flexihash/badge.svg?branch=master)](https://coveralls.io/github/pda/flexihash?branch=master)

Flexihash is a small PHP library which implements [consistent hashing](http://en.wikipedia.org/wiki/Consistent_hashing), which is most useful in distributed caching. It requires PHP5 and uses [PHPUnit](http://simpletest.org/) for unit testing.

## Installation

[Composer](https://getcomposer.org/) is the recommended installation technique. You can find flexihash on [Packagist](https://packagist.org/packages/myphps/flexhash) so installation is as easy as
```
composer require myphps/flexihash
```
or in your `composer.json`
```json
{
    "require": {
        "myphps/flexhash": "^1.0"
    }
}
```

## Usage

```php
$hash = new FlexHash();

// bulk add
$hash->addNodes(['cache-1', 'cache-2', 'cache-3']);

// simple lookup
$hash->lookup('object-a'); // "cache-1"
$hash->lookup('object-b'); // "cache-2"

// add and remove
$hash
  ->addNode('cache-4')
  ->removeNode('cache-1');

// lookup with next-best fallback (for redundant writes)
$hash->getNodes('object', 2); // ["cache-2", "cache-4"]

// remove cache-2, expect object to hash to cache-4
$hash->removeNode('cache-2');
$hash->lookup('object'); // "cache-4"
```

## Tests

### Unit Test

```
% vendor/bin/phpunit
```

### Benchmark Test

```
% vendor/bin/phpunit tests/BenchmarkTest.php
```

## Further Reading

  * http://www.spiteful.com/2008/03/17/programmers-toolbox-part-3-consistent-hashing/
  * http://weblogs.java.net/blog/tomwhite/archive/2007/11/consistent_hash.html