/**********************************************************************
- * Copyright (c) 2012 Ericsson
- *
+ * Copyright (c) 2012, 2013 Ericsson
+ *
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
+ *
+ * Contributors:
* Bernd Hufmann - Initial API and implementation
**********************************************************************/
package org.eclipse.linuxtools.internal.lttng2.core.control.model;
* <p>
* Interface for retrieval of trace channel information.
* </p>
- *
+ *
* @author Bernd Hufmann
*/
public interface IChannelInfo extends ITraceInfo {
*/
public final static boolean DEFAULT_OVERWRITE_MODE = false;
/**
- * Default value for sub-buffer size for a UST channel.
+ * Default value for sub-buffer size for a UST channel.
*/
public final static long DEFAULT_SUB_BUFFER_SIZE_UST = 4096L;
/**
- * Default value for sub-buffer size for a Kernel channel.
+ * Default value for sub-buffer size for a Kernel channel.
*/
public final static long DEFAULT_SUB_BUFFER_SIZE_KERNEL = 262144L;
/**
- * Default value for number of sub-buffer a UST channel.
+ * Default value for number of sub-buffer a UST channel.
*/
public final static int DEFAULT_NUMBER_OF_SUB_BUFFERS_UST = 8;
/**
- * Default value for number of sub-buffer a Kernel channel.
+ * Default value for number of sub-buffer a Kernel channel.
*/
public final static int DEFAULT_NUMBER_OF_SUB_BUFFERS_KERNEL = 4;
/**
- * Default value for number of the switch timer interval.
+ * Default value for number of the switch timer interval.
*/
public final static long DEFAULT_SWITCH_TIMER = 0;
/**
- * Default value for number of the read timer interval.
+ * Default value for number of the read timer interval.
*/
public final static long DEFAULT_READ_TIMER = 200;
-
+
/**
* @return the overwrite mode value.
*/
- public boolean isOverwriteMode();
+ boolean isOverwriteMode();
/**
* Sets the overwrite mode value to the given mode.
* @param mode - mode to set.
*/
- public void setOverwriteMode(boolean mode);
+ void setOverwriteMode(boolean mode);
/**
* @return the sub-buffer size.
*/
- public long getSubBufferSize();
+ long getSubBufferSize();
/**
* Sets the sub-buffer size to the given value.
* @param bufferSize - size to set to set.
*/
- public void setSubBufferSize(long bufferSize);
+ void setSubBufferSize(long bufferSize);
/**
* @return the number of sub-buffers.
*/
- public int getNumberOfSubBuffers();
+ int getNumberOfSubBuffers();
/**
* Sets the number of sub-buffers to the given value.
* @param numberOfSubBuffers - value to set.
*/
- public void setNumberOfSubBuffers(int numberOfSubBuffers);
+ void setNumberOfSubBuffers(int numberOfSubBuffers);
/**
* @return the switch timer interval.
*/
- public long getSwitchTimer();
+ long getSwitchTimer();
/**
* Sets the switch timer interval to the given value.
* @param timer - timer value to set.
*/
- public void setSwitchTimer(long timer);
-
+ void setSwitchTimer(long timer);
+
/**
* @return the read timer interval.
*/
- public long getReadTimer();
+ long getReadTimer();
/**
* Sets the read timer interval to the given value.
* @param timer - timer value to set..
*/
- public void setReadTimer(long timer);
+ void setReadTimer(long timer);
/**
* @return the output type.
*/
- public String getOutputType();
+ String getOutputType();
/**
* Sets the output type to the given value.
* @param type - type to set.
*/
- public void setOutputType(String type);
-
+ void setOutputType(String type);
+
/**
* @return the channel state (enabled or disabled).
*/
- public TraceEnablement getState();
+ TraceEnablement getState();
/**
* Sets the channel state (enablement) to the given value.
* @param state - state to set.
*/
- public void setState(TraceEnablement state);
+ void setState(TraceEnablement state);
/**
* Sets the channel state (enablement) to the value specified by the given name.
* @param stateName - state to set.
*/
- public void setState(String stateName);
+ void setState(String stateName);
/**
* @return all event information as array.
*/
- public IEventInfo[] getEvents();
+ IEventInfo[] getEvents();
/**
* Sets the event information specified by given list.
* @param events - all event information to set.
*/
- public void setEvents(List<IEventInfo> events);
+ void setEvents(List<IEventInfo> events);
/**
* Adds a single event information.
* @param event - event information to add.
*/
- public void addEvent(IEventInfo event);
+ void addEvent(IEventInfo event);
}