senf/PPI/Connectors.cci

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief Connectors inline non-template implementation */
  25
  26 // Custom includes
  27 #include <senf/Utils/TypeInfo.hh>
  28 #include <senf/Utils/senfassert.hh>
  29
  30 #define prefix_ inline
  31 ///////////////////////////////cci.p///////////////////////////////////////
  32
  33 ///////////////////////////////////////////////////////////////////////////
  34 // senf::ppi::connector::Connector
  35
  36 prefix_ senf::ppi::connector::Connector & senf::ppi::connector::Connector::peer()
  37     const
  38 {
  39     // The connector is not connected
  40     SENF_ASSERT(peer_ && "senf::ppi::connect() call missing");
  41     return *peer_;
  42 }
  43
  44 prefix_ senf::ppi::module::Module & senf::ppi::connector::Connector::module()
  45     const
  46 {
  47     // The connector is not registered in the module -> probably a route() or noroute() statement is
  48     // missing.
  49     SENF_ASSERT(module_ && "Connector not registered: Missing route() or noroute()");
  50     return *module_;
  51 }
  52
  53 prefix_ void senf::ppi::connector::Connector::tracing(TraceState state)
  54 {
  55     traceState_ = state;
  56 }
  57
  58 prefix_ senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::tracing()
  59 {
  60     return traceState_;
  61 }
  62
  63 ////////////////////////////////////////
  64 // protected members
  65
  66 prefix_ senf::ppi::connector::Connector::Connector()
  67     : peer_(), module_()
  68 {}
  69
  70 prefix_ senf::ppi::connector::Connector::~Connector()
  71 {
  72     if (connected()) {
  73         Connector & peer (*peer_);
  74         peer_->peer_ = 0;
  75         peer.v_init();
  76     }
  77 }
  78
  79 prefix_ bool senf::ppi::connector::Connector::connected()
  80     const
  81 {
  82     return peer_;
  83 }
  84
  85 ////////////////////////////////////////
  86 // private members
  87
  88 prefix_ void senf::ppi::connector::Connector::setModule(module::Module & module)
  89 {
  90     module_ = &module;
  91 }
  92
  93 ///////////////////////////////////////////////////////////////////////////
  94 // senf::ppi::connector::PassiveConnector
  95
  96 prefix_ senf::ppi::connector::ActiveConnector & senf::ppi::connector::PassiveConnector::peer()
  97     const
  98 {
  99     return dynamic_cast<ActiveConnector&>(Connector::peer());
 100 }
 101
 102 prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
 103     const
 104 {
 105     return nativeThrottled_ || remoteThrottled_;
 106 }
 107
 108 ////////////////////////////////////////
 109 // private members
 110
 111 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
 112 {
 113     throttleTrace("OUT", "throttle");
 114     if (connected())
 115         peer().notifyThrottle();
 116 }
 117
 118 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
 119 {
 120     throttleTrace("OUT", "unthrottle");
 121     if (connected()) {
 122         peer().notifyUnthrottle();
 123         v_unthrottleEvent();
 124     }
 125 }
 126
 127 prefix_ void senf::ppi::connector::PassiveConnector::notifyThrottle()
 128 {
 129     if (!throttled()) {
 130         remoteThrottled_ = true;
 131         emitThrottle();
 132     }
 133     else
 134         remoteThrottled_ = true;
 135 }
 136
 137 prefix_ void senf::ppi::connector::PassiveConnector::registerRoute(ForwardingRoute & route)
 138 {
 139     routes_.push_back(&route);
 140 }
 141
 142 // public members
 143
 144 prefix_ bool senf::ppi::connector::PassiveConnector::nativeThrottled()
 145     const
 146 {
 147     return nativeThrottled_;
 148 }
 149
 150 prefix_ void senf::ppi::connector::PassiveConnector::throttle()
 151 {
 152     if (!throttled()) {
 153         nativeThrottled_ = true;
 154         emitThrottle();
 155     } else
 156         nativeThrottled_ = true;
 157 }
 158
 159 prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
 160 {
 161     if (throttled() && ! remoteThrottled_) {
 162         nativeThrottled_ = false;
 163         emitUnthrottle();
 164     } else
 165         nativeThrottled_ = false;
 166
 167 }
 168
 169 ////////////////////////////////////////
 170 // protected members
 171
 172 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
 173     : callback_(), remoteThrottled_(), nativeThrottled_()
 174 {}
 175
 176 prefix_ void senf::ppi::connector::PassiveConnector::emit()
 177 {
 178     // No event callback has been registered (onRequest() call missing)
 179     SENF_ASSERT(callback_ && "senf::ppi::connector::PassiveConnector: missing onRequest()");
 180     if (!throttled())
 181         callback_();
 182     else
 183         throttleTrace("IN ", "queueing packet");
 184 }
 185
 186 ///////////////////////////////////////////////////////////////////////////
 187 // senf::ppi::connector::ActiveConnector
 188
 189 prefix_ senf::ppi::connector::PassiveConnector & senf::ppi::connector::ActiveConnector::peer()
 190     const
 191 {
 192     return dynamic_cast<PassiveConnector&>(Connector::peer());
 193 }
 194
 195 prefix_ void senf::ppi::connector::ActiveConnector::onThrottle()
 196 {
 197     throttleCallback_ = Callback();
 198 }
 199
 200 prefix_ void senf::ppi::connector::ActiveConnector::onUnthrottle()
 201 {
 202     unthrottleCallback_ = Callback();
 203 }
 204
 205 prefix_ bool senf::ppi::connector::ActiveConnector::throttled()
 206     const
 207 {
 208     return ! connected() || peer().throttled();
 209 }
 210
 211 ////////////////////////////////////////
 212 // protected members
 213
 214 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
 215     : throttleCallback_(), unthrottleCallback_(), notifyRoutes_(), throttled_(false)
 216 {}
 217
 218 ///////////////////////////////////////////////////////////////////////////
 219 // senf::ppi::connector::InputConnector
 220
 221 prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
 222 {
 223     return operator()();
 224 }
 225
 226 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
 227     const
 228 {
 229     return dynamic_cast<OutputConnector &>(Connector::peer());
 230 }
 231
 232 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 233 senf::ppi::connector::InputConnector::begin()
 234     const
 235 {
 236     return queue_.begin();
 237 }
 238
 239 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 240 senf::ppi::connector::InputConnector::end()
 241     const
 242 {
 243     return queue_.end();
 244 }
 245
 246 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
 247     const
 248 {
 249     // Cannot peek() head of empty queue
 250     SENF_ASSERT( ! queue_.empty() &&
 251                  "senf::ppi::connector::InputConnector: cannot call peek() on empty queue" );
 252     return queue_.back();
 253 }
 254
 255 prefix_ senf::ppi::connector::InputConnector::size_type
 256 senf::ppi::connector::InputConnector::queueSize()
 257     const
 258 {
 259     return queue_.size();
 260 }
 261
 262 prefix_ bool senf::ppi::connector::InputConnector::empty()
 263     const
 264 {
 265     return queue_.empty();
 266 }
 267
 268 ////////////////////////////////////////
 269 // protected members
 270
 271 prefix_ senf::ppi::connector::InputConnector::InputConnector()
 272 {}
 273
 274 ////////////////////////////////////////
 275 // private members
 276
 277 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
 278 {
 279     queue_.push_front(p);
 280     v_enqueueEvent();
 281 }
 282
 283 ///////////////////////////////////////////////////////////////////////////
 284 // senf::ppi::connector::OutputConnector
 285
 286 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
 287     const
 288 {
 289     return dynamic_cast<InputConnector&>(Connector::peer());
 290 }
 291
 292 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet const & p)
 293 {
 294     trace(p, "OUT");
 295     if (connected())
 296         peer().enqueue(p);
 297 }
 298
 299 prefix_ void senf::ppi::connector::OutputConnector::write(Packet const & p)
 300 {
 301     operator()(p);
 302 }
 303
 304 ////////////////////////////////////////
 305 // protected members
 306
 307 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
 308 {}
 309
 310 ///////////////////////////////////////////////////////////////////////////
 311 // senf::ppi::connector::GenericPassiveInput
 312
 313 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
 314     : qdisc_(new ThresholdQueueing(1,0))
 315 {}
 316
 317 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
 318     const
 319 {
 320     return dynamic_cast<GenericActiveOutput&>(Connector::peer());
 321 }
 322
 323 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
 324     const
 325 {
 326     return ! empty();
 327 }
 328
 329 ///////////////////////////////////////////////////////////////////////////
 330 // senf::ppi::connector::GenericPassiveOutput
 331
 332 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
 333     const
 334 {
 335     return dynamic_cast<GenericActiveInput&>(Connector::peer());
 336 }
 337
 338 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
 339     const
 340 {
 341     return  true;
 342 }
 343
 344 prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveInput & target)
 345 {
 346     Connector::connect(target);
 347 }
 348
 349 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
 350 {}
 351
 352 ///////////////////////////////////////////////////////////////////////////
 353 // senf::ppi::connector::GenericActiveInput
 354
 355 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
 356     const
 357 {
 358     return dynamic_cast<GenericPassiveOutput&>(Connector::peer());
 359 }
 360
 361 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
 362     const
 363 {
 364     return ! empty() || (connected() && ! peer().throttled());
 365 }
 366
 367 prefix_ void senf::ppi::connector::GenericActiveInput::request()
 368 {
 369     if (connected())
 370         peer().emit();
 371 }
 372
 373 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
 374 {}
 375
 376 ///////////////////////////////////////////////////////////////////////////
 377 // senf::ppi::connector::GenericActiveOutput
 378
 379 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
 380     const
 381 {
 382     return dynamic_cast<GenericPassiveInput&>(Connector::peer());
 383 }
 384
 385 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
 386     const
 387 {
 388     return connected() && ! peer().throttled();
 389 }
 390
 391 prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveInput & target)
 392 {
 393     Connector::connect(target);
 394 }
 395
 396 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
 397 {}
 398
 399 ///////////////////////////////cci.e///////////////////////////////////////
 400 #undef prefix_
 401
 402 \f
 403 // Local Variables:
 404 // mode: c++
 405 // fill-column: 100
 406 // comment-column: 40
 407 // c-file-style: "senf"
 408 // indent-tabs-mode: nil
 409 // ispell-local-dictionary: "american"
 410 // compile-command: "scons -u test"
 411 // End: