org.eclipse.linuxtools.lttng2.core/src/org/eclipse/linuxtools/internal/lttng2/core/control/model/IChannelInfo.java

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