1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_io_XAsyncOutputMonitor_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_io_XAsyncOutputMonitor_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_io_IOException_idl__ 32*cdf0e10cSrcweir#include "com/sun/star/io/IOException.idl" 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 35*cdf0e10cSrcweir#include "com/sun/star/uno/XInterface.idl" 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweirmodule com { module sun { module star { module io { 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir/** 41*cdf0e10cSrcweir An optional companion interface to 42*cdf0e10cSrcweir <type scope="com::sun::star::io">XOutputStream</type> that supports scenarios 43*cdf0e10cSrcweir where <member scope="com::sun::star::io">XOutputStream::writeBytes</member> 44*cdf0e10cSrcweir operates asynchronously and does not necessarily report any errors. 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir <p>A typical scenario where this interface is useful is when an 47*cdf0e10cSrcweir <type scope="com::sun::star::io">XOutputStream</type> is used to write to a 48*cdf0e10cSrcweir file via NFS. Normally, any calls to 49*cdf0e10cSrcweir <member scope="com::sun::star::io">XOutputStream::writeBytes</member> will 50*cdf0e10cSrcweir execute asynchronously then, in that any potential errors might only be 51*cdf0e10cSrcweir reported by later calls to 52*cdf0e10cSrcweir <member scope="com::sun::star::io">XOutputStream::writeBytes</member> or 53*cdf0e10cSrcweir <member scope="com::sun::star::io">XOutputStream::closeOutput</member>. If 54*cdf0e10cSrcweir such an output stream shall not be closed immediately after one or more calls 55*cdf0e10cSrcweir to <member scope="com::sun::star::io">XOutputStream::writeBytes</member>, but 56*cdf0e10cSrcweir the client wants to know as soon as possible whether writing was successful, 57*cdf0e10cSrcweir then <member 58*cdf0e10cSrcweir scope="com::sun::star::io">XAsyncOutputMonitor::waitForCompletion</member> 59*cdf0e10cSrcweir should be called after the series of calls to 60*cdf0e10cSrcweir <member scope="com::sun::star::io">XOutputStream::writeBytes</member>.</p> 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir @since OOo 2.0 63*cdf0e10cSrcweir*/ 64*cdf0e10cSrcweirinterface XAsyncOutputMonitor { 65*cdf0e10cSrcweir /** 66*cdf0e10cSrcweir waits for the completion of any previous calls to 67*cdf0e10cSrcweir <member scope="com::sun::star::io">XOutputStream::writeBytes</member>, 68*cdf0e10cSrcweir and reports potentially pending errors. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir <p>Calling this method is potentially expensive (even if the associated 71*cdf0e10cSrcweir <type scope="com::sun::star::io">XOutputStream</type> represents a local 72*cdf0e10cSrcweir file not accessed via NFS, for example). This method has a similar 73*cdf0e10cSrcweir description to 74*cdf0e10cSrcweir <member scope="com::sun::star::io">XOutputStream::flush</member>. 75*cdf0e10cSrcweir However, where the semantics of <code>flush</code> are rather vague, 76*cdf0e10cSrcweir <code>waitForCompletion</code> has very specific semantics—it just 77*cdf0e10cSrcweir blocks long enough so that any errors encountered during previous calls 78*cdf0e10cSrcweir to <member scope="com::sun::star::io">XOutputStream::writeBytes</member> 79*cdf0e10cSrcweir can reliably be reported. It specificially does not guarantee that any 80*cdf0e10cSrcweir data have savely been stored on a stable physical medium, like a hard 81*cdf0e10cSrcweir disk (and it is completely unspecified whether <code>flush</code> should 82*cdf0e10cSrcweir give this guarantee).</p> 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir @throws com::sun::star::io::IOException 85*cdf0e10cSrcweir if any previous call to <member 86*cdf0e10cSrcweir scope="com::sun::star::io">XOutputStream::writeBytes</member> encountered 87*cdf0e10cSrcweir such an error, but has not yet reported it (in cases where 88*cdf0e10cSrcweir <code>writeBytes</code> operates asynchronously). 89*cdf0e10cSrcweir */ 90*cdf0e10cSrcweir void waitForCompletion() raises (IOException); 91*cdf0e10cSrcweir}; 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir}; }; }; }; 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir#endif 96