Commit | Line | Data |
---|---|---|
eb1bab5b BH |
1 | /********************************************************************** |
2 | * Copyright (c) 2012 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 | * Bernd Hufmann - Initial API and implementation | |
11 | **********************************************************************/ | |
12 | package org.eclipse.linuxtools.lttng.ui.views.control.model; | |
13 | ||
14 | import java.util.List; | |
15 | ||
16 | /** | |
17 | * <b><u>IChannelInfo</u></b> | |
18 | * <p> | |
19 | * Interface for retrieval of trace channel information. | |
20 | * </p> | |
21 | */ | |
22 | public interface IChannelInfo extends ITraceInfo { | |
23 | ||
24 | /** | |
25 | * @return the overwrite mode value. | |
26 | */ | |
27 | public boolean isOverwriteMode(); | |
28 | /** | |
29 | * Sets the overwrite mode value to the given mode. | |
30 | * @param mode - mode to set. | |
31 | */ | |
32 | public void setOverwriteMode(boolean mode); | |
33 | ||
34 | /** | |
35 | * @return the sub-buffer size. | |
36 | */ | |
37 | public long getSubBufferSize(); | |
38 | /** | |
39 | * Sets the sub-buffer size to the given value. | |
40 | * @param bufferSize - size to set to set. | |
41 | */ | |
42 | public void setSubBufferSize(long bufferSize); | |
43 | ||
44 | /** | |
45 | * @return the number of sub-buffers. | |
46 | */ | |
47 | public int getNumberOfSubBuffers(); | |
48 | /** | |
49 | * Sets the number of sub-buffers to the given value. | |
50 | * @param numberOfSubBuffers - value to set. | |
51 | */ | |
52 | public void setNumberOfSubBuffers(int numberOfSubBuffers); | |
53 | ||
54 | /** | |
55 | * @return the switch timer interval. | |
56 | */ | |
57 | public long getSwitchTimer(); | |
58 | /** | |
59 | * Sets the switch timer interval to the given value. | |
60 | * @param timer - timer value to set. | |
61 | */ | |
62 | public void setSwitchTimer(long timer); | |
63 | ||
64 | /** | |
65 | * @return the read timer interval. | |
66 | */ | |
67 | public long getReadTimer(); | |
68 | /** | |
69 | * Sets the read timer interval to the given value. | |
70 | * @param timer - timer value to set.. | |
71 | */ | |
72 | public void setReadTimer(long timer); | |
73 | ||
74 | /** | |
75 | * @return the output type. | |
76 | */ | |
77 | public String getOutputType(); | |
78 | /** | |
79 | * Sets the output type to the given value. | |
80 | * @param type - type to set. | |
81 | */ | |
82 | public void setOutputType(String type); | |
83 | ||
84 | /** | |
85 | * @return the channel state (enabled or disabled). | |
86 | */ | |
87 | public TraceEnablement getState(); | |
88 | /** | |
89 | * Sets the channel state (enablement) to the given value. | |
90 | * @param state - state to set. | |
91 | */ | |
92 | public void setState(TraceEnablement state); | |
93 | /** | |
94 | * Sets the channel state (enablement) to the value specified by the given name. | |
95 | * @param stateName - state to set. | |
96 | */ | |
97 | public void setState(String stateName); | |
98 | ||
99 | /** | |
100 | * @return all event information as array. | |
101 | */ | |
102 | public IEventInfo[] getEvents(); | |
103 | /** | |
104 | * Sets the event information specified by given list. | |
105 | * @param events - all event information to set. | |
106 | */ | |
107 | public void setEvents(List<IEventInfo> events); | |
108 | /** | |
109 | * Adds a single event information. | |
110 | * @param event - event information to add. | |
111 | */ | |
112 | public void addEvent(IEventInfo event); | |
113 | } |