Class KetamaMemcachedSessionLocator

java.lang.Object

net.rubyeye.xmemcached.impl.AbstractMemcachedSessionLocator

net.rubyeye.xmemcached.impl.KetamaMemcachedSessionLocator

All Implemented Interfaces:

MemcachedSessionLocator

public class KetamaMemcachedSessionLocator
extends AbstractMemcachedSessionLocator

Consistent Hash Algorithm implementation,based on TreeMap.tailMap(hash) method.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	cwNginxUpstreamConsistent
(package private) static final int	DEFAULT_PORT	compatible with nginx-upstream-consistent,patched by wolfg1969
private final boolean	gwhalinMemcachedJavaClientCompatibiltyConsistent
private final HashAlgorithm	hashAlg
private TreeMap<Long, List<Session>>	ketamaSessions
private int	maxTries
(package private) static final int	NUM_REPS

Fields inherited from class AbstractMemcachedSessionLocator

failureMode

Constructor Summary

Constructors

Constructor	Description
KetamaMemcachedSessionLocator()	Create a KetamaMemcachedSessionLocator with default config.
KetamaMemcachedSessionLocator(boolean cwNginxUpstreamConsistent)	Create a KetamaMemcachedSessionLocator
KetamaMemcachedSessionLocator(List<Session> list, HashAlgorithm alg)
KetamaMemcachedSessionLocator(HashAlgorithm alg)	Create a KetamaMemcachedSessionLocator with a special hash algorithm.
KetamaMemcachedSessionLocator(HashAlgorithm alg, boolean cwNginxUpstreamConsistent)
KetamaMemcachedSessionLocator(HashAlgorithm alg, boolean cwNginxUpstreamConsistent, boolean gwhalinMemcachedJavaClientCompatibiltyConsistent)

Method Summary

Modifier and Type	Method	Description
private final void	buildMap(Collection<Session> list, HashAlgorithm alg)
final Session	getSessionByHash(long hash)
final Session	getSessionByKey(String key)	Returns a session by special key.
private List<Session>	getSessionList(TreeMap<Long, List<Session>> sessionMap, long k)
private String	getSockStr(Session session)
final long	nextHash(long hashVal, String key, int tries)
final void	updateSessions(Collection<Session> list)	Update sessions when session was added or removed.

Methods inherited from class AbstractMemcachedSessionLocator

setFailureMode

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NUM_REPS

static final int NUM_REPS

See Also:

• Constant Field Values

ketamaSessions

private transient volatile TreeMap<Long, List<Session>> ketamaSessions

hashAlg

private final HashAlgorithm hashAlg

maxTries

private int maxTries

DEFAULT_PORT

static final int DEFAULT_PORT

compatible with nginx-upstream-consistent,patched by wolfg1969

See Also:

• Constant Field Values

cwNginxUpstreamConsistent

private final boolean cwNginxUpstreamConsistent

gwhalinMemcachedJavaClientCompatibiltyConsistent

private final boolean gwhalinMemcachedJavaClientCompatibiltyConsistent

Constructor Details

KetamaMemcachedSessionLocator

public KetamaMemcachedSessionLocator()

Create a KetamaMemcachedSessionLocator with default config.

KetamaMemcachedSessionLocator

public KetamaMemcachedSessionLocator(boolean cwNginxUpstreamConsistent)

Create a KetamaMemcachedSessionLocator

Parameters:

cwNginxUpstreamConsistent - true if compatible with nginx up stream memcached consistent algorithm.

KetamaMemcachedSessionLocator

public KetamaMemcachedSessionLocator(HashAlgorithm alg)

Create a KetamaMemcachedSessionLocator with a special hash algorithm.

Parameters:

alg -

KetamaMemcachedSessionLocator

public KetamaMemcachedSessionLocator(HashAlgorithm alg,
 boolean cwNginxUpstreamConsistent)

KetamaMemcachedSessionLocator

public KetamaMemcachedSessionLocator(HashAlgorithm alg,
 boolean cwNginxUpstreamConsistent,
 boolean gwhalinMemcachedJavaClientCompatibiltyConsistent)

KetamaMemcachedSessionLocator

public KetamaMemcachedSessionLocator(List<Session> list,
 HashAlgorithm alg)

Method Details

buildMap

private final void buildMap(Collection<Session> list,
 HashAlgorithm alg)

getSockStr

private String getSockStr(Session session)

getSessionList

private List<Session> getSessionList(TreeMap<Long, List<Session>> sessionMap,
 long k)

getSessionByKey

public final Session getSessionByKey(String key)

Description copied from interface: MemcachedSessionLocator

Returns a session by special key.

Parameters:

key -

Returns:

getSessionByHash

public final Session getSessionByHash(long hash)

nextHash

public final long nextHash(long hashVal,
 String key,
 int tries)

updateSessions

public final void updateSessions(Collection<Session> list)

Description copied from interface: MemcachedSessionLocator

Update sessions when session was added or removed.

Parameters:

list - The newer sessions