summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/bridge/XBridgeFactory.idl
diff options
context:
space:
mode:
Diffstat (limited to 'udkapi/com/sun/star/bridge/XBridgeFactory.idl')
-rw-r--r--udkapi/com/sun/star/bridge/XBridgeFactory.idl89
1 files changed, 89 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/bridge/XBridgeFactory.idl b/udkapi/com/sun/star/bridge/XBridgeFactory.idl
new file mode 100644
index 000000000..a849f3e7a
--- /dev/null
+++ b/udkapi/com/sun/star/bridge/XBridgeFactory.idl
@@ -0,0 +1,89 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef _COM_SUN_STAR_BRIDGE_XBRIDGEFACTORY_IDL_
+#define _COM_SUN_STAR_BRIDGE_XBRIDGEFACTORY_IDL_
+
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+#include <com/sun/star/connection/XConnection.idl>
+#include <com/sun/star/bridge/XBridge.idl>
+#include <com/sun/star/bridge/BridgeExistsException.idl>
+#include <com/sun/star/bridge/XInstanceProvider.idl>
+
+ module com { module sun { module star { module bridge {
+
+/** factory to create interprocess bridges.
+ */
+published interface XBridgeFactory: com::sun::star::uno::XInterface
+{
+ /** tries to create a UNO interprocess bridge.
+
+ @param sName
+ The name of the bridge. This allows other components to reuse
+ an already created bridge (using getBridge).
+ <p>
+ If empty, an anonymous bridge is created, which cannot be retrieved with
+ getBridge(). No BridgeExistsException can be thrown in this case.
+
+ @param sProtocol
+ The protocol, that will be used on the connection (e.g., urp) plus additional
+ comma separated name=value protocol properties.
+
+ @param aConnection
+ The connection, which is used to transfer the calls. The bridge expects to
+ own the connection, thus it will close the connection, in case it does not
+ need it anymore.
+
+ @param anInstanceProvider
+ gets called, when a request from remote comes in. You can pass a null reference
+ in case you don't want to export any objects.
+
+ @throws BridgeExistsException
+ There is already a bridge registered with this name. Use getBridge instead.
+
+ @throws IllegalArgumentException
+ The protocol is unknown or the connection is null.
+ */
+ XBridge createBridge(
+ [in] string sName,
+ [in] string sProtocol ,
+ [in] com::sun::star::connection::XConnection aConnection ,
+ [in] XInstanceProvider anInstanceProvider )
+ raises ( BridgeExistsException , com::sun::star::lang::IllegalArgumentException );
+
+
+ /** tries to get a bridge by this name.
+ <p> Cannot be retrieved, when the bridge got disposed before.
+
+ @return An existing remote bridge or a null reference.
+ */
+ XBridge getBridge( [in] string sName );
+
+ /** returns the sequence of all named and unnamed UNO interprocess
+ bridges that are instantiated at the time the call is made.
+ */
+ sequence < XBridge > getExistingBridges( );
+};
+
+
+};};};};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */