Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.vortex.common;
020
021import org.apache.reef.annotations.Unstable;
022import org.apache.reef.annotations.audience.DriverSide;
023import org.apache.reef.annotations.audience.Private;
024
025import java.util.List;
026
027/**
028 * Exposes functions to be called by the {@link org.apache.reef.vortex.driver.VortexMaster}
029 * to note that a list of Tasklets associated with a Future has completed.
030 */
031@Unstable
032@DriverSide
033@Private
034public interface VortexFutureDelegate {
035
036  /**
037   * A Tasklet associated with the future has completed with a result.
038   * The result should be decoded as in {@link org.apache.reef.vortex.api.VortexFuture#completed(int, byte[])}.
039   */
040  void completed(final int taskletId, final byte[] serializedResult);
041
042  /**
043   * The list of aggregated Tasklets associated with the Future that have completed with a result.
044   */
045  void aggregationCompleted(final List<Integer> taskletIds, final byte[] serializedResult);
046
047  /**
048   * A Tasklet associated with the Future has thrown an Exception.
049   */
050  void threwException(final int taskletId, final Exception exception);
051
052  /**
053   * The list of Tasklets associated with the Future that have thrown an Exception.
054   */
055  void aggregationThrewException(final List<Integer> taskletIds, final Exception exception);
056
057  /**
058   * A Tasklet associated with the Future has been cancelled.
059   */
060  void cancelled(final int taskletId);
061}