udkapi/com/sun/star/bridge/Bridge.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 #ifndef __com_sun_star_bridge_Bridge_idl__
  20 #define __com_sun_star_bridge_Bridge_idl__
  21
  22 #include <com/sun/star/lang/XInitialization.idl>
  23 #include <com/sun/star/lang/XComponent.idl>
  24 #include <com/sun/star/bridge/XBridge.idl>
  25
  26
  27 module com {  module sun {  module star {  module bridge {
  28
  29
  30 /** This meta service allows the bridgefactory service to instantiate an
  31     interprocess bridge using a certain transfer protocol.
  32
  33     <p> Components, that support a certain protocol, must have at least two
  34     service names: </p>
  35
  36     <ul>
  37         <li> com.sun.star.bridge.Bridge </li>
  38         <li> arbitrary-module-path.ProtocolnameBridge </li>
  39     </ul>
  40
  41     <p>The protocol name should be written as common servicenames, first letter is a
  42     capital letter, the rest in small letters postfixed by Bridge (e.g.:
  43     <code>com.sun.star.bridge.UrpBridge</code> would be correct servicename for the
  44     "urp" protocol).  However, the protocol names are compared case insensitive.
  45     If there exist two services supporting the same protocol, it is arbitrary
  46     which one is chosen, so this should be omitted. </p>
  47  */
  48 published service Bridge
  49 {
  50     /** allows to initialize the bridge service with the necessary
  51          arguments. The sequence&lt;any&gt; must have 4 members.
  52
  53          <ol>
  54              <li> String: The unique name of the bridge or an empty string</li>
  55              <li> String: The protocol, that shall be instantiated</li>
  56              <li> XConnection: The bidirectional connection, the bridge should work on</li>
  57              <li> XInstanceProvider:
  58                 The instance provider, that shall be called to access the initial object.</li>
  59          </ol>
  60      */
  61     interface com::sun::star::lang::XInitialization;
  62
  63     /** The main interface of the service
  64      */
  65     interface com::sun::star::bridge::XBridge;
  66
  67     /** This interface allows to terminate the interprocess bridge.
  68      */
  69     interface com::sun::star::lang::XComponent;
  70
  71 };
  72
  73
  74 }; }; }; };
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */