lttng: Add snapshot support - LTTng Tools v2.3

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ui / src / org / eclipse / linuxtools / internal / lttng2 / ui / views / control / service / ILttngControlService.java

diff --git a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/ILttngControlService.java b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/ILttngControlService.java
index b07196028bd77243db2acd52e203846a4a20539a..b24bbf91dbcb40097f9c8b2ac621221f194bbed8 100644 (file)
--- a/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/ILttngControlService.java
+++ b/org.eclipse.linuxtools.lttng2.ui/src/org/eclipse/linuxtools/internal/lttng2/ui/views/control/service/ILttngControlService.java
@@ -19,6 +19,7 @@ import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.linuxtools.internal.lttng2.core.control.model.IBaseEventInfo;
 import org.eclipse.linuxtools.internal.lttng2.core.control.model.IChannelInfo;
 import org.eclipse.linuxtools.internal.lttng2.core.control.model.ISessionInfo;
+import org.eclipse.linuxtools.internal.lttng2.core.control.model.ISnapshotInfo;
 import org.eclipse.linuxtools.internal.lttng2.core.control.model.IUstProviderInfo;
 import org.eclipse.linuxtools.internal.lttng2.core.control.model.LogLevelType;
 import org.eclipse.linuxtools.internal.lttng2.core.control.model.TraceLogLevel;
@@ -36,7 +37,7 @@ public interface ILttngControlService {
     /**
      * @return the version string.
      */
-    public String getVersion();
+    String getVersion();
 
     /**
      * Checks if given version is supported by this ILTTngControlService implementation.
@@ -44,7 +45,7 @@ public interface ILttngControlService {
      * @param version The version to check
      * @return <code>true</code> if version is supported else <code>false</code>
      */
-    public boolean isVersionSupported(String version);
+    boolean isVersionSupported(String version);
 
     /**
      * Retrieves the existing sessions names from the node.
@@ -55,7 +56,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public String[] getSessionNames(IProgressMonitor monitor)
+    String[] getSessionNames(IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -69,7 +70,20 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public ISessionInfo getSession(String sessionName, IProgressMonitor monitor)
+    ISessionInfo getSession(String sessionName, IProgressMonitor monitor)
+            throws ExecutionException;
+
+    /**
+     * Retrieves the snapshot output information from the node
+     * @param sessionName
+     *            - the session name
+     * @param monitor
+     *            - a progress monitor
+     * @return snapshot output information
+     * @throws ExecutionException
+     *          if command fails
+     */
+    ISnapshotInfo getSnapshotInfo(String sessionName, IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -81,7 +95,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public List<IBaseEventInfo> getKernelProvider(IProgressMonitor monitor)
+    List<IBaseEventInfo> getKernelProvider(IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -102,7 +116,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public List<IUstProviderInfo> getUstProvider(IProgressMonitor monitor)
+    List<IUstProviderInfo> getUstProvider(IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -112,35 +126,15 @@ public interface ILttngControlService {
      *            - a session name to create
      * @param sessionPath
      *            - a path for storing the traces (use null for default)
+     * @param isSnapshot
+     *            - true for snapshot session else false
      * @param monitor
      *            - a progress monitor
      * @return the session information
      * @throws ExecutionException
      *             If the command fails
      */
-    public ISessionInfo createSession(String sessionName, String sessionPath,
-            IProgressMonitor monitor) throws ExecutionException;
-
-    /**
-     * Creates a session with given session name and location.
-     *
-     * @param sessionName
-     *            - a session name to create
-     * @param sessionPath
-     *            - a path for storing the traces (use null for default)
-     * @param noConsumer
-     *            - a flag to indicate no consumer
-     * @param disableConsumer
-     *            - a flag to disable consumer
-     * @param monitor
-     *            - a progress monitor
-     * @return the session information
-     * @throws ExecutionException
-     *             If the command fails
-     */
-    public ISessionInfo createSession(String sessionName, String sessionPath, boolean noConsumer, boolean disableConsumer,
-            IProgressMonitor monitor) throws ExecutionException;
-
+    ISessionInfo createSession(String sessionName, String sessionPath, boolean isSnapshot, IProgressMonitor monitor) throws ExecutionException;
 
     /**
      * Creates a session with given session name and location.
@@ -154,18 +148,15 @@ public interface ILttngControlService {
      *            - a URL for control channel (networkUrl has to be null, dataUrl has to be set)
      * @param dataUrl
      *            - a URL for data channel (networkUrl has to be null, controlUrl has to be set)
-     * @param noConsumer
-     *            - a flag to indicate no consumer
-     * @param disableConsumer
-     *            - a flag to disable consumer
+     * @param isSnapshot
+     *            - true for snapshot session else false
      * @param monitor
      *            - a progress monitor
      * @return the session information
      * @throws ExecutionException
      *             If the command fails
      */
-    public ISessionInfo createSession(String sessionName, String networkUrl, String controlUrl, String dataUrl, boolean noConsumer, boolean disableConsumer,
-            IProgressMonitor monitor) throws ExecutionException;
+    ISessionInfo createSession(String sessionName, String networkUrl, String controlUrl, String dataUrl, boolean isSnapshot, IProgressMonitor monitor) throws ExecutionException;
 
     /**
      * Destroys a session with given session name.
@@ -177,7 +168,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void destroySession(String sessionName, IProgressMonitor monitor)
+    void destroySession(String sessionName, IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -190,7 +181,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void startSession(String sessionName, IProgressMonitor monitor)
+    void startSession(String sessionName, IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -203,7 +194,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void stopSession(String sessionName, IProgressMonitor monitor)
+    void stopSession(String sessionName, IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -225,7 +216,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void enableChannels(String sessionName, List<String> channelNames,
+    void enableChannels(String sessionName, List<String> channelNames,
             boolean isKernel, IChannelInfo info, IProgressMonitor monitor)
             throws ExecutionException;
 
@@ -245,7 +236,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void disableChannels(String sessionName, List<String> channelNames,
+    void disableChannels(String sessionName, List<String> channelNames,
             boolean isKernel, IProgressMonitor monitor)
             throws ExecutionException;
 
@@ -268,7 +259,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void enableEvents(String sessionName, String channelName,
+    void enableEvents(String sessionName, String channelName,
             List<String> eventNames, boolean isKernel, String filterExpression,
             IProgressMonitor monitor)
             throws ExecutionException;
@@ -286,7 +277,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void enableSyscalls(String sessionName, String channelName,
+    void enableSyscalls(String sessionName, String channelName,
             IProgressMonitor monitor) throws ExecutionException;
 
     /**
@@ -307,7 +298,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void enableProbe(String sessionName, String channelName,
+    void enableProbe(String sessionName, String channelName,
             String eventName, boolean isFunction, String probe,
             IProgressMonitor monitor) throws ExecutionException;
 
@@ -331,7 +322,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void enableLogLevel(String sessionName, String channelName,
+    void enableLogLevel(String sessionName, String channelName,
             String eventName, LogLevelType logLevelType, TraceLogLevel level,
             String filterExpression,
             IProgressMonitor monitor) throws ExecutionException;
@@ -352,7 +343,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void disableEvent(String sessionName, String channelName,
+    void disableEvent(String sessionName, String channelName,
             List<String> eventNames, boolean isKernel, IProgressMonitor monitor)
             throws ExecutionException;
 
@@ -365,7 +356,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public List<String> getContextList(IProgressMonitor monitor)
+    List<String> getContextList(IProgressMonitor monitor)
             throws ExecutionException;
 
     /**
@@ -386,7 +377,7 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void addContexts(String sessionName, String channelName,
+    void addContexts(String sessionName, String channelName,
             String eventName, boolean isKernel, List<String> contexts,
             IProgressMonitor monitor) throws ExecutionException;
 
@@ -400,6 +391,19 @@ public interface ILttngControlService {
      * @throws ExecutionException
      *             If the command fails
      */
-    public void calibrate(boolean isKernel, IProgressMonitor monitor)
+    void calibrate(boolean isKernel, IProgressMonitor monitor)
+            throws ExecutionException;
+
+    /**
+     * Records a snapshot.
+     *
+     * @param sessionName
+     *            - a session name
+     * @param monitor
+     *            - a progress monitor
+     * @throws ExecutionException
+     *             If the command fails
+     */
+    void recordSnapshot(String sessionName, IProgressMonitor monitor)
             throws ExecutionException;
 }