2 * Sonitus - DelayFilter.java - Copyright © 2013 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sonitus.data.filter;
20 import java.io.IOException;
21 import java.util.logging.Logger;
23 import net.pterodactylus.sonitus.data.AbstractFilter;
24 import net.pterodactylus.sonitus.data.DataPacket;
25 import net.pterodactylus.sonitus.data.Filter;
26 import net.pterodactylus.sonitus.data.Metadata;
29 * Rate limiting filter that only passes a specified amount of data per second
30 * from its {@link net.pterodactylus.sonitus.data.Source} to its {@link
31 * net.pterodactylus.sonitus.data.Sink}.
33 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35 public class RateLimitingFilter extends AbstractFilter implements Filter {
38 private static final Logger logger = Logger.getLogger(RateLimitingFilter.class.getName());
40 /** The limiting rate in bytes/second. */
41 private final int rate;
43 /** The start time. */
44 private long startTime;
46 /** The number of bytes. */
50 * Creates a new rate limiting filter.
53 * The name of the filter
56 public RateLimitingFilter(String name, int rate) {
61 * Creates a new rate limiting filter.
64 * The name of the filter
66 * The limiting rate (in bytes/second)
67 * @param fastStartTime
68 * The amount of time at the start of the filtering during which no delay
70 public RateLimitingFilter(String name, int rate, long fastStartTime) {
73 this.counter = (long) (-rate * (fastStartTime / 1000.0));
81 public void open(Metadata metadata) throws IOException {
83 startTime = System.currentTimeMillis();
87 public void process(DataPacket dataPacket) throws IOException {
88 super.process(dataPacket);
90 counter += dataPacket.buffer().length;
91 long waitTime = (long) (counter / (rate / 1000.0));
92 while ((System.currentTimeMillis() - startTime) < waitTime) {
94 long limitDelay = waitTime - (System.currentTimeMillis() - startTime);
95 logger.finest(String.format("Waiting %d ms...", limitDelay));
96 Thread.sleep(limitDelay);
97 } catch (InterruptedException ie1) {
98 /* ignore, keep looping. */
101 logger.finest(String.format("Processed %d Bytes during %d ms, that’s %.1f bytes/s.", counter, System.currentTimeMillis() - startTime, counter / ((System.currentTimeMillis() - startTime) / 1000.0)));