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.driver.task;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.audience.DriverSide;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.driver.context.ActiveContext;
025import org.apache.reef.io.naming.Identifiable;
026import org.apache.reef.runtime.common.driver.task.TaskRepresenter;
027
028/**
029 * Represents a running Task.
030 */
031@DriverSide
032@Public
033@Provided
034public interface RunningTask extends Identifiable, AutoCloseable {
035
036
037  /**
038   * @return the context the task is running on.
039   */
040  ActiveContext getActiveContext();
041
042
043  /**
044   * Sends the message to the running task.
045   *
046   * @param message to be sent to the running task
047   */
048  void send(final byte[] message);
049
050  /**
051   * Signal the task to suspend.
052   *
053   * @param message a message that is sent to the Task.
054   */
055  void suspend(final byte[] message);
056
057  /**
058   * Signal the task to suspend.
059   */
060  void suspend();
061
062  /**
063   * Signal the task to shut down.
064   *
065   * @param message a message that is sent to the Task.
066   */
067  void close(final byte[] message);
068
069  /**
070   * Signal the task to shut down.
071   */
072  @Override
073  void close();
074
075  /**
076   * Gets the representer of task.
077   * @return the representer of task
078   */
079  TaskRepresenter getTaskRepresenter();
080}