LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XBridgeFactory Interface Referencepublished

factory to create interprocess bridges. More...

import"XBridgeFactory.idl";

Inheritance diagram for XBridgeFactory:
XInterface XBridgeFactory2 BridgeFactory

Public Member Functions

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 create a UNO interprocess bridge. More...
 
XBridge getBridge ([in] string sName)
 tries to get a bridge by this name. More...
 
sequence< XBridgegetExistingBridges ()
 returns the sequence of all named and unnamed UNO interprocess bridges that are instantiated at the time the call is made. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

factory to create interprocess bridges.

Developers Guide
ProUNO - Opening a Connection

Member Function Documentation

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 create a UNO interprocess bridge.

Parameters
sNameThe name of the bridge. This allows other components to reuse an already created bridge (using getBridge).

If empty, an anonymous bridge is created, which cannot be retrieved with getBridge(). No BridgeExistsException can be thrown in this case.

Parameters
sProtocolThe protocol, that will be used on the connection (e.g., urp) plus additional comma separated name=value protocol properties.
aConnectionThe 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.
anInstanceProvidergets called, when a request from remote comes in. You can pass a null reference in case you don't want to export any objects.
Exceptions
BridgeExistsExceptionThere is already a bridge registered with this name. Use getBridge instead.
IllegalArgumentExceptionThe protocol is unknown or the connection is null.
XBridge getBridge ( [in] string  sName)

tries to get a bridge by this name.

Cannot be retrieved, when the bridge got disposed before.

Returns
An existing remote bridge or a null reference.
sequence< XBridge > getExistingBridges ( )

returns the sequence of all named and unnamed UNO interprocess bridges that are instantiated at the time the call is made.


The documentation for this interface was generated from the following file: