Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: io ::
unpublished | interface XAsyncOutputMonitor |
Usage Restrictions not published Description An optional companion interface to XOutputStream that supports scenarios where XOutputStream::writeBytes operates asynchronously and does not necessarily report any errors. A typical scenario where this interface is useful is when an XOutputStream is used to write to a file via NFS. Normally, any calls to XOutputStream::writeBytes will execute asynchronously then, in that any potential errors might only be reported by later calls to XOutputStream::writeBytes or XOutputStream::closeOutput. If such an output stream shall not be closed immediately after one or more calls to XOutputStream::writeBytes, but the client wants to know as soon as possible whether writing was successful, then XAsyncOutputMonitor::waitForCompletion should be called after the series of calls to XOutputStream::writeBytes. Since OOo 2.0

Methods' Summary
waitForCompletion | waits for the completion of any previous calls to XOutputStream::writeBytes, and reports potentially pending errors.

Methods' Details
waitForCompletion
void
waitForCompletion()
raises( | IOException );
Description waits for the completion of any previous calls to XOutputStream::writeBytes, and reports potentially pending errors. Calling this method is potentially expensive (even if the associated XOutputStream represents a local file not accessed via NFS, for example). This method has a similar description to XOutputStream::flush. However, where the semantics of `flush` are rather vague, `waitForCompletion` has very specific semantics—it just blocks long enough so that any errors encountered during previous calls to XOutputStream::writeBytes can reliably be reported. It specificially does not guarantee that any data have savely been stored on a stable physical medium, like a hard disk (and it is completely unspecified whether `flush` should give this guarantee). Throws com::sun::star::io::IOException if any previous call to XOutputStream::writeBytes encountered such an error, but has not yet reported it (in cases where `writeBytes` operates asynchronously).

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.