net.spy.memcached.util.KetamaNodeLocatorConfiguration Maven / Gradle / Ivy

Go to download
package net.spy.memcached.util;

import net.spy.memcached.MemcachedNode;

/**
 * Defines the set of all configuration dependencies
 * required for the KetamaNodeLocator algorithm to run
 */
public interface KetamaNodeLocatorConfiguration {

    /**
     * Returns a uniquely identifying key, suitable for hashing by the
     * KetamaNodeLocator algorithm.

     * @param node The MemcachedNode to use to form the unique identifier
     * @param repetition The repetition number for the particular node in
     * 	      question (0 is the first repetition)
     * @return The key that represents the specific repetition of the node
     */
    public String getKeyForNode(MemcachedNode node, int repetition);

    /**
     * Returns the number of discrete hashes that should be defined for each
     * node in the continuum.
     *
     * @return a value greater than 0
     */
    int getNodeRepetitions();

}