WorkQueue.java revision 608:7e06bf1dcb09
1/*
2 * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.corba.se.spi.orbutil.threadpool;
27
28public interface WorkQueue
29{
30
31    /**
32    * This method is used to add work to the WorkQueue
33    */
34    public void addWork(Work aWorkItem);
35
36    /**
37    * This method will return the name of the WorkQueue.
38    */
39    public String getName();
40
41    /**
42    * Returns the total number of Work items added to the Queue.
43    */
44    public long totalWorkItemsAdded();
45
46    /**
47    * Returns the total number of Work items in the Queue to be processed.
48    */
49    public int workItemsInQueue();
50
51    /**
52    * Returns the average time a work item is waiting in the queue before
53    * getting processed.
54    */
55    public long averageTimeInQueue();
56
57    /**
58     * Set the ThreadPool instance servicing this WorkQueue
59     */
60    public void setThreadPool(ThreadPool aThreadPool);
61
62    /**
63     * Get the ThreadPool instance servicing this WorkQueue
64     */
65    public ThreadPool getThreadPool();
66}
67
68// End of file.
69