org.apache.flink.streaming.examples.utils.ThrottledIterator Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.streaming.examples.utils;

import java.io.Serializable;
import java.util.Iterator;

import static java.util.Objects.requireNonNull;

/**
 * A variant of the collection source (emits a sequence of elements as a stream)
 * that supports throttling the emission rate.
 * @param 
 */
public class ThrottledIterator implements Iterator, Serializable {

	private static final long serialVersionUID = 1L;

	@SuppressWarnings("NonSerializableFieldInSerializableClass")
	private final Iterator source;

	private final long sleepBatchSize;
	private final long sleepBatchTime;

	private long lastBatchCheckTime;
	private long num;

	public ThrottledIterator(Iterator source, long elementsPerSecond) {
		this.source = requireNonNull(source);

		if (!(source instanceof Serializable)) {
			throw new IllegalArgumentException("source must be java.io.Serializable");
		}

		if (elementsPerSecond >= 100) {
			// how many elements would we emit per 50ms
			this.sleepBatchSize = elementsPerSecond / 20;
			this.sleepBatchTime = 50;
		}
		else if (elementsPerSecond >= 1) {
			// how long does element take
			this.sleepBatchSize = 1;
			this.sleepBatchTime = 1000 / elementsPerSecond;
		}
		else {
			throw new IllegalArgumentException("'elements per second' must be positive and not zero");
		}
	}

	@Override
	public boolean hasNext() {
		return source.hasNext();
	}

	@Override
	public T next() {
		// delay if necessary
		if (lastBatchCheckTime > 0) {
			if (++num >= sleepBatchSize) {
				num = 0;

				final long now = System.currentTimeMillis();
				final long elapsed = now - lastBatchCheckTime;
				if (elapsed < sleepBatchTime) {
					try {
						Thread.sleep(sleepBatchTime - elapsed);
					} catch (InterruptedException e) {
						// restore interrupt flag and proceed
						Thread.currentThread().interrupt();
					}
				}
				lastBatchCheckTime = now;
			}
		} else {
			lastBatchCheckTime = System.currentTimeMillis();
		}

		return source.next();
	}

	@Override
	public void remove() {
		throw new UnsupportedOperationException();
	}
}