br.com.objectos.concurrent.IoWorker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of objectos-concurrent Show documentation

Objectos Concurrency library

The newest version!

/*
 * Copyright (C) 2021-2022 Objectos Software LTDA.
 *
 * 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 br.com.objectos.concurrent;

/**
 * Executes {@linkplain IoTask I/O bound tasks}.
 *
 * @since 2
 */
public interface IoWorker {

  /**
   * Cancels (if not yet running) or interrupts (if running) the specified task.
   *
   * @param task
   *        the I/O task to cancel or interrupt
   *
   * @return {@code true} if the task was cancelled or interrupted,
   *         {@code false} otherwise
   */
  boolean cancelOrInterrupt(IoTask task);

  /**
   * Submits the specified task for running in this worker.
   *
   * @param task
   *        the I/O task to submit
   */
  void submit(IoTask task);

}