View Javadoc

1   /*
2    *   @(#) $Id: ThreadPool.java 357871 2005-12-20 01:56:40Z 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   * @version $Rev: 357871 $, $Date: 2005-12-20 10:56:40 +0900 (Tue, 20 Dec 2005) $
26   */
27  public interface ThreadPool {
28      
29      /***
30       * Returns the number of threads in the thread pool.
31       */
32      int getPoolSize();
33  
34      /***
35       * Returns the maximum size of the thread pool.
36       */
37      int getMaximumPoolSize();
38  
39      /***
40       * Returns the keep-alive time until the thread suicides after it became
41       * idle (milliseconds unit).
42       */
43      int getKeepAliveTime();
44  
45      /***
46       * Sets the maximum size of the thread pool.
47       */
48      void setMaximumPoolSize( int maximumPoolSize );
49  
50      /***
51       * Sets the keep-alive time until the thread suicides after it became idle
52       * (milliseconds unit).
53       */
54      void setKeepAliveTime( int keepAliveTime );
55  
56      /***
57       * Starts thread pool threads and starts forwarding events to them.
58       */
59      void start();
60  
61      /***
62       * Stops all thread pool threads.
63       */
64      void stop();
65  }