:: com :: sun :: star :: io ::

interface XActiveDataControl
Base Interfaces
::com::sun::star::uno::XInterface
  |  
  +--XActiveDataControl
::com::sun::star::uno::XInterface
(referenced interface's summary:)
base interface of all UNO interfaces
Description
makes it possible to control an active data source.

This interface should be supported by objects which implement ::com::sun::star::io::XActiveDataSource or ::com::sun::star::io::XActiveDataSink .


Methods' Summary
addListener registers an object to receive events from this data source.  
removeListener unregisters an object to receive events from this data source.  
start starts I/O.  
terminate does a weak abort.  
Methods' Details
addListener
void
addListener( [in] ::com::sun::star::io::XStreamListener  aListener );

Description
registers an object to receive events from this data source.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

removeListener
void
removeListener( [in] ::com::sun::star::io::XStreamListener  aListener );

Description
unregisters an object to receive events from this data source.

It is suggested to allow multiple registration of the same listener, thus for each time a listener is added, it has to be removed.

start
void
start();

Description
starts I/O.

Either ::com::sun::star::io::XActiveDataControl::setInputStream() or ::com::sun::star::io::XActiveDataControl::setOutputStream() must be called beforehand.

This method does not block the thread, so reading is generally not finished when the method returns.

terminate
void
terminate();

Description
does a weak abort.

It closes all connected resources and calls ::com::sun::star::io::XInputStream::close or ::com::sun::star::io::XOutputStream::close and fires the ::com::sun::star::io::XStreamListener::terminated -event.

Top of Page