reactor.rx.stream.FutureStream Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of reactor-stream Show documentation
Reactor Stream components
The newest version!
/*
 * Copyright (c) 2011-2014 Pivotal Software, Inc.
 *
 *  Licensed 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 reactor.rx.stream;

import org.reactivestreams.Subscriber;
import reactor.core.support.Exceptions;
import reactor.rx.Stream;
import reactor.rx.action.Action;
import reactor.rx.subscription.ReactiveSubscription;

import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

/**
 * A Stream that emits a result of a {@link java.util.concurrent.Future} and then complete.
 * 
 * Since the stream retains the future reference in a final field, any
 * {@link this#subscribe(org.reactivestreams.Subscriber)}
 * will replay the {@link java.util.concurrent.Future#get()}
 * 

 * Create such stream with the provided factory, E.g.:
 * 
 * {@code
 * Streams.just(someFuture).consume(
 * log::info,
 * log::error,
 * (-> log.info("complete"))
 * )
 * }
 * 
 *  * Will log:
 * {@code
 * 1
 * 2
 * 3
 * 4
 * complete
 * }
 * 
 *
 * @author Stephane Maldini
 */
public final class FutureStream extends Stream {

	private final Future future;
	private final long                time;
	private final TimeUnit            unit;

	public FutureStream(Future future) {
		this(future, 0, null);
	}

	public FutureStream(Future future,
	                    long time,
	                    TimeUnit unit) {
		this.future = future;
		this.time = time;
		this.unit = unit;
	}

	@Override
	public void subscribe(final Subscriber subscriber) {
		try {
			subscriber.onSubscribe(new ReactiveSubscription(this, subscriber) {

				@Override
				public void request(long elements) {
					Action.checkRequest(elements);
					if (isComplete()) return;

					try {
						T result = unit == null ? future.get() : future.get(time, unit);

						subscriber.onNext(result);
						onComplete();

					} catch (Throwable e) {
						onError(e);
					}
				}
			});
		} catch (Throwable throwable) {
			Exceptions.throwIfFatal(throwable);
			subscriber.onError(throwable);
		}
	}
}