neo::cca::ConnectionID Class Reference

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

#include <ConnectionID.hh>

Public Member Functions
virtual	~ConnectionID ()
	required destructor More...
virtual ComponentID_shared	getProvider ()=0 throw (Exception )
	Recall that ComponentID is also a shared_ptr type. More...
virtual ComponentID_shared	getUser ()=0 throw (Exception )
	Recall that ComponentID_shared is also a shared_ptr type. More...
virtual ::std::string	getProviderPortName ()=0 throw (Exception )
virtual ::std::string	getUserPortName ()=0 throw (Exception )

Detailed Description

This interface describes a CCA connection between components.

Component writers should never defining anything as ConnectionID *connID; Rather, they should declare: ConnectionID_shared connID; and make calls on it as connID->getWhatever().

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.

Memory lifecycle: All connectionid are created by the framework and then shared liberally.

Constructor & Destructor Documentation

~ConnectionID()

virtual neo::cca::ConnectionID::~ConnectionID ( )

inlinevirtual

required destructor

{}

Member Function Documentation

getProvider()

virtual ComponentID_shared neo::cca::ConnectionID::getProvider ( ) throw ( Exception )

pure virtual

Recall that ComponentID is also a shared_ptr type.

getUser()

virtual ComponentID_shared neo::cca::ConnectionID::getUser ( ) throw ( Exception )

pure virtual

Recall that ComponentID_shared is also a shared_ptr type.

Exceptions

a	Exception if the underlying connection is no longer valid.

getProviderPortName()

virtual ::std::string neo::cca::ConnectionID::getProviderPortName ( ) throw ( Exception )

pure virtual

getUserPortName()

virtual ::std::string neo::cca::ConnectionID::getUserPortName ( ) throw ( Exception )

pure virtual

---

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

• ConnectionID.hh