rms/org.eclipse.ptp.rm.jaxb.core/src/org/eclipse/ptp/rm/jaxb/core/ICommandJobStreamMonitor.java

/*******************************************************************************
 * Copyright (c) 2011 University of Illinois 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: 
 * 	Albert L. Rossi - design and implementation
 ******************************************************************************/
package org.eclipse.ptp.rm.jaxb.core;

import org.eclipse.debug.core.model.IStreamMonitor;

/**
 * CommandJob-specific extension of the stream monitor.
 * 
 * @see org.eclipse.debug.core.model.IStreamMonitor
 * @author arossi
 * 
 */
public interface ICommandJobStreamMonitor extends IStreamMonitor {

	/**
	 * Manually close the monitor/streams.
	 */
	void close();

	/**
	 * Initialize file path from current env.
	 * 
	 * @param jobId
	 *            from status
	 */
	void initializeFilePath(String jobId);

	/**
	 * Tune the monitor's buffer size
	 * 
	 * @param limit
	 *            in chars
	 * 
	 */
	void setBufferLimit(int limit);

	/**
	 * Starts the reading from the stream.
	 */
	void startMonitoring();
}