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;
026
027/**
028 * Represents a running Task.
029 */
030@DriverSide
031@Public
032@Provided
033public interface RunningTask extends Identifiable, AutoCloseable {
034
035
036  /**
037   * @return the context the task is running on.
038   */
039  ActiveContext getActiveContext();
040
041
042  /**
043   * Sends the message to the running task.
044   *
045   * @param message to be sent to the running task
046   */
047  void send(final byte[] message);
048
049  /**
050   * Signal the task to suspend.
051   *
052   * @param message a message that is sent to the Task.
053   */
054  void suspend(final byte[] message);
055
056  /**
057   * Signal the task to suspend.
058   */
059  void suspend();
060
061  /**
062   * Signal the task to shut down.
063   *
064   * @param message a message that is sent to the Task.
065   */
066  void close(final byte[] message);
067
068  /**
069   * Signal the task to shut down.
070   */
071  @Override
072  void close();
073}