/*************************************************************************
 *
 *  $RCSfile: XActiveDataControl.idl,v $
 *
 *  $Revision: 1.6.24.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 18:02:22 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_io_XActiveDataControl_idl__ 
#define __com_sun_star_io_XActiveDataControl_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_io_XStreamListener_idl__ 
#include <com/sun/star/io/XStreamListener.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module io {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::io::XActiveDataControl
/** makes it possible to control an active data source.
	
	<p>This interface should be supported by objects which implement
	<type>XActiveDataSource</type> or <type>XActiveDataSink</type>.</p>
 */
interface XActiveDataControl: com::sun::star::uno::XInterface
{ 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::addListener
	/** registers an object to receive events from this data source.

       <p>It is suggested to allow multiple registration of the same listener,
	    thus for each time a listener is added, it has to be removed.
	 */
	void addListener( [in] com::sun::star::io::XStreamListener aListener ); 
 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::removeListener
	/** unregisters an object to receive events from this data source.

       <p>It is suggested to allow multiple registration of the same listener,
	    thus for each time a listener is added, it has to be removed.
	 */
	void removeListener( [in] com::sun::star::io::XStreamListener aListener ); 
 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::start
	/** starts I/O.
		
		<p>Either <member>XActiveDataControl::setInputStream()</member> or
		<member>XActiveDataControl::setOutputStream()</member> must be called beforehand.
		</p>

		<p>This method does not block the thread, so reading is
		generally not finished when the method returns. </p>
	 */
	void start(); 
 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::XActiveDataControl::terminate
	/** does a weak abort. 
		
		<p>It closes all connected resources and calls
		<member>XInputStream::close</member> or
		<member>XOutputStream::close</member> and fires the 
		<member>XStreamListener::terminated</member>-event.</p>
	 */
	void terminate(); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
	$Log: XActiveDataControl.idl,v $
	Revision 1.6.24.2  2003/01/21 18:02:22  mi
	merged src641 odk changes
	
	Revision 1.7  2002/08/05 09:33:54  mi
	add/remove...Listener more precisely specified for adding the same interface multiple times
	
	Revision 1.6  2001/03/16 15:10:36  jsc
	remove interfaceheader with uik and remove [const] in method definitions
	
	Revision 1.5  2000/12/11 16:09:49  mi
	documentation syntax fixed and some minor semantic documentation fixes
	
	Revision 1.4  2000/11/08 12:28:36  mi
	moved from api
	
	Revision 1.1.1.1  2000/09/18 23:35:23  hjs
	initial import
	
	Revision 1.4  2000/09/11 11:52:31  mi
	documentation merged from XML
	 
	Revision 1.2  2000/07/03 07:45:52  abi 
	Added XStream for read/write access to a stream 
	and XActiveDataStreamer as controller. 
	Updating documentation. 
	 
	Revision 1.1.1.1  1999/11/11 09:48:43  jsc 
	new 
	 
 
=============================================================================*/ 
#endif 
