[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf / src / org / eclipse / linuxtools / tmf / eventlog / ITmfRequestHandler.java

/*******************************************************************************
 * Copyright (c) 2009 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 (fchouinard@gmail.com) - Initial API and implementation
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.eventlog;

/**
 * <b><u>ITmfRequestHandler</u></b>
 * <p>
 * TODO: Implement me. Please.
 */
public interface ITmfRequestHandler {

    /**
     * Process the request. The client thread can be suspended until the 
     * request is completed (e.g. for a specific range of events) or it
     * can choose to process the events asynchronously (e.g. for streaming).
     * 
     * @param waitForCompletion Suspend the client thread until the request completes or is canceled 
     */
    public void process(TmfEventRequest request, boolean waitForCompletion);

}
Commit	Line	Data
4ab33d2b AO	1	/*******************************************************************************
	2	* Copyright (c) 2009 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 (fchouinard@gmail.com) - Initial API and implementation
	11	*******************************************************************************/
	12
	13	package org.eclipse.linuxtools.tmf.eventlog;
	14
	15	/**
	16	* <b><u>ITmfRequestHandler</u></b>
	17	* <p>
	18	* TODO: Implement me. Please.
	19	*/
	20	public interface ITmfRequestHandler {
	21
	22	/**
	23	* Process the request. The client thread can be suspended until the
	24	* request is completed (e.g. for a specific range of events) or it
	25	* can choose to process the events asynchronously (e.g. for streaming).
	26	*
	27	* @param waitForCompletion Suspend the client thread until the request completes or is canceled
	28	*/
	29	public void process(TmfEventRequest request, boolean waitForCompletion);
	30
	31	}