Commit | Line | Data |
---|---|---|
534c96ce | 1 | /******************************************************************************* |
61759503 | 2 | * Copyright (c) 2012, 2013 Ericsson |
534c96ce FC |
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 | * Francois Chouinard - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
13 | package org.eclipse.linuxtools.tmf.core.event; | |
14 | ||
3bd46eef AM |
15 | import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange; |
16 | ||
534c96ce FC |
17 | /** |
18 | * The generic lost event structure in TMF. | |
19 | * | |
20 | * In some demanding situations, tracers can be overwhelmed and have a hard time | |
21 | * keeping up with the flow of events to record. Usually, even if a tracer can't | |
22 | * keep up, it can at least record the number of events that it lost. | |
23 | * | |
24 | * This interface provides the different components (e.g. views) with a mean to | |
25 | * identify and highlight such events. | |
26 | * | |
27 | * This interface extends ITmfEvent by adding the number of lost events for a | |
28 | * 'problematic' time range. | |
29 | * | |
30 | * @see TmfLostEvent | |
31 | * | |
32 | * @author Francois Chouinard | |
33 | * @version 1.0 | |
77c4a6df | 34 | * @since 1.2 |
534c96ce FC |
35 | */ |
36 | public interface ITmfLostEvent extends ITmfEvent { | |
37 | ||
38 | // ------------------------------------------------------------------------ | |
39 | // Getters | |
40 | // ------------------------------------------------------------------------ | |
41 | ||
42 | /** | |
43 | * @return the 'problem' time range | |
3bd46eef | 44 | * @since 2.0 |
534c96ce FC |
45 | */ |
46 | public TmfTimeRange getTimeRange(); | |
47 | ||
48 | /** | |
49 | * @return the number of lost events in the time range | |
50 | */ | |
51 | public long getNbLostEvents(); | |
52 | ||
53 | } |