Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / PPI / Connectors.cci
index 16948c0..af21cf9 100644 (file)
@@ -29,7 +29,7 @@
 #include "Module.hh"
 
 #define prefix_ inline
-///////////////////////////////cci.p///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef SENF_PPI_NOTRACE
 #   define SENF_PPI_THROTTLE_TRACE(label, type)
@@ -39,7 +39,7 @@
 #   define SENF_PPI_TRACE(packet, label) trace(packet, label)
 #endif
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::Connector
 
 prefix_ senf::ppi::connector::Connector & senf::ppi::connector::Connector::peer()
@@ -69,51 +69,27 @@ prefix_ senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connec
     return traceState_;
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::Connector::Connector()
     : peer_(), module_()
 {}
 
-prefix_ senf::ppi::connector::Connector::~Connector()
-{
-    if (connected()) {
-        Connector & peer (*peer_);
-        peer_->peer_ = 0;
-        if (! peer.initializationScheduled())
-            peer.enqueueInitializable();
-        peer.v_disconnected();
-    }
-}
-
 prefix_ bool senf::ppi::connector::Connector::connected()
     const
 {
     return peer_;
 }
 
-prefix_ void senf::ppi::connector::Connector::unregisterConnector()
-{
-    if (module_)
-        module_->unregisterConnector(*this);
-}
-
-////////////////////////////////////////
-// private members
-
-prefix_ void senf::ppi::connector::Connector::setModule(module::Module & module)
-{
-    module_ = &module;
-}
-
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::PassiveConnector
 
 prefix_ senf::ppi::connector::ActiveConnector & senf::ppi::connector::PassiveConnector::peer()
     const
 {
-    return dynamic_cast<ActiveConnector&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
@@ -122,7 +98,7 @@ prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
     return nativeThrottled_ || remoteThrottled_;
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
@@ -151,18 +127,6 @@ prefix_ void senf::ppi::connector::PassiveConnector::notifyThrottle()
         remoteThrottled_ = true;
 }
 
-prefix_ void senf::ppi::connector::PassiveConnector::registerRoute(ForwardingRoute & route)
-{
-    routes_.push_back(&route);
-}
-
-prefix_ void senf::ppi::connector::PassiveConnector::unregisterRoute(ForwardingRoute & route)
-{
-    Routes::iterator i (std::find(routes_.begin(), routes_.end(), &route));
-    if (i != routes_.end())
-        routes_.erase(i);
-}
-
 // public members
 
 prefix_ bool senf::ppi::connector::PassiveConnector::nativeThrottled()
@@ -190,7 +154,7 @@ prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
 
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
@@ -208,13 +172,14 @@ prefix_ void senf::ppi::connector::PassiveConnector::emit()
     }
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::ActiveConnector
 
 prefix_ senf::ppi::connector::PassiveConnector & senf::ppi::connector::ActiveConnector::peer()
     const
 {
-    return dynamic_cast<PassiveConnector&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ void senf::ppi::connector::ActiveConnector::onThrottle()
@@ -233,14 +198,14 @@ prefix_ bool senf::ppi::connector::ActiveConnector::throttled()
     return ! connected() || peer().throttled();
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
     : throttleCallback_(), unthrottleCallback_(), notifyRoutes_(), throttled_(false)
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::InputConnector
 
 prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
@@ -251,7 +216,8 @@ prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
     const
 {
-    return dynamic_cast<OutputConnector &>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ senf::ppi::connector::InputConnector::queue_iterator
@@ -290,13 +256,13 @@ prefix_ bool senf::ppi::connector::InputConnector::empty()
     return queue_.empty();
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::InputConnector::InputConnector()
 {}
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
@@ -305,13 +271,14 @@ prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
     v_enqueueEvent();
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::OutputConnector
 
 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
     const
 {
-    return dynamic_cast<InputConnector&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet const & p)
@@ -326,13 +293,13 @@ prefix_ void senf::ppi::connector::OutputConnector::write(Packet const & p)
     operator()(p);
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::GenericPassiveInput
 
 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
@@ -342,7 +309,8 @@ prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
     const
 {
-    return dynamic_cast<GenericActiveOutput&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
@@ -351,13 +319,14 @@ prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
     return ! empty();
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::GenericPassiveOutput
 
 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
     const
 {
-    return dynamic_cast<GenericActiveInput&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
@@ -374,13 +343,14 @@ prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveIn
 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::GenericActiveInput
 
 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
     const
 {
-    return dynamic_cast<GenericPassiveOutput&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
@@ -398,13 +368,14 @@ prefix_ void senf::ppi::connector::GenericActiveInput::request()
 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
 {}
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::GenericActiveOutput
 
 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
     const
 {
-    return dynamic_cast<GenericPassiveInput&>(Connector::peer());
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
@@ -421,7 +392,7 @@ prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveIn
 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
 {}
 
-///////////////////////////////cci.e///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 
 \f