org.apache.flink.runtime.state.gemini.engine.vm.FutureDataPage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.5.1
/*
 * 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.runtime.state.gemini.engine.vm;

import org.apache.flink.runtime.state.gemini.engine.exceptions.GeminiRuntimeException;
import org.apache.flink.runtime.state.gemini.engine.rm.GByteBuffer;

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;

/**
 * FutureDataPage. Note that it should responsible for the retain and release of {@link org.apache.flink.runtime.state.gemini.engine.page.DataPage}
 * wrapped by it.
 */
public class FutureDataPage {
	private final int size;
	private final CompletableFuture dataPageCompletedFuture;
	private volatile boolean removed = false;

	public FutureDataPage(int size) {
		this.size = size;
		this.dataPageCompletedFuture = new CompletableFuture<>();
	}

	FutureDataPage(
		GByteBuffer gByteBuffer) {
		this.size = gByteBuffer.capacity();
		this.dataPageCompletedFuture = CompletableFuture.completedFuture(gByteBuffer);
		gByteBuffer.retain();
	}

	public int getSize() {
		return this.size;
	}

	public boolean complete(GByteBuffer gByteBuffer) {
		boolean result = this.dataPageCompletedFuture.complete(gByteBuffer);
		if (result && !removed) {
			gByteBuffer.retain();
		}
		return result;
	}

	public void completeExceptionally(Throwable throwable) {
		this.dataPageCompletedFuture.completeExceptionally(throwable);
	}

	public GByteBuffer get() {
		try {
			return this.dataPageCompletedFuture.get();
		} catch (Exception e) {
			throw new GeminiRuntimeException("FutureDataPage error:" + e.getMessage(), e);
		}
	}

	public GByteBuffer get(int timeout) {
		try {
			return this.dataPageCompletedFuture.get(timeout, TimeUnit.MILLISECONDS);
		} catch (Exception e) {
			throw new GeminiRuntimeException("FutureDataPage error, Msg=" + e.getMessage() + " ,cause=" + e.getClass().getSimpleName(),
				e);
		}
	}

	public boolean isFail() {
		return dataPageCompletedFuture.isCompletedExceptionally();
	}

	public boolean isDone() {
		return dataPageCompletedFuture.isDone();
	}

	public void removed() {
		if (removed) {
			return;
		}
		removed = true;
		if (isDone() && !isFail()) {
			try {
				GByteBuffer gByteBuffer = dataPageCompletedFuture.get();
				gByteBuffer.release();
			} catch (Exception e) {
				throw new GeminiRuntimeException(e);
			}
		}
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}

		if (obj == null || obj.getClass() != getClass()) {
			return false;
		}

		FutureDataPage other = (FutureDataPage) obj;
		return size == other.size && dataPageCompletedFuture.equals(other.dataPageCompletedFuture) && removed == other.removed;
	}

	@Override
	public int hashCode() {
		int hashCode = size;
		hashCode = hashCode * 31 + dataPageCompletedFuture.hashCode();
		hashCode = hashCode * 31 + (removed ? 1 : 0);
		return hashCode;
	}
}