udkapi/com/sun/star/bridge/XBridgeFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module bridge {
  21
  22 /** factory to create interprocess bridges.
  23  */
  24 published interface XBridgeFactory: com::sun::star::uno::XInterface
  25 {
  26     /** tries to create a UNO interprocess bridge.
  27
  28         @param sName
  29             The name of the bridge. This allows other components to reuse
  30              an already created bridge (using getBridge).
  31              <p>
  32              If empty, an anonymous bridge is created, which cannot be retrieved with
  33              getBridge(). No BridgeExistsException can be thrown in this case.
  34
  35         @param sProtocol
  36             The protocol, that will be used on the connection (e.g., urp) plus additional
  37             comma separated name=value protocol properties.
  38
  39         @param aConnection
  40             The connection, which is used to transfer the calls. The bridge expects to
  41             own the connection, thus it will close the connection, in case it does not
  42             need it anymore.
  43
  44         @param anInstanceProvider
  45             gets called, when a request from remote comes in. You can pass a null reference
  46             in case you don't want to export any objects.
  47
  48         @throws BridgeExistsException
  49             There is already a bridge registered with this name.  Use getBridge instead.
  50
  51         @throws IllegalArgumentException
  52             The protocol is unknown or the connection is null.
  53      */
  54     XBridge createBridge(
  55         [in] string sName,
  56         [in] string sProtocol ,
  57         [in] com::sun::star::connection::XConnection aConnection ,
  58         [in] XInstanceProvider anInstanceProvider )
  59         raises ( BridgeExistsException , com::sun::star::lang::IllegalArgumentException );
  60
  61
  62     /** tries to get a bridge by this name.
  63         <p> Cannot be retrieved, when the bridge got disposed before.
  64
  65         @return An existing remote bridge or a null reference.
  66      */
  67     XBridge getBridge( [in] string  sName );
  68
  69     /** returns the sequence of all named and unnamed UNO interprocess
  70         bridges that are instantiated at the time the call is made.
  71      */
  72     sequence < XBridge > getExistingBridges( );
  73 };
  74
  75
  76 };};};};
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */