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