PPI: optimized internal connector packet handling (queuing only if necessary, pass...
[senf.git] / senf / PPI / Connectors.cci
index 986a2a4..957f15c 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2007
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-//     Stefan Bund <g0dil@berlios.de>
 //
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief Connectors inline non-template implementation */
 #include "Module.hh"
 
 #define prefix_ inline
-///////////////////////////////cci.p///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+
+#ifdef SENF_PPI_NOTRACE
+#   define SENF_PPI_THROTTLE_TRACE(label, type)
+#   define SENF_PPI_TRACE(packet, label)
+#else
+#   define SENF_PPI_THROTTLE_TRACE(label, type) throttleTrace(label, type)
+#   define SENF_PPI_TRACE(packet, label) trace(packet, label)
+#endif
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // senf::ppi::connector::Connector
 
 prefix_ senf::ppi::connector::Connector & senf::ppi::connector::Connector::peer()
@@ -61,51 +74,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()
@@ -114,19 +103,19 @@ prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
     return nativeThrottled_ || remoteThrottled_;
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
 {
-    throttleTrace("OUT", "throttle");
+    SENF_PPI_THROTTLE_TRACE("OUT", "throttle");
     if (connected())
         peer().notifyThrottle();
 }
 
 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
 {
-    throttleTrace("OUT", "unthrottle");
+    SENF_PPI_THROTTLE_TRACE("OUT", "unthrottle");
     if (connected()) {
         peer().notifyUnthrottle();
         v_unthrottleEvent();
@@ -143,18 +132,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()
@@ -182,7 +159,7 @@ prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
 
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
@@ -193,19 +170,21 @@ prefix_ void senf::ppi::connector::PassiveConnector::emit()
 {
     // No event callback has been registered (onRequest() call missing)
     SENF_ASSERT(callback_, "senf::ppi::connector::PassiveConnector: missing onRequest()");
-    if (!throttled())
+    if (!throttled()) {
         callback_();
-    else
-        throttleTrace("IN ", "queueing packet");
+    } else {
+        SENF_PPI_THROTTLE_TRACE("IN ", "queueing packet");
+    }
 }
 
-///////////////////////////////////////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // 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()
@@ -224,17 +203,17 @@ 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()
+prefix_ senf::Packet const & senf::ppi::connector::InputConnector::read()
 {
     return operator()();
 }
@@ -242,72 +221,66 @@ 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());
-}
-
-prefix_ senf::ppi::connector::InputConnector::queue_iterator
-senf::ppi::connector::InputConnector::begin()
-    const
-{
-    return queue_.begin();
-}
-
-prefix_ senf::ppi::connector::InputConnector::queue_iterator
-senf::ppi::connector::InputConnector::end()
-    const
-{
-    return queue_.end();
-}
-
-prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
-    const
-{
-    // Cannot peek() head of empty queue
-    SENF_ASSERT( ! queue_.empty(),
-                 "senf::ppi::connector::InputConnector: cannot call peek() on empty queue" );
-    return queue_.back();
+    SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
+    return *peer_;
 }
 
 prefix_ senf::ppi::connector::InputConnector::size_type
 senf::ppi::connector::InputConnector::queueSize()
     const
 {
-    return queue_.size();
+    return queue_.size() + (fastPacket_ ? 1 : 0);
 }
 
 prefix_ bool senf::ppi::connector::InputConnector::empty()
     const
 {
-    return queue_.empty();
+    return fastPacket_ == NULL && queue_.empty();
 }
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // protected members
 
 prefix_ senf::ppi::connector::InputConnector::InputConnector()
+    : fastPacket_(NULL)
 {}
 
-////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 // private members
 
 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
 {
-    queue_.push_front(p);
-    v_enqueueEvent();
+    if (queue_.empty()) {
+        fastPacket_ = &p;
+        try {
+            v_enqueueEvent();
+        } catch (Exception & e) {
+            queue_.push_front(p);
+            throw e;
+        }
+        if (fastPacket_) {
+            queue_.push_front(p);
+            fastPacket_ = NULL;
+        }
+    } else {
+        queue_.push_front(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)
 {
-    trace(p, "OUT");
+    SENF_PPI_TRACE(p, "OUT");
     if (connected())
         peer().enqueue(p);
 }
@@ -317,13 +290,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()
@@ -333,7 +306,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()
@@ -342,13 +316,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()
@@ -365,13 +340,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()
@@ -389,13 +365,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()
@@ -412,7 +389,7 @@ prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveIn
 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
 {}
 
-///////////////////////////////cci.e///////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #undef prefix_
 
 \f