ITimeoutEstimation.java

/**
 * Copyright (C) 2008 - 2014 52°North Initiative for Geospatial Open Source
 * Software GmbH
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation.
 *
 * If the program is linked with libraries which are licensed under one of
 * the following licenses, the combination of the program with the linked
 * library is not considered a "derivative work" of the program:
 *
 *     - Apache License, version 2.0
 *     - Apache Software License, version 1.0
 *     - GNU Lesser General Public License, version 3
 *     - Mozilla Public License, versions 1.0, 1.1 and 2.0
 *     - Common Development and Distribution License (CDDL), version 1.0
 *
 * Therefore the distribution of the program linked with libraries licensed
 * under the aforementioned licenses, is permitted by the copyright holders
 * if the distribution is compliant with both the GNU General Public
 * icense version 2 and the aforementioned licenses.
 *
 * 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 General
 * Public License for more details.
 */
package org.n52.ses.util.concurrent;

/**
 * Interface for a timeout estimation algorithm impl used
 * by instances of {@link IConcurrentNotificationHandler}.
 * 
 * @author matthes rieke <m.rieke@52north.org>
 *
 */
public interface ITimeoutEstimation {

	/**
	 * @param timeout the initial timeout
	 */
	void setMaximumTimeout(int timeout);

	/**
	 * @param l update the data with a new measured processing period
	 */
	void updateTimeout(long l);

	/**
	 * @param l update the data with a new measured processing period
	 * @param onFailure flag for processing failure, could be used to weight periods
	 */
	void updateTimeout(long l, boolean onFailure);

	/**
	 * @return the estimated timeout calculated by the underlying algorithm
	 */
	int getCurrenTimeout();

	/**
	 * @param l the minimum timeout
	 */
	void setMinimumTimeout(int l);

}