xref: /AOO41X/main/udkapi/com/sun/star/connection/XConnection2.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef _COM_SUN_STAR_CONNECTION_XCONNECTION2_IDL_
28#define _COM_SUN_STAR_CONNECTION_XCONNECTION2_IDL_
29
30#include <com/sun/star/io/IOException.idl>
31#include <com/sun/star/io/BufferSizeExceededException.idl>
32#include <com/sun/star/io/NotConnectedException.idl>
33
34#include <com/sun/star/connection/XConnection.idl>
35
36
37module com {  module sun {  module star {  module connection {
38
39
40
41
42/**
43   XConnection2 extends the <code>XConnection</code> interface
44   with <code>available</code> and <code>readSomeBytes</code>
45*/
46published interface XConnection2: com::sun::star::connection::XConnection
47{
48
49	/** Gives the number of bytes available via <code>read</code>
50		without blocking.
51	 */
52	long available() raises(com::sun::star::io::IOException);
53
54	/** Blocks if no data is available otherwise reads at
55		max <var>nMaxBytesToRead</var> but at least 1 byte.
56		</p>
57	 */
58	long readSomeBytes([out] sequence<byte> aData, [in] long nMaxBytesToRead)
59		raises(com::sun::star::io::IOException);
60};
61
62};};};};
63
64#endif
65