1 /**********************************************************************
2 * Copyright (c) 2012 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Bernd Hufmann - Initial API and implementation
11 **********************************************************************/
12 package org
.eclipse
.linuxtools
.lttng
.ui
.views
.control
.service
;
14 import java
.util
.List
;
16 import org
.eclipse
.core
.commands
.ExecutionException
;
17 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
18 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.control
.model
.IBaseEventInfo
;
19 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.control
.model
.IChannelInfo
;
20 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.control
.model
.ISessionInfo
;
21 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.control
.model
.IUstProviderInfo
;
24 /** <b><u>ILttngControlService</u></b>
26 * Interface for LTTng trace control command service.
29 public interface ILttngControlService
{
31 * Retrieves the existing sessions names from the node.
32 * @param monitor - a progress monitor
33 * @return an array with session names.
34 * @throws ExecutionException
36 public String
[] getSessionNames(IProgressMonitor monitor
) throws ExecutionException
;
39 * Retrieves the session information with the given name the node.
40 * @param sessionName - the session name
41 * @param monitor - a progress monitor
42 * @return session information
43 * @throws ExecutionException
45 public ISessionInfo
getSession(String sessionName
, IProgressMonitor monitor
) throws ExecutionException
;
48 * Retrieves the kernel provider information (i.e. the kernel events)
49 * @param monitor - a progress monitor
50 * @return the list of existing kernel events.
51 * @throws ExecutionException
53 public List
<IBaseEventInfo
> getKernelProvider(IProgressMonitor monitor
) throws ExecutionException
;
56 * Retrieves the UST provider information from the node.
57 * @return - the UST provider information.
58 * @throws ExecutionException
60 public List
<IUstProviderInfo
> getUstProvider() throws ExecutionException
;
62 * Retrieves the UST provider information from the node.
63 * @param monitor - a progress monitor
64 * @return the UST provider information.
65 * @throws ExecutionException
67 public List
<IUstProviderInfo
> getUstProvider(IProgressMonitor monitor
) throws ExecutionException
;
70 * Creates a session with given session name and location.
71 * @param sessionName - a session name to create
72 * @param sessionPath - a path for storing the traces (use null for default)
73 * @param monitor - a progress monitor
74 * @return the session information
75 * @throws ExecutionException
77 public ISessionInfo
createSession(String sessionName
, String sessionPath
, IProgressMonitor monitor
) throws ExecutionException
;
80 * Destroys a session with given session name.
81 * @param sessionName - a session name to destroy
82 * @param monitor - a progress monitor
83 * @throws ExecutionException
85 public void destroySession(String sessionName
, IProgressMonitor monitor
) throws ExecutionException
;
88 * Starts a session with given session name.
89 * @param sessionName - a session name to start
90 * @param monitor - a progress monitor
91 * @throws ExecutionException
93 public void startSession(String sessionName
, IProgressMonitor monitor
) throws ExecutionException
;
96 * Stops a session with given session name.
97 * @param sessionName - a session name to stop
98 * @param monitor - a progress monitor
99 * @throws ExecutionException
101 public void stopSession(String sessionName
, IProgressMonitor monitor
) throws ExecutionException
;
105 * Enables a list of channels for given session and given channel information (configuration).
106 * @param sessionName - a session name to create
107 * @param channelNames - a list of channel names to enable
108 * @param isKernel - a flag to indicate Kernel or UST (true for Kernel, false for UST)
109 * @param info - channel information used for creation of a channel (or null for default)
110 * @param monitor - a progress monitor
111 * @throws ExecutionException
113 public void enableChannel(String sessionName
, List
<String
> channelNames
, boolean isKernel
, IChannelInfo info
, IProgressMonitor monitor
) throws ExecutionException
;
116 * Disables a list of channels for given session and given channel information (configuration).
117 * @param sessionName - a session name to create
118 * @param channelNames - a list of channel names to enable
119 * @param isKernel - a flag to indicate Kernel or UST (true for Kernel, false for UST)
120 * @param monitor - a progress monitor
121 * @throws ExecutionException
123 public void disableChannel(String sessionName
, List
<String
> channelNames
, boolean isKernel
, IProgressMonitor monitor
) throws ExecutionException
;
126 * Enables a list of events with no additional parameters.
127 * @param sessionName - a session name
128 * @param channelName - a channel name (null for default channel)
129 * @param eventNames - a list of event names to enabled.
130 * @param isKernel - a flag for indicating kernel or UST.
131 * @param monitor - a progress monitor
132 * @throws ExecutionException
134 public void enableEvent(String sessionName
, String channelName
, List
<String
> eventNames
, boolean isKernel
, IProgressMonitor monitor
) throws ExecutionException
;
137 * Disables a list of events with no additional parameters.
138 * @param sessionName - a session name
139 * @param channelName - a channel name (null for default channel)
140 * @param eventNames - a list of event names to enabled.
141 * @param isKernel - a flag for indicating kernel or UST.
142 * @param monitor - a progress monitor
143 * @throws ExecutionException
145 public void disableEvent(String sessionName
, String channelName
, List
<String
> eventNames
, boolean isKernel
, IProgressMonitor monitor
) throws ExecutionException
;
This page took 0.034457 seconds and 6 git commands to generate.