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.client;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.audience.ClientSide;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.io.naming.Identifiable;
025import org.apache.reef.runtime.common.client.RunningJobImpl;
026import org.apache.reef.tang.annotations.DefaultImplementation;
027
028/**
029 * Represents a running REEF job.
030 */
031@Public
032@ClientSide
033@Provided
034@DefaultImplementation(RunningJobImpl.class)
035public interface RunningJob extends Identifiable, AutoCloseable {
036
037  /**
038   * Cancels the running Job.
039   */
040  @Override
041  void close();
042
043  /**
044   * Cancels the running Job.
045   *
046   * @param message delivered along with cancel request.
047   */
048  void close(final byte[] message);
049
050  /**
051   * @return the ID of the running job.
052   */
053  @Override
054  String getId();
055
056  /**
057   * Send a message to the Driver.
058   *
059   * @param message to send to the running driver
060   */
061  void send(final byte[] message);
062}