/*
* Copyright 2004 - 2008 Christian Sprajc, Dennis Waldherr. All rights reserved.
*
* This file is part of PowerFolder.
*
* PowerFolder is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* PowerFolder 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.
*
* You should have received a copy of the GNU General Public License
* along with PowerFolder. If not, see <http://www.gnu.org/licenses/>.
*
* $Id$
*/
package de.dal33t.powerfolder.transfer;

/**
 * Streams which implement this interface are able to throttle their throughput.
 * @author Dante
 * $Id$
 * @author Dennis "Dante" Waldherr
 * @version $Revision: 1.1 $
 *
 */
public interface LimitedStream {
    BandwidthLimiter getBandwidthLimiter();
    
    /**
     * Sets a new limiter.
     * You should NOT change the BandwidthLimiter while any limited operation
     * is ongoing. (= This method is NOT Thread safe)
     * @param limiter the new limiter
     */
    void setBandwidthLimiter(BandwidthLimiter limiter);
}