org.coos.messaging.routing.RoutingAlgorithm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of messaging-lib
There is a newer version: 1.3.1
/**
 * COOS - Connected Objects Operating System (www.connectedobjects.org).
 *
 * Copyright (C) 2009 Telenor ASA and Tellu AS. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * You may also contact one of the following for additional information:
 * Telenor ASA, Snaroyveien 30, N-1331 Fornebu, Norway (www.telenor.no)
 * Tellu AS, Hagalokkveien 13, N-1383 Asker, Norway (www.tellu.no)
 */
package org.coos.messaging.routing;

import java.util.Map;

import org.coos.messaging.Link;
import org.coos.messaging.Message;
import org.coos.messaging.Service;

/**
 * @author Knut Eilif Husa, Tellu AS
 * 
 */
public interface RoutingAlgorithm extends Service {

    /**
     * Initialises the algorithm with the routerUuid (segment dependent) and the router
     * @param routerUuid the router uuid
     * @param router the router
     */
	public void init(String routerUuid, Router router);
	
	/**
	 * Sets the routing table into the algorithm
	 * @param routingTable
	 */
	void setRoutingTables(Map routingTable);

	/**
	 * Returns the uuid of the router in the router segment that this algorithm serves
	 * @return the uuid of the router
	 */
	String getRouterUuid();
	
	/**
	 * 
	 * The method called with message that is destined towards this router
	 * @param routingInfo
	 */
	void processRoutingInfo(Message routingInfo);

	/**
	 * Enables logging info of this algorithm. Typically writers out the routing tables
	 * @param loggingEnabled
	 */
	void setLoggingEnabled(boolean loggingEnabled);

	/**
	 * Sets the links used by the algorithm into the algorithm
	 * @param links the links
	 */
	void setLinks(Map links);

	/**
	 * Publishes link into the segment that this algorithm serves
	 * @param link the link to be published by the algorithm
	 */
	void publishLink(Link link);
	
	/**
	 * Copies the algorithm
	 * @return a cloned instance of the algorithm
	 */
	RoutingAlgorithm copy();
	
	/**
	 * Returns the algorithm name
	 * @return the algorithm name
	 */
	String getAlgorithmName();

}