| 1 | /********************************************************************** |
| 2 | * Copyright (c) 2012, 2013 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.internal.lttng2.core.control.model; |
| 13 | |
| 14 | import java.util.List; |
| 15 | |
| 16 | /** |
| 17 | * <p> |
| 18 | * Interface for retrieval of trace channel information. |
| 19 | * </p> |
| 20 | * |
| 21 | * @author Bernd Hufmann |
| 22 | */ |
| 23 | public interface IChannelInfo extends ITraceInfo { |
| 24 | |
| 25 | // ------------------------------------------------------------------------ |
| 26 | // Constants |
| 27 | // ------------------------------------------------------------------------ |
| 28 | /** |
| 29 | * Default value for overwrite mode. |
| 30 | */ |
| 31 | public final static boolean DEFAULT_OVERWRITE_MODE = false; |
| 32 | /** |
| 33 | * Default value for sub-buffer size for a UST channel. |
| 34 | */ |
| 35 | public final static long DEFAULT_SUB_BUFFER_SIZE_UST = 4096L; |
| 36 | /** |
| 37 | * Default value for sub-buffer size for a Kernel channel. |
| 38 | */ |
| 39 | public final static long DEFAULT_SUB_BUFFER_SIZE_KERNEL = 262144L; |
| 40 | /** |
| 41 | * Default value for number of sub-buffer a UST channel. |
| 42 | */ |
| 43 | public final static int DEFAULT_NUMBER_OF_SUB_BUFFERS_UST = 8; |
| 44 | /** |
| 45 | * Default value for number of sub-buffer a Kernel channel. |
| 46 | */ |
| 47 | public final static int DEFAULT_NUMBER_OF_SUB_BUFFERS_KERNEL = 4; |
| 48 | /** |
| 49 | * Default value for number of the switch timer interval. |
| 50 | */ |
| 51 | public final static long DEFAULT_SWITCH_TIMER = 0; |
| 52 | /** |
| 53 | * Default value for number of the read timer interval. |
| 54 | */ |
| 55 | public final static long DEFAULT_READ_TIMER = 200; |
| 56 | |
| 57 | /** |
| 58 | * @return the overwrite mode value. |
| 59 | */ |
| 60 | boolean isOverwriteMode(); |
| 61 | /** |
| 62 | * Sets the overwrite mode value to the given mode. |
| 63 | * @param mode - mode to set. |
| 64 | */ |
| 65 | void setOverwriteMode(boolean mode); |
| 66 | |
| 67 | /** |
| 68 | * @return the sub-buffer size. |
| 69 | */ |
| 70 | long getSubBufferSize(); |
| 71 | /** |
| 72 | * Sets the sub-buffer size to the given value. |
| 73 | * @param bufferSize - size to set to set. |
| 74 | */ |
| 75 | void setSubBufferSize(long bufferSize); |
| 76 | |
| 77 | /** |
| 78 | * @return the number of sub-buffers. |
| 79 | */ |
| 80 | int getNumberOfSubBuffers(); |
| 81 | /** |
| 82 | * Sets the number of sub-buffers to the given value. |
| 83 | * @param numberOfSubBuffers - value to set. |
| 84 | */ |
| 85 | void setNumberOfSubBuffers(int numberOfSubBuffers); |
| 86 | |
| 87 | /** |
| 88 | * @return the switch timer interval. |
| 89 | */ |
| 90 | long getSwitchTimer(); |
| 91 | /** |
| 92 | * Sets the switch timer interval to the given value. |
| 93 | * @param timer - timer value to set. |
| 94 | */ |
| 95 | void setSwitchTimer(long timer); |
| 96 | |
| 97 | /** |
| 98 | * @return the read timer interval. |
| 99 | */ |
| 100 | long getReadTimer(); |
| 101 | /** |
| 102 | * Sets the read timer interval to the given value. |
| 103 | * @param timer - timer value to set.. |
| 104 | */ |
| 105 | void setReadTimer(long timer); |
| 106 | |
| 107 | /** |
| 108 | * @return the output type. |
| 109 | */ |
| 110 | String getOutputType(); |
| 111 | /** |
| 112 | * Sets the output type to the given value. |
| 113 | * @param type - type to set. |
| 114 | */ |
| 115 | void setOutputType(String type); |
| 116 | |
| 117 | /** |
| 118 | * @return the channel state (enabled or disabled). |
| 119 | */ |
| 120 | TraceEnablement getState(); |
| 121 | /** |
| 122 | * Sets the channel state (enablement) to the given value. |
| 123 | * @param state - state to set. |
| 124 | */ |
| 125 | void setState(TraceEnablement state); |
| 126 | /** |
| 127 | * Sets the channel state (enablement) to the value specified by the given name. |
| 128 | * @param stateName - state to set. |
| 129 | */ |
| 130 | void setState(String stateName); |
| 131 | |
| 132 | /** |
| 133 | * @return all event information as array. |
| 134 | */ |
| 135 | IEventInfo[] getEvents(); |
| 136 | /** |
| 137 | * Sets the event information specified by given list. |
| 138 | * @param events - all event information to set. |
| 139 | */ |
| 140 | void setEvents(List<IEventInfo> events); |
| 141 | /** |
| 142 | * Adds a single event information. |
| 143 | * @param event - event information to add. |
| 144 | */ |
| 145 | void addEvent(IEventInfo event); |
| 146 | } |