Convenience class for weighted consistent hash rings. More...
Public Member Functions | |
| __construct (array $map) | |
| getLocation ($item) | |
| Get the location of an item on the ring. | |
| getLocations ($item, $limit) | |
| Get the location of an item on the ring, as well as the next clockwise locations. | |
| getLocationWeights () | |
| Get the map of locations to weight (ignores 0-weight items) | |
| newWithoutLocation ($location) | |
| Get a new hash ring with a location removed from the ring. | |
Public Attributes | |
| const | RING_SIZE = 268435456 |
Protected Attributes | |
| Array | $ring = array() |
| (location => (start, end)) * | |
| Array | $sourceMap = array() |
| (location => weight) * | |
Detailed Description
Convenience class for weighted consistent hash rings.
- Since:
- 1.22
Definition at line 29 of file HashRing.php.
Constructor & Destructor Documentation
| HashRing::__construct | ( | array $ | map | ) |
- Parameters:
-
array $map (location => weight)
Definition at line 38 of file HashRing.php.
Member Function Documentation
| HashRing::getLocation | ( | $ | item | ) |
Get the location of an item on the ring.
- Parameters:
-
string $item
- Returns:
- string Location
Definition at line 76 of file HashRing.php.
| HashRing::getLocations | ( | $ | item, |
| $ | limit | ||
| ) |
Get the location of an item on the ring, as well as the next clockwise locations.
- Parameters:
-
string $item integer $limit Maximum number of locations to return
- Returns:
- array List of locations
Definition at line 88 of file HashRing.php.
Get the map of locations to weight (ignores 0-weight items)
- Returns:
- array
Definition at line 122 of file HashRing.php.
| HashRing::newWithoutLocation | ( | $ | location | ) |
Get a new hash ring with a location removed from the ring.
- Parameters:
-
string $location
- Returns:
- HashRing|bool Returns false if no non-zero weighted spots are left
Definition at line 132 of file HashRing.php.
Member Data Documentation
Array HashRing::$ring = array() [protected] |
(location => (start, end)) *
Definition at line 31 of file HashRing.php.
Array HashRing::$sourceMap = array() [protected] |
(location => weight) *
Definition at line 30 of file HashRing.php.
| const HashRing::RING_SIZE = 268435456 |
Definition at line 33 of file HashRing.php.
The documentation for this class was generated from the following file:
- includes/HashRing.php
