org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/component/ITmfComponent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2014 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  *   Bernd Hufmann - Add interface for broadcasting signals asynchronously
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.tmf.core.component;
  15
  16 import org.eclipse.tracecompass.tmf.core.signal.TmfSignal;
  17
  18 /**
  19  * This is the basic interface of all the TMF components.
  20  * <p>
  21  * Currently, it only addresses the inter-component signalling.
  22  *
  23  * @author Francois Chouinard
  24  *
  25  * @see TmfComponent
  26  */
  27 public interface ITmfComponent {
  28
  29     /**
  30      * @return the component ID (display name)
  31      */
  32     String getName();
  33
  34     /**
  35      * Dispose of the component
  36      */
  37     void dispose();
  38
  39     /**
  40      * Propagate a signal to all the interested listeners in
  41      * the same thread of execution.
  42      *
  43      * @param signal the signal to broadcast
  44      */
  45     void broadcast(TmfSignal signal);
  46
  47     /**
  48      * Propagate a signal to all the interested listeners
  49      * in a separate thread.
  50      *
  51      * @param signal the signal to broadcast
  52      */
  53     void broadcastAsync(TmfSignal signal);
  54 }