udkapi/com/sun/star/connection/XConnection2.idl

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