org.eclipse.linuxtools.lttng/src/org/eclipse/linuxtools/lttng/state/trace/IStateTraceManager.java

   1 package org.eclipse.linuxtools.lttng.state.trace;
   2
   3 import org.eclipse.linuxtools.lttng.request.ILttngSyntEventRequest;
   4 import org.eclipse.linuxtools.lttng.request.IRequestStatusListener;
   5 import org.eclipse.linuxtools.lttng.signal.ILttExperimentSelectedListener;
   6 import org.eclipse.linuxtools.lttng.state.evProcessor.ITransEventProcessor;
   7 import org.eclipse.linuxtools.lttng.state.model.LttngTraceState;
   8 import org.eclipse.linuxtools.tmf.event.TmfTimeRange;
   9 import org.eclipse.linuxtools.tmf.event.TmfTimestamp;
  10 import org.eclipse.linuxtools.tmf.trace.ITmfTrace;
  11
  12 public interface IStateTraceManager extends ILttExperimentSelectedListener {
  13         /**
  14          * TODO: Not ready for threading
  15          * <p>
  16          * Read events within specific time window, e.g. time range selection
  17          * </p>
  18          *
  19          * @param trange
  20          * @param source
  21          * @param listener
  22          * @param processor
  23          * @return
  24          */
  25         public abstract ILttngSyntEventRequest executeDataRequest(
  26                         TmfTimeRange trange, Object source,
  27                         IRequestStatusListener listener, ITransEventProcessor processor);
  28
  29         /**
  30          * used to obtain details on the log associated with this manager e.g.
  31          * logid.
  32          *
  33          * @return
  34          */
  35         public abstract ITmfTrace getTrace();
  36
  37         /**
  38          * Restore to the closest checkpoint from TmfTimestamp
  39          * <p>
  40          * Note : it is heavier to restore by timestamp than by event position,
  41          * restore by event position whichever possible.
  42          *
  43          * @param eventTime
  44          *            The timestamp of the event to restore to
  45          *
  46          * @return TmfTimestamp indicates the nearest time used to restore the
  47          *         state, null sent if input is invalid
  48          */
  49         public abstract TmfTimestamp restoreCheckPointByTimestamp(
  50                         TmfTimestamp eventTime);
  51
  52         /**
  53          * @return
  54          */
  55         public abstract TmfTimeRange getExperimentTimeWindow();
  56
  57         /**
  58          * Returns the State model instance associated with this Trace
  59          *
  60          * @return
  61          */
  62         public abstract LttngTraceState getStateModel();
  63
  64 }