| 1 | /******************************************************************************* |
| 2 | * Copyright (c) 2011 Ericsson |
| 3 | * |
| 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 |
| 8 | * |
| 9 | * Contributors: |
| 10 | * Polytechnique Montréal - Initial API and implementation |
| 11 | * Bernd Hufmann - Productification, enhancements and fixes |
| 12 | * |
| 13 | *******************************************************************************/ |
| 14 | package org.eclipse.linuxtools.lttng.tracecontrol.service; |
| 15 | |
| 16 | import org.eclipse.linuxtools.lttng.LttngConstants; |
| 17 | import org.eclipse.tm.tcf.protocol.IService; |
| 18 | import org.eclipse.tm.tcf.protocol.IToken; |
| 19 | |
| 20 | public interface ILttControllerService extends IService { |
| 21 | |
| 22 | /** |
| 23 | * This service name, as it appears on the wire - a TCF name of the service. |
| 24 | */ |
| 25 | public static final String NAME = LttngConstants.Lttng_Control_Command; |
| 26 | |
| 27 | IToken getProviders(DoneGetProviders done); |
| 28 | |
| 29 | interface DoneGetProviders { |
| 30 | /** |
| 31 | * This method is called when getProviders() command is completed. |
| 32 | * |
| 33 | * @param token - pending command handle. |
| 34 | * @param error - null if the command is successful. |
| 35 | * @param str - response of the agent |
| 36 | */ |
| 37 | void doneGetProviders(IToken token, Exception error, String str[]); |
| 38 | } |
| 39 | |
| 40 | IToken getTargets(String provider, DoneGetTargets done); |
| 41 | |
| 42 | interface DoneGetTargets { |
| 43 | /** |
| 44 | * This method is called when getTargets() command is completed. |
| 45 | * |
| 46 | * @param token - pending command handle. |
| 47 | * @param error - null if the command is successful. |
| 48 | * @param str - response of the agent |
| 49 | */ |
| 50 | void doneGetTargets(IToken token, Exception error, String str[]); |
| 51 | } |
| 52 | |
| 53 | IToken getMarkers(String provider, String target, DoneGetMarkers done); |
| 54 | |
| 55 | interface DoneGetMarkers { |
| 56 | /** |
| 57 | * This method is called when getMarkers() command is completed. |
| 58 | * |
| 59 | * @param token - pending command handle. |
| 60 | * @param error - null if the command is successful. |
| 61 | * @param str - response of the agent |
| 62 | */ |
| 63 | void doneGetMarkers(IToken token, Exception error, String str[]); |
| 64 | } |
| 65 | |
| 66 | IToken getTraces(String provider, String target, DoneGetTraces done); |
| 67 | |
| 68 | interface DoneGetTraces { |
| 69 | /** |
| 70 | * This method is called when getTraces() command is completed. |
| 71 | * |
| 72 | * @param token - pending command handle. |
| 73 | * @param error - null if the command is successful. |
| 74 | * @param str - response of the agent |
| 75 | */ |
| 76 | void doneGetTraces(IToken token, Exception error, String str[]); |
| 77 | } |
| 78 | |
| 79 | IToken getActiveTraces(String provider, String target, DoneGetActiveTraces done); |
| 80 | |
| 81 | interface DoneGetActiveTraces { |
| 82 | /** |
| 83 | * This method is called when getTraces() command is completed. |
| 84 | * |
| 85 | * @param token - pending command handle. |
| 86 | * @param error - null if the command is successful. |
| 87 | * @param str - response of the agent |
| 88 | */ |
| 89 | void doneGetActiveTraces(IToken token, Exception error, String str[]); |
| 90 | } |
| 91 | |
| 92 | IToken getActiveTraceInfo(String provider, String target, String trace, DoneGetActiveTraceInfo done); |
| 93 | |
| 94 | interface DoneGetActiveTraceInfo { |
| 95 | /** |
| 96 | * This method is called when getTraces() command is completed. |
| 97 | * |
| 98 | * @param token - pending command handle. |
| 99 | * @param error - null if the command is successful. |
| 100 | * @param str - response of the agent |
| 101 | */ |
| 102 | void doneGetActiveTraceInfo(IToken token, Exception error, String str[]); |
| 103 | } |
| 104 | |
| 105 | |
| 106 | |
| 107 | IToken getChannels(String provider, String target, String trace, DoneGetChannels done); |
| 108 | |
| 109 | interface DoneGetChannels { |
| 110 | /** |
| 111 | * This method is called when getChannels() command is completed. |
| 112 | * |
| 113 | * @param token - pending command handle. |
| 114 | * @param error - null if the command is successful. |
| 115 | * @param str - response of the agent |
| 116 | */ |
| 117 | void doneGetChannels(IToken token, Exception error, String str[]); |
| 118 | } |
| 119 | |
| 120 | IToken setupTrace(String provider, String target, String trace, DoneSetupTrace done); |
| 121 | |
| 122 | interface DoneSetupTrace { |
| 123 | /** |
| 124 | * This method is called when setupTrace() command is completed. |
| 125 | * |
| 126 | * @param token - pending command handle. |
| 127 | * @param error - null if the command is successful. |
| 128 | * @param str - response of the agent |
| 129 | */ |
| 130 | void doneSetupTrace(IToken token, Exception error, Object str); |
| 131 | } |
| 132 | |
| 133 | IToken setTraceTransport(String provider, String target, String trace, String transport, DoneSetTraceTransport done); |
| 134 | |
| 135 | interface DoneSetTraceTransport { |
| 136 | /** |
| 137 | * This method is called when setTraceTransport() command is completed. |
| 138 | * |
| 139 | * @param token - pending command handle. |
| 140 | * @param error - null if the command is successful. |
| 141 | * @param str - response of the agent |
| 142 | */ |
| 143 | void doneSetTraceTransport(IToken token, Exception error, Object str); |
| 144 | } |
| 145 | |
| 146 | IToken getMarkerInfo(String provider, String target, String marker, DoneGetMarkerInfo done); |
| 147 | |
| 148 | interface DoneGetMarkerInfo { |
| 149 | /** |
| 150 | * This method is called when getMarkerInfo() command is completed. |
| 151 | * |
| 152 | * @param token - pending command handle. |
| 153 | * @param error - null if the command is successful. |
| 154 | * @param str - response of the agent |
| 155 | */ |
| 156 | void doneGetMarkerInfo(IToken token, Exception error, String str); |
| 157 | } |
| 158 | |
| 159 | IToken setMarkerEnable(String provider, String target, String marker, Boolean enable, DoneSetMarkerEnable done); |
| 160 | |
| 161 | interface DoneSetMarkerEnable { |
| 162 | /** |
| 163 | * This method is called when setMarkerEnable() command is completed. |
| 164 | * |
| 165 | * @param token - pending command handle. |
| 166 | * @param error - null if the command is successful. |
| 167 | * @param str - response of the agent |
| 168 | */ |
| 169 | void doneSetMarkerEnable(IToken token, Exception error, Object str); |
| 170 | } |
| 171 | |
| 172 | IToken writeTraceLocal(String provider, String target, String trace, String path, int numChannel, Boolean isAppend, Boolean isFlightRecorder, Boolean isNormalOnly, DoneWriteTraceLocal done); |
| 173 | |
| 174 | interface DoneWriteTraceLocal { |
| 175 | /** |
| 176 | * This method is called when writeTraceLocal() command is completed. |
| 177 | * |
| 178 | * @param token - pending command handle. |
| 179 | * @param error - null if the command is successful. |
| 180 | * @param str - response of the agent |
| 181 | */ |
| 182 | void doneWriteTraceLocal(IToken token, Exception error, Object str); |
| 183 | } |
| 184 | |
| 185 | IToken writeTraceNetwork(String provider, String target, String trace, int numChannel, Boolean isAppend, Boolean isFlightRecorder, Boolean isNormalOnly, DoneWriteTraceNetwork done); |
| 186 | |
| 187 | interface DoneWriteTraceNetwork { |
| 188 | /** |
| 189 | * This method is called when writeTraceNetwork() command is completed. |
| 190 | * |
| 191 | * @param token - pending command handle. |
| 192 | * @param error - null if the command is successful. |
| 193 | * @param str - response of the agent |
| 194 | */ |
| 195 | void doneWriteTraceNetwork(IToken token, Exception error, Object str); |
| 196 | } |
| 197 | |
| 198 | IToken allocTrace(String provider, String target, String trace, DoneAllocTrace done); |
| 199 | |
| 200 | interface DoneAllocTrace { |
| 201 | /** |
| 202 | * This method is called when allocTrace() command is completed. |
| 203 | * |
| 204 | * @param token - pending command handle. |
| 205 | * @param error - null if the command is successful. |
| 206 | * @param str - response of the agent |
| 207 | */ |
| 208 | void doneAllocTrace(IToken token, Exception error, Object str); |
| 209 | } |
| 210 | |
| 211 | IToken setChannelEnable(String provider, String target, String trace, String channel, Boolean enable, DoneSetChannelEnable done); |
| 212 | |
| 213 | interface DoneSetChannelEnable { |
| 214 | /** |
| 215 | * This method is called when setChannelEnable() command is completed. |
| 216 | * |
| 217 | * @param token - pending command handle. |
| 218 | * @param error - null if the command is successful. |
| 219 | * @param str - response of the agent |
| 220 | */ |
| 221 | void doneSetChannelEnable(IToken token, Exception error, Object str); |
| 222 | } |
| 223 | |
| 224 | IToken setChannelOverwrite(String provider, String target, String trace, String channel, Boolean overwrite, DoneSetChannelOverwrite done); |
| 225 | |
| 226 | interface DoneSetChannelOverwrite { |
| 227 | /** |
| 228 | * This method is called when setChannelOverwrite() command is completed. |
| 229 | * |
| 230 | * @param token - pending command handle. |
| 231 | * @param error - null if the command is successful. |
| 232 | * @param str - response of the agent |
| 233 | */ |
| 234 | void doneSetChannelOverwrite(IToken token, Exception error, Object str); |
| 235 | } |
| 236 | |
| 237 | IToken setChannelTimer(String provider, String target, String trace, String channel, long period, DoneSetChannelTimer done); |
| 238 | |
| 239 | interface DoneSetChannelTimer { |
| 240 | /** |
| 241 | * This method is called when setChannelTimer() command is completed. |
| 242 | * |
| 243 | * @param token - pending command handle. |
| 244 | * @param error - null if the command is successful. |
| 245 | * @param str - response of the agent |
| 246 | */ |
| 247 | void doneSetChannelTimer(IToken token, Exception error, Object str); |
| 248 | } |
| 249 | |
| 250 | IToken setChannelSubbufNum(String provider, String target, String trace, String channel, long subbufNum, DoneSetChannelSubbufNum done); |
| 251 | |
| 252 | interface DoneSetChannelSubbufNum { |
| 253 | /** |
| 254 | * This method is called when setChannelSubbufNum() command is completed. |
| 255 | * |
| 256 | * @param token - pending command handle. |
| 257 | * @param error - null if the command is successful. |
| 258 | * @param str - response of the agent |
| 259 | */ |
| 260 | void doneSetChannelSubbufNum(IToken token, Exception error, Object str); |
| 261 | } |
| 262 | |
| 263 | IToken setChannelSubbufSize(String provider, String target, String trace, String channel, long subbufSize, DoneSetChannelSubbufSize done); |
| 264 | |
| 265 | interface DoneSetChannelSubbufSize { |
| 266 | /** |
| 267 | * This method is called when setChannelSubbufSize() command is completed. |
| 268 | * |
| 269 | * @param token - pending command handle. |
| 270 | * @param error - null if the command is successful. |
| 271 | * @param str - response of the agent |
| 272 | */ |
| 273 | void doneSetChannelSubbufSize(IToken token, Exception error, Object str); |
| 274 | } |
| 275 | |
| 276 | IToken startTrace(String provider, String target, String trace, DoneStartTrace done); |
| 277 | |
| 278 | interface DoneStartTrace { |
| 279 | /** |
| 280 | * This method is called when startTrace() command is completed. |
| 281 | * |
| 282 | * @param token - pending command handle. |
| 283 | * @param error - null if the command is successful. |
| 284 | * @param str - response of the agent |
| 285 | */ |
| 286 | void doneStartTrace(IToken token, Exception error, Object str); |
| 287 | } |
| 288 | |
| 289 | IToken pauseTrace(String provider, String target, String trace, DonePauseTrace done); |
| 290 | |
| 291 | interface DonePauseTrace { |
| 292 | /** |
| 293 | * This method is called when pauseTrace() command is completed. |
| 294 | * |
| 295 | * @param token - pending command handle. |
| 296 | * @param error - null if the command is successful. |
| 297 | * @param str - response of the agent |
| 298 | */ |
| 299 | void donePauseTrace(IToken token, Exception error, Object str); |
| 300 | } |
| 301 | |
| 302 | IToken destroyTrace(String provider, String target, String trace, DoneDestroyTrace done); |
| 303 | |
| 304 | interface DoneDestroyTrace { |
| 305 | /** |
| 306 | * This method is called when destroyTrace() command is completed. |
| 307 | * |
| 308 | * @param token - pending command handle. |
| 309 | * @param error - null if the command is successful. |
| 310 | * @param str - response of the agent |
| 311 | */ |
| 312 | void doneDestroyTrace(IToken token, Exception error, Object str); |
| 313 | } |
| 314 | } |