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