View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.filter.executor;
21  
22  import java.util.EventListener;
23  import java.util.concurrent.ThreadPoolExecutor;
24  
25  import org.apache.mina.common.IoEvent;
26  
27  /**
28   * Listenes and filters all event queue operations occurring in
29   * {@link OrderedThreadPoolExecutor} and {@link UnorderedThreadPoolExecutor}.
30   * 
31   * @author The Apache MINA Project (dev@mina.apache.org)
32   * @version $Rev: 593426 $, $Date: 2007-11-08 23:22:24 -0700 (Thu, 08 Nov 2007) $
33   */
34  public interface IoEventQueueHandler extends EventListener {
35      /**
36       * Returns <tt>true</tt> if and only if the specified <tt>event</tt> is
37       * allowed to be offered to the event queue.  The <tt>event</tt> is dropped
38       * if <tt>false</tt> is returned.
39       */
40      boolean accept(ThreadPoolExecutor executor, IoEvent event);
41      
42      /**
43       * Invoked after the specified <tt>event</tt> has been offered to the
44       * event queue.
45       */
46      void offered(ThreadPoolExecutor executor, IoEvent event);
47      
48      /**
49       * Invoked after the specified <tt>event</tt> has been polled from the
50       * event queue.
51       */
52      void polled(ThreadPoolExecutor executor, IoEvent event);
53  }