Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'target_explorer/plugins/org.eclipse.tcf.te.runtime.services/src')
-rw-r--r--target_explorer/plugins/org.eclipse.tcf.te.runtime.services/src/org/eclipse/tcf/te/runtime/services/interfaces/ISimulatorService.java179
1 files changed, 96 insertions, 83 deletions
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.runtime.services/src/org/eclipse/tcf/te/runtime/services/interfaces/ISimulatorService.java b/target_explorer/plugins/org.eclipse.tcf.te.runtime.services/src/org/eclipse/tcf/te/runtime/services/interfaces/ISimulatorService.java
index 3ea29e4d3..98d185a4a 100644
--- a/target_explorer/plugins/org.eclipse.tcf.te.runtime.services/src/org/eclipse/tcf/te/runtime/services/interfaces/ISimulatorService.java
+++ b/target_explorer/plugins/org.eclipse.tcf.te.runtime.services/src/org/eclipse/tcf/te/runtime/services/interfaces/ISimulatorService.java
@@ -1,83 +1,96 @@
-/*******************************************************************************
- * Copyright (c) 2013 Wind River Systems, Inc. and others. All rights reserved.
- * This program and the accompanying materials are made available under the terms
- * of the Eclipse Public License v1.0 which accompanies this distribution, and is
- * available at http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Wind River Systems - initial API and implementation
- *******************************************************************************/
-package org.eclipse.tcf.te.runtime.services.interfaces;
-
-import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
-
-/**
- * Simulator service.
- * <p>
- * Allows to start/stop external simulators.
- * <p>
- * Simulator instance related UI parts, like configuration panels, are retrieved
- * by clients via the {@link IUIService}.
- */
-public interface ISimulatorService extends IService {
-
- /**
- * The constants for the simulator state.
- */
- public enum State { Stopped, Starting, Started, Stopping }
-
- /**
- * Starts the simulator.
- *
- * @param context The context. Must not be <code>null</code>.
- * @param config The encoded simulator settings or <code>null</code>.
- * @param callback The callback to invoke once the operation finishes. Must not be <code>null</code>.
- * @param monitor The progress monitor or <code>null</code>.
- */
- public void start(Object context, String config, ICallback callback, IProgressMonitor monitor);
-
- /**
- * Stops the simulator.
- *
- * @param context The context. Must not be <code>null</code>.
- * @param config The encoded simulator settings or <code>null</code>.
- * @param callback The callback to invoke once the operation finishes. Must not be <code>null</code>.
- * @param monitor The progress monitor or <code>null</code>.
- */
- public void stop(Object context, String config, ICallback callback, IProgressMonitor monitor);
-
- /**
- * Checks if the simulator is running.
- * <p>
- * The result of the check is return as {@link Boolean} object by the callback's {@link ICallback#getResult()} method.
- *
- * @param context The context. Must not be <code>null</code>.
- * @param config The encoded simulator settings or <code>null</code>.
- * @param callback The callback to invoke once the operation finishes. Must not be <code>null</code>.
- */
- public void isRunning(Object context, String config, ICallback callback);
-
- /**
- * Get the state of the simulator for the given context.
- * @param context The context. Must not be <code>null</code>.
- * @param config The encoded simulator settings or <code>null</code>.
- * @return The simulator state.
- */
- public State getState(Object context, String config);
-
- /**
- * Get the default config for the simulator.
- * The returned config does not need to be valid!
- * @return The default config or <code>null</code>.
- */
- public String getDefaultConfig();
-
- /**
- * Validate a simulator config.
- * @param context The context. Must not be <code>null</code>.
- * @param config The config to validate.
- * @return <code>true</code> if the config is valid.
- */
- public boolean isValidConfig(Object context, String config);
-}
+/*******************************************************************************
+ * Copyright (c) 2013 Wind River Systems, Inc. and others. All rights reserved.
+ * This program and the accompanying materials are made available under the terms
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wind River Systems - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.tcf.te.runtime.services.interfaces;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
+
+/**
+ * Simulator service.
+ * <p>
+ * Allows to start/stop external simulators.
+ * <p>
+ * Simulator instance related UI parts, like configuration panels, are retrieved
+ * by clients via the {@link IUIService}.
+ */
+public interface ISimulatorService extends IService {
+
+ /**
+ * The constants for the simulator state.
+ */
+ public enum State { Stopped, Starting, Started, Stopping }
+
+ /**
+ * Starts the simulator.
+ *
+ * @param context The context. Must not be <code>null</code>.
+ * @param config The encoded simulator settings or <code>null</code>.
+ * @param callback The callback to invoke once the operation finishes. Must not be <code>null</code>.
+ * @param monitor The progress monitor or <code>null</code>.
+ */
+ public void start(Object context, String config, ICallback callback, IProgressMonitor monitor);
+
+ /**
+ * Stops the simulator.
+ *
+ * @param context The context. Must not be <code>null</code>.
+ * @param config The encoded simulator settings or <code>null</code>.
+ * @param callback The callback to invoke once the operation finishes. Must not be <code>null</code>.
+ * @param monitor The progress monitor or <code>null</code>.
+ */
+ public void stop(Object context, String config, ICallback callback, IProgressMonitor monitor);
+
+ /**
+ * Checks if the simulator is running.
+ * <p>
+ * The result of the check is return as {@link Boolean} object by the callback's {@link ICallback#getResult()} method.
+ *
+ * @param context The context. Must not be <code>null</code>.
+ * @param config The encoded simulator settings or <code>null</code>.
+ * @param callback The callback to invoke once the operation finishes. Must not be <code>null</code>.
+ */
+ public void isRunning(Object context, String config, ICallback callback);
+
+ /**
+ * Get the state of the simulator for the given context.
+ * @param context The context. Must not be <code>null</code>.
+ * @param config The encoded simulator settings or <code>null</code>.
+ * @return The simulator state.
+ */
+ public State getState(Object context, String config);
+
+ /**
+ * Get the default configuration for the simulator.
+ * <p>
+ * The returned configuration does not need to be valid!
+ *
+ * @return The default configuration or <code>null</code>.
+ */
+ public String getDefaultConfig();
+
+ /**
+ * Validate a simulator configuration
+ * .
+ * @param context The context. Must not be <code>null</code>.
+ * @param config The configuration to validate.
+ *
+ * @return <code>true</code> if the configuration is valid.
+ */
+ public boolean isValidConfig(Object context, String config);
+
+ /**
+ * Returns the default simulator payload (guest) boot time. If the
+ * method returns <code>-1</code>, the simulator start sequence will
+ * not wait for the simulator payload (guest) to boot up.
+ *
+ * @return The default simulator payload (guest) boot time in seconds or <code>-1</code>.
+ */
+ public int getDefaultPayloadBoottime();
+}

Back to the top