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.mts.std;
28:
29: import org.cougaar.core.component.Service;
30: import org.cougaar.core.mts.MessageAddress;
31:
32: /**
33: * This MTS-internal Service can be used to 'single-step' a message
34: * through the stations. Its only real use so far is through a Swing
35: * gui, but in principle it could have other uses (e.g., @{link
36: * StepperControlExampleAspect}). The implementation is in the {@link
37: * StepperAspect}.
38: */
39: public interface StepService extends Service {
40: /**
41: * Pause processing to all destinations. The next message to each
42: * destination will be frozen until a subsequent resume or
43: * step. */
44: void pauseAll();
45:
46: /**
47: * Pause processing to the given destination. The next message to
48: * that destination will be frozen until a subsequent resume or
49: * step. */
50: void pause(MessageAddress destination);
51:
52: /** Resume processing to all destinations. */
53: void resumeAll();
54:
55: /** Resume processing to the given destination. */
56: void resume(MessageAddress destination);
57:
58: /** Allow the frozen message (if any) to proceed, for all
59: * destinations. */
60: void stepAll();
61:
62: /** Allow the frozen message (if any) to proceed, for the given
63: * destination. */
64: void step(MessageAddress destination);
65: }
|