Back to index

salome-kernel  6.5.0
Classes | Public Types | Public Member Functions
Engines::ConnectionManager Interface Reference

Interface of the ConnectionManager. More...

import "DSC_Engines.idl";

List of all members.


exception  BadId
 The Id given to the disconnect method is bad. More...

Public Types

typedef short connectionId
 A connection Id. It's unique.

Public Member Functions

connectionId connect (in Engines::DSC uses_component, in string uses_port_name, in Engines::DSC provides_component, in string provides_port_name) raises (Engines::DSC::PortNotDefined, Engines::DSC::BadPortType, Engines::DSC::NilPort)
 Connect a uses port with a provides port.
void disconnect (in connectionId id, in Engines::DSC::Message message) raises (Engines::ConnectionManager::BadId, Engines::DSC::PortNotDefined, Engines::DSC::PortNotConnected, Engines::DSC::BadPortReference)
 Release a connection that has been previously created by the ConnectionManager.
oneway void ShutdownWithExit ()
 Shutdown the ConnectionManager process.
long getPID ()
 Return the PID of the connection manager.

Detailed Description

Interface of the ConnectionManager.

It is a helper object for connection operations. The ConnectionManager is used like other services of SALOME (e.g ContainerManager).

Definition at line 287 of file DSC_Engines.idl.

Class Documentation

exception Engines::ConnectionManager::BadId

The Id given to the disconnect method is bad.

Definition at line 290 of file DSC_Engines.idl.

Member Typedef Documentation

A connection Id. It's unique.

Definition at line 293 of file DSC_Engines.idl.

Member Function Documentation

connectionId Engines::ConnectionManager::connect ( in Engines::DSC  uses_component,
in string  uses_port_name,
in Engines::DSC  provides_component,
in string  provides_port_name 
) raises (Engines::DSC::PortNotDefined, Engines::DSC::BadPortType, Engines::DSC::NilPort)

Connect a uses port with a provides port.

uses_componentThe component that have the uses port.
uses_port_nameuses port's name.
provides_componentThe component that have the provides port.
provides_port_nameprovides port's name.
the id of the connection that the ConnectionManager will use to release this connection when the framework (or a user script, ...) will call ConnectionManager::disconnect.

Release a connection that has been previously created by the ConnectionManager.

idThe id of the connection previously gived by the connect operation of the ConnectionManager.
messagestate associated with the disconnection.

Return the PID of the connection manager.

Shutdown the ConnectionManager process.

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