summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--udkapi/com/sun/star/bridge/BridgeExistsException.idl8
-rw-r--r--udkapi/com/sun/star/bridge/IiopBridge.idl6
-rw-r--r--udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl10
-rw-r--r--udkapi/com/sun/star/bridge/ModelDependent.idl10
-rw-r--r--udkapi/com/sun/star/bridge/ProtocolProperty.idl6
-rw-r--r--udkapi/com/sun/star/bridge/UnoUrlResolver.idl13
-rw-r--r--udkapi/com/sun/star/bridge/XBridge.idl12
-rw-r--r--udkapi/com/sun/star/bridge/XBridgeFactory.idl37
-rw-r--r--udkapi/com/sun/star/bridge/XInstanceProvider.idl26
9 files changed, 82 insertions, 46 deletions
diff --git a/udkapi/com/sun/star/bridge/BridgeExistsException.idl b/udkapi/com/sun/star/bridge/BridgeExistsException.idl
index 21ded1de3f07..7133b5609f0c 100644
--- a/udkapi/com/sun/star/bridge/BridgeExistsException.idl
+++ b/udkapi/com/sun/star/bridge/BridgeExistsException.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: BridgeExistsException.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -65,7 +65,9 @@
module com { module sun { module star { module bridge {
-// DocMerge: empty anyway
+/** Indicates, that it was tried to create a remote bridge with a name,
+ which already existed.
+ */
exception BridgeExistsException: com::sun::star::uno::Exception
{
};
diff --git a/udkapi/com/sun/star/bridge/IiopBridge.idl b/udkapi/com/sun/star/bridge/IiopBridge.idl
index 0e4646cc4e48..643fb53b14a1 100644
--- a/udkapi/com/sun/star/bridge/IiopBridge.idl
+++ b/udkapi/com/sun/star/bridge/IiopBridge.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: IiopBridge.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -82,7 +82,7 @@
<p> This bridge works with the iiop protocol. </p>
- @see com.sun.star.bridge.Bridg
+ @see com.sun.star.bridge.Bridge
*/
service IiopBridge
{
diff --git a/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl b/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl
index eda00365de06..c4f53d7f6251 100644
--- a/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl
+++ b/udkapi/com/sun/star/bridge/InvalidProtocolChangeException.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: InvalidProtocolChangeException.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -66,6 +66,12 @@
module com { module sun { module star { module bridge {
+
+/** Indicates, that a requested property change could not be executed by the
+ remote counterpart.
+
+ @see XProtocolProperties
+*/
exception InvalidProtocolChangeException : com::sun::star::uno::Exception
{
/** The first invalid property.
diff --git a/udkapi/com/sun/star/bridge/ModelDependent.idl b/udkapi/com/sun/star/bridge/ModelDependent.idl
index 53e5634cdd04..45352d883d13 100644
--- a/udkapi/com/sun/star/bridge/ModelDependent.idl
+++ b/udkapi/com/sun/star/bridge/ModelDependent.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ModelDependent.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -73,9 +73,8 @@
<p>They are only used for creating bridges to other component models.
- @see com::sun::star::bridge::XBridgeSupplier
+ @see com::sun::star::bridge::XBridgeSupplier2
- @deprecated
*/
constants ModelDependent
{
@@ -112,6 +111,9 @@ constants ModelDependent
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.5 2000/12/11 16:09:40 mi
+ documentation syntax fixed and some minor semantic documentation fixes
+
Revision 1.4 2000/11/08 12:28:26 mi
moved from api
diff --git a/udkapi/com/sun/star/bridge/ProtocolProperty.idl b/udkapi/com/sun/star/bridge/ProtocolProperty.idl
index 306987c546df..a4ae88b0dd56 100644
--- a/udkapi/com/sun/star/bridge/ProtocolProperty.idl
+++ b/udkapi/com/sun/star/bridge/ProtocolProperty.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ProtocolProperty.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: mi $ $Date: 2000-12-11 16:09:40 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -63,7 +63,7 @@
module com { module sun { module star { module bridge {
-/** @missing
+/** string/value pair
*/
struct ProtocolProperty
{
diff --git a/udkapi/com/sun/star/bridge/UnoUrlResolver.idl b/udkapi/com/sun/star/bridge/UnoUrlResolver.idl
index fc03bdca064d..390a31ac010d 100644
--- a/udkapi/com/sun/star/bridge/UnoUrlResolver.idl
+++ b/udkapi/com/sun/star/bridge/UnoUrlResolver.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: UnoUrlResolver.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: mi $ $Date: 2000-11-08 12:28:26 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -69,15 +69,13 @@
//=============================================================================
-// DocMerge from xml: service com::sun::star::bridge::UnoUrlResolver
-/** provides the ability to access outer processes,
- resolving them by their name.
+/** provides the ability to access remote processes,
+ resolving them by an UNO url.
<br>
*/
service UnoUrlResolver
{
- // DocMerge from xml: service com::sun::star::bridge::UnoUrlResolver: interface com::sun::star::bridge::XUnoUrlResolver
/** resolve objects via this interface.
*/
interface com::sun::star::bridge::XUnoUrlResolver;
@@ -90,6 +88,9 @@ service UnoUrlResolver
/*=============================================================================
$Log: not supported by cvs2svn $
+ Revision 1.4 2000/11/08 12:28:26 mi
+ moved from api
+
Revision 1.1.1.1 2000/09/18 23:34:57 hjs
initial import
diff --git a/udkapi/com/sun/star/bridge/XBridge.idl b/udkapi/com/sun/star/bridge/XBridge.idl
index 36b6d5606af2..013081e0f022 100644
--- a/udkapi/com/sun/star/bridge/XBridge.idl
+++ b/udkapi/com/sun/star/bridge/XBridge.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XBridge.idl,v $
*
- * $Revision: 1.6 $
+ * $Revision: 1.7 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 15:10:33 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -65,7 +65,7 @@
module com { module sun { module star { module bridge {
-/** @missing
+/**
*/
interface XBridge: com::sun::star::uno::XInterface
{
@@ -74,6 +74,12 @@ interface XBridge: com::sun::star::uno::XInterface
<p>In general, this method is called once to get the initial object from the
remote, but it is allowed to call the method multiple times. </p>
+
+ @param sInstanceName The name of the object, that shall be retrieved from the
+ remote process. The call is delegated to
+ com.sun.star.bridge.XInstanceProvider.getInstance() in the
+ remote process
+ @see com.sun.star.bridge.XInstanceProvider
*/
XInterface getInstance( [in] string sInstanceName );
diff --git a/udkapi/com/sun/star/bridge/XBridgeFactory.idl b/udkapi/com/sun/star/bridge/XBridgeFactory.idl
index 7c1f6eeb01c4..eed21d45200c 100644
--- a/udkapi/com/sun/star/bridge/XBridgeFactory.idl
+++ b/udkapi/com/sun/star/bridge/XBridgeFactory.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XBridgeFactory.idl,v $
*
- * $Revision: 1.7 $
+ * $Revision: 1.8 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 15:10:33 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -70,32 +70,37 @@
module com { module sun { module star { module bridge {
-/** @missing
+/** factory to create interprocess bridges
*/
interface XBridgeFactory: com::sun::star::uno::XInterface
{
- // DocMerge from idl: method com::sun::star::bridge::XBridgeFactory::createBridge
- /** @incomplete
+ /** tries to create a UNO interprocess bridge.
@param sName
- The name of the bridge. The format should be protocol:connection-description
- (e.g. iiop:socket:localhost:2000). This allows other components to reuse
+ 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, the bridge should work on.
+ The protocol, that will be used on the connection (e.g. urp) plus additional
+ comma separated name=value protocol properties.
@param aConnection
- The connection on which the calls will be transfered.
+ 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.
+ 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.
+ The protocol is unknown or the connection is null.
*/
XBridge createBridge(
[in] string sName,
@@ -105,14 +110,14 @@ interface XBridgeFactory: com::sun::star::uno::XInterface
raises ( BridgeExistsException , com::sun::star::lang::IllegalArgumentException );
- // DocMerge from xml: method com::sun::star::bridge::XBridgeFactory::getBridge
- /** tries to get a bridge.
+ /** 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 );
- // DocMerge from idl: method com::sun::star::bridge::XBridgeFactory::getExistingBridges
- /** @returns
- Sequence of all existing bridges.
+ /** returns the sequence of all existing (including unnamed)bridges.
*/
sequence < XBridge > getExistingBridges( );
};
diff --git a/udkapi/com/sun/star/bridge/XInstanceProvider.idl b/udkapi/com/sun/star/bridge/XInstanceProvider.idl
index 639286dfd7c2..453670bcf151 100644
--- a/udkapi/com/sun/star/bridge/XInstanceProvider.idl
+++ b/udkapi/com/sun/star/bridge/XInstanceProvider.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XInstanceProvider.idl,v $
*
- * $Revision: 1.6 $
+ * $Revision: 1.7 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 15:10:33 $
+ * last change: $Author: jbu $ $Date: 2001-10-12 16:01:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -66,14 +66,28 @@
module com { module sun { module star { module bridge {
-/** @missing
+/** Allows to export UNO objects to other processes.
+
+ @see XBridge
*/
interface XInstanceProvider: com::sun::star::uno::XInterface
{
- // DocMerge from xml: method com::sun::star::bridge::XInstanceProvider::getInstance
- /** @returns
- the object associated with the name.
+ /** gets called, when an initial object is requested from a remote process.
+ You may either create a new instance or return an existing object.
+
+ @param sInstanceName
+ The name of the requested object.
+
+ @returns
+ the object associated with the name. The return value maybe null in case
+ there is no object to offer for this string. In this case, XBridge.getInstance()
+ will also return a null reference
+
+ @throws NoSuchElementException
+ You may throw this exception to indicate, that there is no object for this
+ name. Due to a specification bug, this exception will appear as a RuntimeException
+ at the XBridge.getInstance() method.
*/
com::sun::star::uno::XInterface getInstance( [in] string sInstanceName )
raises ( com::sun::star::container::NoSuchElementException );
generated by cgit (git 2.34.1) at 2024-08-03 01:33:53 +0000