/*_############################################################################
  _## 
  _##  SNMP4J - WorkerTask.java  
  _## 
  _##  Copyright (C) 2003-2026  Frank Fock (SNMP4J.org)
  _##  
  _##  Licensed 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.snmp4j.util;

/**
 * This models a {@code WorkerTask} instance that would be executed by a
 * {@link WorkerPool} upon submission.
 *
 * @author Frank Fock
 * @version 3.10.0
 * @since 1.9
 */
public interface WorkerTask extends Runnable {

  /**
   * Gracefully shuts down this task. All pending operations should be finished, but no new operations should be
   * accepted.
   * @since 3.10.0
   */
  void shutdown();

  /**
   * The {@code WorkerPool} might call this method to hint the active
   * {@code WorkTask} instance to complete execution as soon as possible.
   */
  void terminate();

  /**
   * Waits until this task has been finished.
   * @throws InterruptedException
   *    if the join has been interrupted by another thread.
   */
  void join() throws InterruptedException;

  /**
   * Waits until this task has been finished or the specified timeout has
   * elapsed.
   * @param timeout
   *    the maximum time to wait in milliseconds.
   * @return
   *    {@code true} if the task has been finished, {@code false} otherwise.
   * @throws InterruptedException
   *    if the join has been interrupted by another thread.
   * @since 3.10.0
   */
  boolean join(long timeout) throws InterruptedException;

  /**
   * Interrupts this task.
   * @see Thread#interrupt()
   */
  void interrupt();

}
