RTT::ConnectionInterface Class Reference
An Object which manages and maintains a communication connection between Ports. More...
#include <rtt/ConnectionInterface.hpp>
Public Types | |
|
typedef boost::intrusive_ptr < ConnectionInterface > | shared_ptr |
Public Member Functions | |
| virtual DataSourceBase::shared_ptr | getDataSource () const =0 |
| Get a Data source representing the current value of this connection. | |
| virtual BufferBase::shared_ptr | getBuffer () const =0 |
| Returns the buffer and its associated status of this connection, if this connection is buffered. | |
| virtual bool | connect () |
| Connect all readers and writers. | |
| virtual bool | connected () const |
| Get Connection status. | |
| virtual bool | disconnect () |
| Disconnect all readers and writers. | |
| virtual bool | addPort (PortInterface *p) |
| Add a Port to the connection. | |
| virtual bool | removePort (PortInterface *p) |
| Remove a Port from the connection. | |
| virtual const TypeInfo * | getTypeInfo () const =0 |
| Get the data type of this port. | |
| virtual int | serverProtocol () const |
| Returns the protocol over which this connection can be accessed. | |
| void | signal () |
| Signals that a new data sample has been written on this connection. | |
| std::string | getConnectionName () |
| Return the name of this connection if available. | |
| void | setConnectionName (std::string newConnectionName) |
| Set a new name for this connection. | |
| PList | getPortList () |
| Accessibility method to return all the port list associated with this connection. | |
Protected Types | |
|
typedef std::vector < PortInterface * > | PList |
Protected Member Functions | |
| friend | void::intrusive_ptr_add_ref (ConnectionInterface *p) |
| friend | void::intrusive_ptr_release (ConnectionInterface *p) |
Protected Attributes | |
| OS::AtomicInt | refcount |
| PList | ports |
| bool | mconnected |
| std::string | connectionName |
Detailed Description
An Object which manages and maintains a communication connection between Ports.
- Creating a Connection
- When connections are created, they are initially not connected, and hence, no port 'knows' of this connection object. In order to establish the connection between ports, call connect() explicitly on the newly created connection object. As long as that does not happen, it only keeps track of readers and writers, but does not connect them.
- Connection Management
- A connection object has two states: connected() or !connected(). In both states, any number of readers and writers may subscribe to this connection. If the state is !connected(), all subscribers will only be connected when the connect() method is called. If the state is connected(), every newly added subscriber is directly connected to the connection.
It is possible that a PortInterface participates in multiple 'dormant' (ie !connected()) connections while only one connection is connected() at the same time. If one tries to connect() a connection in which one ore more subscribers are already participating in the connection, the connect() method fails.
- Reference counting
- ConnectionInterface objects are reference counted. That means that if no object holds a pointer to this object, it will be destroyed. This can only happen if all ports disconnect from this connection.
- Thread Safety
- Although this interface may be implemented thread-safe, the DataConnection and BufferConnection classes have not been made thread-safe. This means that multiple threads calling connect()/disconnect() on the same or related connections may crash the system. Since connection setup is seen as an application configuration step, executed by a single configurator, Locking was not added. If this policy does not match your application setup, write your own ConnectionInterface subclass, or submit a bug report.
- See also:
- PortInterface
Definition at line 101 of file ConnectionInterface.hpp.
Member Function Documentation
| virtual bool RTT::ConnectionInterface::addPort | ( | PortInterface * | p | ) | [virtual] |
Add a Port to the connection.
If this->connected(), also immediately connect p to this connection.
- Parameters:
-
p A port which wants to read or write data from this connection.
- Returns:
- true if p has the correct type and could be added
| virtual bool RTT::ConnectionInterface::connect | ( | ) | [virtual] |
Connect all readers and writers.
If a reader or writer is already connected to another connection, this method fails.
- Returns:
- false if at least one reader or writer was already participating in a connection or if connected()
| virtual BufferBase::shared_ptr RTT::ConnectionInterface::getBuffer | ( | ) | const [pure virtual] |
Returns the buffer and its associated status of this connection, if this connection is buffered.
Otherwise, this returns the null pointer.
Implemented in RTT::BufferConnection< T >, and RTT::DataConnection< T >.
| std::string RTT::ConnectionInterface::getConnectionName | ( | ) |
Return the name of this connection if available.
- Returns:
- the name of the connection
| virtual DataSourceBase::shared_ptr RTT::ConnectionInterface::getDataSource | ( | ) | const [pure virtual] |
Get a Data source representing the current value of this connection.
This function always returns a meaningful data source.
Implemented in RTT::BufferConnection< T >, and RTT::DataConnection< T >.
| PList RTT::ConnectionInterface::getPortList | ( | ) |
Accessibility method to return all the port list associated with this connection.
- Returns:
- the port list for this connection
| virtual bool RTT::ConnectionInterface::removePort | ( | PortInterface * | p | ) | [virtual] |
Remove a Port from the connection.
If this->connected(), also immediately disconnect p from this connection.
- Parameters:
-
p A port which no longer wants to read or write data from this connection.
- Returns:
- true if p was present.
| void RTT::ConnectionInterface::setConnectionName | ( | std::string | newConnectionName | ) |
Set a new name for this connection.
- Parameters:
-
newConnectionName The new name to be set for this connection.
| void RTT::ConnectionInterface::signal | ( | ) |
Signals that a new data sample has been written on this connection.
This is to be called by source ports when new data is written on the connection
The documentation for this class was generated from the following file:
