udkapi/com/sun/star/connection/XAcceptor.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: XAcceptor.idl,v $
  10  * $Revision: 1.13 $
  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_XACCEPTOR_IDL_
  31 #define _COM_SUN_STAR_CONNECTION_XACCEPTOR_IDL_
  32
  33 #include <com/sun/star/connection/ConnectionSetupException.idl>
  34 #include <com/sun/star/connection/AlreadyAcceptingException.idl>
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #include <com/sun/star/connection/XConnection.idl>
  37
  38
  39 module com {  module sun {  module star {  module connection {
  40
  41 /** allows to passively accept connection attempts from other processes.
  42
  43     <p>
  44     This is the counterpart to the XConnector interface.
  45  */
  46 published interface XAcceptor: com::sun::star::uno::XInterface
  47 {
  48     // DocMerge from xml: method com::sun::star::connection::XAcceptor::accept
  49     /** accepts an interprocess connection. Waits until someone connects to the resource.
  50         <p>
  51         After a successful return, the method may be called again to accept
  52         further connections, but the parameter string MUST be left unchanged.
  53
  54
  55        @param sConnectionDescription
  56                 contains the kind of the connection plus a
  57               comma seperated list of attributes,
  58                e.g., <em>socket,host=localhost,port=2345</em> for a tcpip connection.
  59
  60        @return null reference,
  61             stopAccepting was called.
  62             Otherwise a valid XConnection reference.
  63
  64        @throws AlreadyAcceptingException
  65                 Only one acceptor-thread per instance allowed.
  66        @throws ConnectionSetupException
  67             Problems during setting up the acceptor.
  68           (e.g., Security-reasons, socket already busy, etc.)
  69        @throws com::sun::star::lang::IllegalArgumentException
  70                   sConnectionDescription could not be interpreted
  71
  72      */
  73     XConnection accept( [in] string sConnectionDescription )
  74         raises( AlreadyAcceptingException,
  75                 ConnectionSetupException,
  76                 com::sun::star::lang::IllegalArgumentException);
  77
  78
  79     /** pushes acceptor out of the accept-call.
  80      */
  81     void stopAccepting();
  82 };
  83
  84 };};};};
  85
  86 #endif