View Javadoc

1   /*
2    *   @(#) $Id: ThreadPool.java 210062 2005-07-11 03:52:38Z trustin $
3    *
4    *   Copyright 2004 The Apache Software Foundation
5    *
6    *   Licensed under the Apache License, Version 2.0 (the "License");
7    *   you may not use this file except in compliance with the License.
8    *   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, software
13   *   distributed under the License is distributed on an "AS IS" BASIS,
14   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *   See the License for the specific language governing permissions and
16   *   limitations under the License.
17   *
18   */
19  package org.apache.mina.util;
20  
21  /***
22   * A generic thread pool interface.
23   * 
24   * @author The Apache Directory Project (dev@directory.apache.org)
25   * @author Trustin Lee (trustin@apache.org)
26   * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $
27   */
28  public interface ThreadPool {
29      
30      /***
31       * Returns the number of threads in the thread pool.
32       */
33      int getPoolSize();
34  
35      /***
36       * Returns the maximum size of the thread pool.
37       */
38      int getMaximumPoolSize();
39  
40      /***
41       * Returns the keep-alive time until the thread suicides after it became
42       * idle (milliseconds unit).
43       */
44      int getKeepAliveTime();
45  
46      /***
47       * Sets the maximum size of the thread pool.
48       */
49      void setMaximumPoolSize( int maximumPoolSize );
50  
51      /***
52       * Sets the keep-alive time until the thread suicides after it became idle
53       * (milliseconds unit).
54       */
55      void setKeepAliveTime( int keepAliveTime );
56  
57      /***
58       * Starts thread pool threads and starts forwarding events to them.
59       */
60      void start();
61  
62      /***
63       * Stops all thread pool threads.
64       */
65      void stop();
66  }