View Javadoc
1   /*
2    * Copyright 2014 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.util.concurrent;
17  
18  import java.util.concurrent.RejectedExecutionException;
19  
20  /**
21   * Implement this interface if you need your {@link EventExecutor} implementation to be able
22   * to reject new work.
23   */
24  public interface PausableEventExecutor extends EventExecutor, WrappedEventExecutor {
25  
26      /**
27       * After a call to this method the {@link EventExecutor} may throw a {@link RejectedExecutionException} when
28       * attempting to assign new work to it (i.e. through a call to {@link EventExecutor#execute(Runnable)}).
29       */
30      void rejectNewTasks();
31  
32      /**
33       * With a call to this method the {@link EventExecutor} signals that it is now accepting new work.
34       */
35      void acceptNewTasks();
36  
37      /**
38       * Returns {@code true} if and only if this {@link EventExecutor} is accepting a new task.
39       */
40      boolean isAcceptingNewTasks();
41  }