org.mobicents.commons.congestion.CongestionMonitor Maven / Gradle / Ivy
/*
* TeleStax, Open Source Cloud Communications.
* Copyright 2012 and individual contributors by the @authors tag.
*
* This 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 2.1 of
* the License, or (at your option) any later version.
*
* This software 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 software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.mobicents.commons.congestion;
/**
* The user who is interested in monitoring the underlying source should
* implement this interface.
*
* @author amit bhayani
*
*/
public interface CongestionMonitor {
/**
* The user should call this method periodically to monitor underlying
* resource
*/
public void monitor();
/**
* Add {@link CongestionListener}
*
* @param listener
*/
public void addCongestionListener(CongestionListener listener);
/**
* Remove {@link CongestionListener}
*
* @param listener
*/
public void removeCongestionListener(CongestionListener listener);
/**
* Get the name of underlying source
*
* @return
*/
public String getSource();
}