01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.core.thread;
28:
29: /**
30: * Objects which wish to subscribe to the ThreadListenerService should
31: * implement this interface. The methods in the API are all callback
32: * from the corresponding ThreadService.
33: */
34: public interface ThreadListener {
35: /**
36: * Indicates that the given Schedulable has been queued because it
37: * was unable to to run.
38: */
39: void threadQueued(Schedulable schedulable, Object consumer);
40:
41: /**
42: * Indicates that the given Schedulable, which was previously
43: * queued, has now been dequeued and is about to run.
44: */
45: void threadDequeued(Schedulable schedulable, Object consumer);
46:
47: /**
48: * Indicates that the given Schedulable is about to start
49: * running. This will be called from within the Schedulable's own
50: * thread.
51: */
52: void threadStarted(Schedulable schedulable, Object consumer);
53:
54: /**
55: * Indicates that the given Schedulable has just stopped
56: * running. This will be called from within the Schedulable's own
57: * thread.
58: */
59: void threadStopped(Schedulable schedulable, Object consumer);
60:
61: /**
62: * Indicates that the given scheduler has been allocated a run-
63: * right, which it will use to run one of its Schedulables. That
64: * Schedulable might be a queued one or might be a new one asking
65: * to start.
66: */
67: void rightGiven(String scheduler);
68:
69: /**
70: * Indicates that some running Schedulable managed by the given
71: * Scheduler has given up its run-right.
72: */
73: void rightReturned(String consumer);
74: }
|