gov.cca.ConnectionID Interface Reference

This interface describes a CCA connection between components. More...

List of all members.

Public Member Functions

ComponentID getProvider () throws CCAException
 Get the providing component (callee) ID.
ComponentID getUser () throws CCAException
 Get the using component (caller) ID.
string getProviderPortName () throws CCAException
 Get the port name in the providing component of this connection.
string getUserPortName () throws CCAException
 Get the port name in the using component of this connection.


Detailed Description

This interface describes a CCA connection between components.

A connection is made at the users direction when one component provides a Port that another component advertises for and uses. The components are referred to by their opaque ComponentID references and the Ports are referred to by their string instance names.


Member Function Documentation

ComponentID gov.cca.ConnectionID.getProvider (  )  throws CCAException

Get the providing component (callee) ID.

Returns:
ComponentID of the component that has provided the Port for this connection.
Exceptions:
CCAException if the underlying connection is no longer valid.

string gov.cca.ConnectionID.getProviderPortName (  )  throws CCAException

Get the port name in the providing component of this connection.

Returns:
the instance name of the provided Port.
Exceptions:
CCAException if the underlying connection is no longer valid.

ComponentID gov.cca.ConnectionID.getUser (  )  throws CCAException

Get the using component (caller) ID.

Returns:
ComponentID of the component that is using the provided Port.
Exceptions:
CCAException if the underlying connection is no longer valid.

string gov.cca.ConnectionID.getUserPortName (  )  throws CCAException

Get the port name in the using component of this connection.

Return the instance name of the Port registered for use in this connection.

Exceptions:
CCAException if the underlying connection is no longer valid.


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

Generated on Thu Mar 17 09:40:08 2011 for cca-spec-babel by  doxygen 1.5.9