1 /*******************************************************************************
2 * Copyright (c) 2011 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 * Polytechnique Montréal - Initial API and implementation
11 * Bernd Hufmann - Productification, enhancements and fixes
13 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.lttng
.tracecontrol
.service
;
16 import org
.eclipse
.linuxtools
.lttng
.LttngConstants
;
17 import org
.eclipse
.tm
.tcf
.protocol
.IService
;
18 import org
.eclipse
.tm
.tcf
.protocol
.IToken
;
20 public interface ILttControllerService
extends IService
{
23 * This service name, as it appears on the wire - a TCF name of the service.
25 public static final String NAME
= LttngConstants
.Lttng_Control_Command
;
27 IToken
getProviders(DoneGetProviders done
);
29 interface DoneGetProviders
{
31 * This method is called when getProviders() command is completed.
33 * @param token - pending command handle.
34 * @param error - null if the command is successful.
35 * @param str - response of the agent
37 void doneGetProviders(IToken token
, Exception error
, String str
[]);
40 IToken
getTargets(String provider
, DoneGetTargets done
);
42 interface DoneGetTargets
{
44 * This method is called when getTargets() command is completed.
46 * @param token - pending command handle.
47 * @param error - null if the command is successful.
48 * @param str - response of the agent
50 void doneGetTargets(IToken token
, Exception error
, String str
[]);
53 IToken
getMarkers(String provider
, String target
, DoneGetMarkers done
);
55 interface DoneGetMarkers
{
57 * This method is called when getMarkers() command is completed.
59 * @param token - pending command handle.
60 * @param error - null if the command is successful.
61 * @param str - response of the agent
63 void doneGetMarkers(IToken token
, Exception error
, String str
[]);
66 IToken
getTraces(String provider
, String target
, DoneGetTraces done
);
68 interface DoneGetTraces
{
70 * This method is called when getTraces() command is completed.
72 * @param token - pending command handle.
73 * @param error - null if the command is successful.
74 * @param str - response of the agent
76 void doneGetTraces(IToken token
, Exception error
, String str
[]);
79 IToken
getActiveTraces(String provider
, String target
, DoneGetActiveTraces done
);
81 interface DoneGetActiveTraces
{
83 * This method is called when getTraces() command is completed.
85 * @param token - pending command handle.
86 * @param error - null if the command is successful.
87 * @param str - response of the agent
89 void doneGetActiveTraces(IToken token
, Exception error
, String str
[]);
92 IToken
getActiveTraceInfo(String provider
, String target
, String trace
, DoneGetActiveTraceInfo done
);
94 interface DoneGetActiveTraceInfo
{
96 * This method is called when getTraces() command is completed.
98 * @param token - pending command handle.
99 * @param error - null if the command is successful.
100 * @param str - response of the agent
102 void doneGetActiveTraceInfo(IToken token
, Exception error
, String str
[]);
107 IToken
getChannels(String provider
, String target
, String trace
, DoneGetChannels done
);
109 interface DoneGetChannels
{
111 * This method is called when getChannels() command is completed.
113 * @param token - pending command handle.
114 * @param error - null if the command is successful.
115 * @param str - response of the agent
117 void doneGetChannels(IToken token
, Exception error
, String str
[]);
120 IToken
setupTrace(String provider
, String target
, String trace
, DoneSetupTrace done
);
122 interface DoneSetupTrace
{
124 * This method is called when setupTrace() command is completed.
126 * @param token - pending command handle.
127 * @param error - null if the command is successful.
128 * @param str - response of the agent
130 void doneSetupTrace(IToken token
, Exception error
, Object str
);
133 IToken
setTraceTransport(String provider
, String target
, String trace
, String transport
, DoneSetTraceTransport done
);
135 interface DoneSetTraceTransport
{
137 * This method is called when setTraceTransport() command is completed.
139 * @param token - pending command handle.
140 * @param error - null if the command is successful.
141 * @param str - response of the agent
143 void doneSetTraceTransport(IToken token
, Exception error
, Object str
);
146 IToken
getMarkerInfo(String provider
, String target
, String marker
, DoneGetMarkerInfo done
);
148 interface DoneGetMarkerInfo
{
150 * This method is called when getMarkerInfo() command is completed.
152 * @param token - pending command handle.
153 * @param error - null if the command is successful.
154 * @param str - response of the agent
156 void doneGetMarkerInfo(IToken token
, Exception error
, String str
);
159 IToken
setMarkerEnable(String provider
, String target
, String marker
, Boolean enable
, DoneSetMarkerEnable done
);
161 interface DoneSetMarkerEnable
{
163 * This method is called when setMarkerEnable() command is completed.
165 * @param token - pending command handle.
166 * @param error - null if the command is successful.
167 * @param str - response of the agent
169 void doneSetMarkerEnable(IToken token
, Exception error
, Object str
);
172 IToken
writeTraceLocal(String provider
, String target
, String trace
, String path
, int numChannel
, Boolean isAppend
, Boolean isFlightRecorder
, Boolean isNormalOnly
, DoneWriteTraceLocal done
);
174 interface DoneWriteTraceLocal
{
176 * This method is called when writeTraceLocal() command is completed.
178 * @param token - pending command handle.
179 * @param error - null if the command is successful.
180 * @param str - response of the agent
182 void doneWriteTraceLocal(IToken token
, Exception error
, Object str
);
185 IToken
writeTraceNetwork(String provider
, String target
, String trace
, int numChannel
, Boolean isAppend
, Boolean isFlightRecorder
, Boolean isNormalOnly
, DoneWriteTraceNetwork done
);
187 interface DoneWriteTraceNetwork
{
189 * This method is called when writeTraceNetwork() command is completed.
191 * @param token - pending command handle.
192 * @param error - null if the command is successful.
193 * @param str - response of the agent
195 void doneWriteTraceNetwork(IToken token
, Exception error
, Object str
);
198 IToken
allocTrace(String provider
, String target
, String trace
, DoneAllocTrace done
);
200 interface DoneAllocTrace
{
202 * This method is called when allocTrace() command is completed.
204 * @param token - pending command handle.
205 * @param error - null if the command is successful.
206 * @param str - response of the agent
208 void doneAllocTrace(IToken token
, Exception error
, Object str
);
211 IToken
setChannelEnable(String provider
, String target
, String trace
, String channel
, Boolean enable
, DoneSetChannelEnable done
);
213 interface DoneSetChannelEnable
{
215 * This method is called when setChannelEnable() command is completed.
217 * @param token - pending command handle.
218 * @param error - null if the command is successful.
219 * @param str - response of the agent
221 void doneSetChannelEnable(IToken token
, Exception error
, Object str
);
224 IToken
setChannelOverwrite(String provider
, String target
, String trace
, String channel
, Boolean overwrite
, DoneSetChannelOverwrite done
);
226 interface DoneSetChannelOverwrite
{
228 * This method is called when setChannelOverwrite() command is completed.
230 * @param token - pending command handle.
231 * @param error - null if the command is successful.
232 * @param str - response of the agent
234 void doneSetChannelOverwrite(IToken token
, Exception error
, Object str
);
237 IToken
setChannelTimer(String provider
, String target
, String trace
, String channel
, long period
, DoneSetChannelTimer done
);
239 interface DoneSetChannelTimer
{
241 * This method is called when setChannelTimer() command is completed.
243 * @param token - pending command handle.
244 * @param error - null if the command is successful.
245 * @param str - response of the agent
247 void doneSetChannelTimer(IToken token
, Exception error
, Object str
);
250 IToken
setChannelSubbufNum(String provider
, String target
, String trace
, String channel
, long subbufNum
, DoneSetChannelSubbufNum done
);
252 interface DoneSetChannelSubbufNum
{
254 * This method is called when setChannelSubbufNum() command is completed.
256 * @param token - pending command handle.
257 * @param error - null if the command is successful.
258 * @param str - response of the agent
260 void doneSetChannelSubbufNum(IToken token
, Exception error
, Object str
);
263 IToken
setChannelSubbufSize(String provider
, String target
, String trace
, String channel
, long subbufSize
, DoneSetChannelSubbufSize done
);
265 interface DoneSetChannelSubbufSize
{
267 * This method is called when setChannelSubbufSize() command is completed.
269 * @param token - pending command handle.
270 * @param error - null if the command is successful.
271 * @param str - response of the agent
273 void doneSetChannelSubbufSize(IToken token
, Exception error
, Object str
);
276 IToken
startTrace(String provider
, String target
, String trace
, DoneStartTrace done
);
278 interface DoneStartTrace
{
280 * This method is called when startTrace() command is completed.
282 * @param token - pending command handle.
283 * @param error - null if the command is successful.
284 * @param str - response of the agent
286 void doneStartTrace(IToken token
, Exception error
, Object str
);
289 IToken
pauseTrace(String provider
, String target
, String trace
, DonePauseTrace done
);
291 interface DonePauseTrace
{
293 * This method is called when pauseTrace() command is completed.
295 * @param token - pending command handle.
296 * @param error - null if the command is successful.
297 * @param str - response of the agent
299 void donePauseTrace(IToken token
, Exception error
, Object str
);
302 IToken
destroyTrace(String provider
, String target
, String trace
, DoneDestroyTrace done
);
304 interface DoneDestroyTrace
{
306 * This method is called when destroyTrace() command is completed.
308 * @param token - pending command handle.
309 * @param error - null if the command is successful.
310 * @param str - response of the agent
312 void doneDestroyTrace(IToken token
, Exception error
, Object str
);