co.edu.uniquindio.chord.Chord Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jdhtuq-chord Show documentation

Defines the lookup service using the Chord algorithm

There is a newer version: 2.0.2

/*
 *  Chord project implement of lookup algorithm Chord
 *  Copyright (C) 2010 - 2018  Daniel Pelaez
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see .
 *
 */

package co.edu.uniquindio.chord;

import co.edu.uniquindio.chord.node.ChordNode;
import co.edu.uniquindio.overlay.OverlayNode;
import co.edu.uniquindio.overlay.Key;

/**
 * The {@code Chord} interface defines the basic methods for creating the node
 * on chord's ring.
 * 
 * @author Daniel Pelaez
 * @author Hector Hurtado
 * @author Daniel Lopez
 * @version 1.0, 17/06/2010
 * @since 1.0
 * @see ChordNode
 * @see Key
 * @see OverlayNode
 */
public interface Chord extends OverlayNode {
	/**
	 * Finds the node on the ring that is the successor of the given key.
	 * 
	 * @param id
	 *            The key to find
	 * @return A {@link Key} that is the successor for the id.
	 */
	Key lookUp(Key id);

	/**
	 * Gets the {@link Key} of the chord node.
	 * 
	 * @return The {@link Key} of the chord node.
	 */
	Key getKey();
}