xref: /AOO41X/main/udkapi/com/sun/star/connection/XConnection2.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef _COM_SUN_STAR_CONNECTION_XCONNECTION2_IDL_
24#define _COM_SUN_STAR_CONNECTION_XCONNECTION2_IDL_
25
26#include <com/sun/star/io/IOException.idl>
27#include <com/sun/star/io/BufferSizeExceededException.idl>
28#include <com/sun/star/io/NotConnectedException.idl>
29
30#include <com/sun/star/connection/XConnection.idl>
31
32
33module com {  module sun {  module star {  module connection {
34
35
36
37
38/**
39   XConnection2 extends the <code>XConnection</code> interface
40   with <code>available</code> and <code>readSomeBytes</code>
41*/
42published interface XConnection2: com::sun::star::connection::XConnection
43{
44
45    /** Gives the number of bytes available via <code>read</code>
46        without blocking.
47     */
48    long available() raises(com::sun::star::io::IOException);
49
50    /** Blocks if no data is available otherwise reads at
51        max <var>nMaxBytesToRead</var> but at least 1 byte.
52        </p>
53     */
54    long readSomeBytes([out] sequence<byte> aData, [in] long nMaxBytesToRead)
55        raises(com::sun::star::io::IOException);
56};
57
58};};};};
59
60#endif
61