Commit | Line | Data |
---|---|---|
eb1bab5b | 1 | /********************************************************************** |
a6e6f7b4 BH |
2 | * Copyright (c) 2012, 2013 Ericsson |
3 | * | |
eb1bab5b BH |
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 | |
a6e6f7b4 BH |
8 | * |
9 | * Contributors: | |
eb1bab5b | 10 | * Bernd Hufmann - Initial API and implementation |
e799e5f3 | 11 | * Simon Delisle - Updated for support of LTTng Tools 2.2 |
eb1bab5b | 12 | **********************************************************************/ |
9315aeee | 13 | package org.eclipse.linuxtools.internal.lttng2.core.control.model; |
eb1bab5b BH |
14 | |
15 | import java.util.List; | |
16 | ||
83051fc3 BH |
17 | import org.eclipse.linuxtools.internal.lttng2.core.control.model.impl.BufferType; |
18 | ||
eb1bab5b | 19 | /** |
eb1bab5b BH |
20 | * <p> |
21 | * Interface for retrieval of trace channel information. | |
22 | * </p> | |
a6e6f7b4 | 23 | * |
dbd4432d | 24 | * @author Bernd Hufmann |
eb1bab5b BH |
25 | */ |
26 | public interface IChannelInfo extends ITraceInfo { | |
27 | ||
bbb3538a BH |
28 | // ------------------------------------------------------------------------ |
29 | // Constants | |
30 | // ------------------------------------------------------------------------ | |
31 | /** | |
32 | * Default value for overwrite mode. | |
33 | */ | |
34 | public final static boolean DEFAULT_OVERWRITE_MODE = false; | |
a6e6f7b4 | 35 | |
eb1bab5b BH |
36 | /** |
37 | * @return the overwrite mode value. | |
38 | */ | |
a6e6f7b4 | 39 | boolean isOverwriteMode(); |
eb1bab5b BH |
40 | /** |
41 | * Sets the overwrite mode value to the given mode. | |
42 | * @param mode - mode to set. | |
43 | */ | |
a6e6f7b4 | 44 | void setOverwriteMode(boolean mode); |
eb1bab5b BH |
45 | |
46 | /** | |
47 | * @return the sub-buffer size. | |
48 | */ | |
a6e6f7b4 | 49 | long getSubBufferSize(); |
eb1bab5b BH |
50 | /** |
51 | * Sets the sub-buffer size to the given value. | |
52 | * @param bufferSize - size to set to set. | |
53 | */ | |
a6e6f7b4 | 54 | void setSubBufferSize(long bufferSize); |
eb1bab5b BH |
55 | |
56 | /** | |
57 | * @return the number of sub-buffers. | |
58 | */ | |
a6e6f7b4 | 59 | int getNumberOfSubBuffers(); |
eb1bab5b BH |
60 | /** |
61 | * Sets the number of sub-buffers to the given value. | |
62 | * @param numberOfSubBuffers - value to set. | |
63 | */ | |
a6e6f7b4 | 64 | void setNumberOfSubBuffers(int numberOfSubBuffers); |
eb1bab5b BH |
65 | |
66 | /** | |
67 | * @return the switch timer interval. | |
68 | */ | |
a6e6f7b4 | 69 | long getSwitchTimer(); |
eb1bab5b BH |
70 | /** |
71 | * Sets the switch timer interval to the given value. | |
72 | * @param timer - timer value to set. | |
73 | */ | |
a6e6f7b4 BH |
74 | void setSwitchTimer(long timer); |
75 | ||
eb1bab5b BH |
76 | /** |
77 | * @return the read timer interval. | |
78 | */ | |
a6e6f7b4 | 79 | long getReadTimer(); |
eb1bab5b BH |
80 | /** |
81 | * Sets the read timer interval to the given value. | |
82 | * @param timer - timer value to set.. | |
83 | */ | |
a6e6f7b4 | 84 | void setReadTimer(long timer); |
eb1bab5b BH |
85 | |
86 | /** | |
87 | * @return the output type. | |
88 | */ | |
a6e6f7b4 | 89 | String getOutputType(); |
eb1bab5b BH |
90 | /** |
91 | * Sets the output type to the given value. | |
92 | * @param type - type to set. | |
93 | */ | |
a6e6f7b4 BH |
94 | void setOutputType(String type); |
95 | ||
eb1bab5b BH |
96 | /** |
97 | * @return the channel state (enabled or disabled). | |
98 | */ | |
a6e6f7b4 | 99 | TraceEnablement getState(); |
eb1bab5b BH |
100 | /** |
101 | * Sets the channel state (enablement) to the given value. | |
102 | * @param state - state to set. | |
103 | */ | |
a6e6f7b4 | 104 | void setState(TraceEnablement state); |
eb1bab5b BH |
105 | /** |
106 | * Sets the channel state (enablement) to the value specified by the given name. | |
107 | * @param stateName - state to set. | |
108 | */ | |
a6e6f7b4 | 109 | void setState(String stateName); |
eb1bab5b BH |
110 | |
111 | /** | |
112 | * @return all event information as array. | |
113 | */ | |
a6e6f7b4 | 114 | IEventInfo[] getEvents(); |
eb1bab5b BH |
115 | /** |
116 | * Sets the event information specified by given list. | |
117 | * @param events - all event information to set. | |
118 | */ | |
a6e6f7b4 | 119 | void setEvents(List<IEventInfo> events); |
eb1bab5b BH |
120 | /** |
121 | * Adds a single event information. | |
122 | * @param event - event information to add. | |
123 | */ | |
a6e6f7b4 | 124 | void addEvent(IEventInfo event); |
e799e5f3 SD |
125 | /** |
126 | * Sets the maximum size of trace files | |
127 | * @param maxSizeTraceFiles - maximum size | |
128 | */ | |
129 | void setMaxSizeTraceFiles(int maxSizeTraceFiles); | |
130 | /** | |
131 | * Sets the maximum number of trace files | |
132 | * @param maxNumberTraceFiles - maximum number | |
133 | */ | |
134 | void setMaxNumberTraceFiles(int maxNumberTraceFiles); | |
135 | /** | |
136 | * @return maximum size of trace files | |
137 | */ | |
138 | int getMaxSizeTraceFiles(); | |
139 | /** | |
140 | * @return maximum number of trace files | |
141 | */ | |
142 | int getMaxNumberTraceFiles(); | |
143 | /** | |
144 | * Sets per UID buffers | |
145 | * @param buffersUID - enable or not | |
146 | */ | |
83051fc3 | 147 | void setBufferType(BufferType buffersUID); |
e799e5f3 SD |
148 | /** |
149 | * @return the value of buffersUID (enable or not) | |
150 | */ | |
83051fc3 | 151 | BufferType getBufferType(); |
eb1bab5b | 152 | } |