01: /*
02: * <copyright>
03: *
04: * Copyright 2001-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.service;
28:
29: import org.cougaar.core.component.Service;
30: import org.cougaar.util.Trigger;
31: import org.cougaar.util.TriggerRegistry;
32:
33: /**
34: * This service is used to schedule plugins for thread execution.
35: * <p>
36: * The standard scheduler implementation just wraps the
37: * {@link ThreadService}. An open enhancement request is to
38: * port all SchedulerService clients to use the ThreadService
39: * directly, making this service obsolete.
40: *
41: * @see TriggerRegistry
42: */
43: public interface SchedulerService extends Service, TriggerRegistry {
44:
45: /**
46: * Register a client trigger, returning a "schedulerTrigger"
47: * for the client to use.
48: * <p>
49: * <em>IMPORTANT:</em><br>
50: * See the notes in <tt>TriggerRegistry.register(Trigger)</tt>
51: * for threading issues.
52: * @param clientTrigger the trigger to run when scheduled
53: * @return a "schedulerTrigger" that the caller can use to tell
54: * the scheduler that it wants to be "clientTrigger.trigger()"ed.
55: */
56: Trigger register(Trigger clientTrigger);
57:
58: /**
59: * Release a scheduler Trigger that was generated by
60: * <tt>register(..)</tt>.
61: */
62: void unregister(Trigger schedulerTrigger);
63: }
|