net.spy.memcached.NodeLocator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spymemcached Show documentation

A client library for memcached.

There is a newer version: 2.8.4

package net.spy.memcached;

import net.spy.memcached.vbucket.config.Config;

import java.util.Collection;
import java.util.Iterator;
import java.util.List;

/**
 * Interface for locating a node by hash value.
 */
public interface NodeLocator {

	/**
	 * Get the primary location for the given key.
	 *
	 * @param k the object key
	 * @return the QueueAttachment containing the primary storage for a key
	 */
	MemcachedNode getPrimary(String k);

	/**
	 * Get an iterator over the sequence of nodes that make up the backup
	 * locations for a given key.
	 *
	 * @param k the object key
	 * @return the sequence of backup nodes.
	 */
	Iterator getSequence(String k);

	/**
	 * Get all memcached nodes.  This is useful for broadcasting messages.
	 */
	Collection getAll();

	/**
	 * Create a read-only copy of this NodeLocator.
	 */
	NodeLocator getReadonlyCopy();

	/**
	 * Update locator status.
	 *
	 * @param nodes New locator nodes.
	 * @param conf Locator configuration.
	 */
	public void updateLocator(final List nodes, final Config conf);
}