tmf/lttng: Update 2014 copyrights

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / component / ITmfComponent.java

/*******************************************************************************
 * Copyright (c) 2009, 2014 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Francois Chouinard - Initial API and implementation
 *   Bernd Hufmann - Add interface for broadcasting signals asynchronously
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.core.component;

import org.eclipse.linuxtools.tmf.core.signal.TmfSignal;

/**
 * This is the basic interface of all the TMF components.
 * <p>
 * Currently, it only addresses the inter-component signalling.
 *
 * @version 1.0
 * @author Francois Chouinard
 *
 * @see TmfComponent
 */
public interface ITmfComponent {

    /**
     * @return the component ID (display name)
     */
    String getName();

    /**
     * Dispose of the component
     */
    void dispose();

    /**
     * Propagate a signal to all the interested listeners in
     * the same thread of execution.
     *
     * @param signal the signal to broadcast
     */
    void broadcast(TmfSignal signal);

    /**
     * Propagate a signal to all the interested listeners
     * in a separate thread.
     *
     * @param signal the signal to broadcast
     * @since 3.0
     */
    void broadcastAsync(TmfSignal signal);
}