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.util;
28:
29: // soon to move to "org.cougaar.util.Trigger":
30:
31: /**
32: * A simple "registry" API for triggers, which is used by
33: * implementations of <code>TriggerModel</code>.
34: */
35: public interface TriggerRegistry {
36:
37: /**
38: * Register a client trigger, returning a "registryTrigger"
39: * for the client to use.
40: * <p>
41: * <em>IMPORTANT:</em><br>
42: * The <code>org.cougaar.util.SyncTriggerModelImpl</code>
43: * should be used to wrap the returned "registryTrigger".
44: * The SyncTriggerModelImpl is internally synchronized to
45: * only run one "clientTrigger.trigger()" at a time, and to
46: * buffer up triggers for more efficient scheduler use.
47: * Additionally the TriggerModel includes "suspend()" and
48: * "resume()" support that is required to correctly
49: * implement client state transitions.
50: * <p>
51: * Without that wrapping it is possible for the "clientTrigger"
52: * to be invoked in parallel under some TriggerRegistry
53: * implementations. Minimally this would require the
54: * "clientTrigger.trigger()" to be synchronized.
55: *
56: * @return a "registryTrigger" that the caller can use to tell
57: * the trigger-registry that it wants to be
58: * "clientTrigger.trigger()"ed.
59: */
60: Trigger register(Trigger clientTrigger);
61:
62: /**
63: * Release a register Trigger that was generated by
64: * <tt>register(..)</tt>.
65: */
66: void unregister(Trigger registryTrigger);
67:
68: }
|