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 "../Utils/TypeInfo.hh"
  28 #include "../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     SENF_ASSERT(peer_);
  40     return *peer_;
  41 }
  42
  43 prefix_ senf::ppi::module::Module & senf::ppi::connector::Connector::module()
  44     const
  45 {
  46     SENF_ASSERT(module_);
  47     return *module_;
  48 }
  49
  50 ////////////////////////////////////////
  51 // protected members
  52
  53 prefix_ senf::ppi::connector::Connector::Connector()
  54     : peer_(), module_()
  55 {}
  56
  57 prefix_ senf::ppi::connector::Connector::~Connector()
  58 {
  59     if (connected())
  60         peer_->peer_ = 0;
  61 }
  62
  63 prefix_ bool senf::ppi::connector::Connector::connected()
  64     const
  65 {
  66     return peer_;
  67 }
  68
  69 ////////////////////////////////////////
  70 // private members
  71
  72 prefix_ void senf::ppi::connector::Connector::setModule(module::Module & module)
  73 {
  74     module_ = &module;
  75 }
  76
  77 prefix_ void senf::ppi::connector::Connector::init()
  78 {
  79     v_init();
  80 }
  81
  82 ///////////////////////////////////////////////////////////////////////////
  83 // senf::ppi::connector::PassiveConnector
  84
  85 prefix_ senf::ppi::connector::ActiveConnector & senf::ppi::connector::PassiveConnector::peer()
  86     const
  87 {
  88     return dynamic_cast<ActiveConnector&>(Connector::peer());
  89 }
  90
  91 prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
  92     const
  93 {
  94     return nativeThrottled_ || remoteThrottled_;
  95 }
  96
  97 ////////////////////////////////////////
  98 // private members
  99
 100 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
 101 {
 102     if (connected())
 103         peer().notifyThrottle();
 104 }
 105
 106 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
 107 {
 108     if (connected()) {
 109         peer().notifyUnthrottle();
 110         v_unthrottleEvent();
 111     }
 112 }
 113
 114 prefix_ void senf::ppi::connector::PassiveConnector::notifyThrottle()
 115 {
 116     if (!throttled()) {
 117         remoteThrottled_ = true;
 118         emitThrottle();
 119     }
 120     else
 121         remoteThrottled_ = true;
 122 }
 123
 124 prefix_ void senf::ppi::connector::PassiveConnector::registerRoute(ForwardingRoute & route)
 125 {
 126     routes_.push_back(&route);
 127 }
 128
 129 // public members
 130
 131 prefix_ bool senf::ppi::connector::PassiveConnector::nativeThrottled()
 132     const
 133 {
 134     return nativeThrottled_;
 135 }
 136
 137 prefix_ void senf::ppi::connector::PassiveConnector::throttle()
 138 {
 139     if (!throttled()) {
 140         nativeThrottled_ = true;
 141         emitThrottle();
 142     }
 143 }
 144
 145 prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
 146 {
 147     if (throttled() && ! remoteThrottled_) {
 148         nativeThrottled_ = false;
 149         emitUnthrottle();
 150     } else
 151         nativeThrottled_ = false;
 152
 153 }
 154
 155 ////////////////////////////////////////
 156 // protected members
 157
 158 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
 159     : callback_(), remoteThrottled_(), nativeThrottled_()
 160 {}
 161
 162 prefix_ void senf::ppi::connector::PassiveConnector::emit()
 163 {
 164     SENF_ASSERT(callback_);
 165     if (!throttled())
 166         callback_();
 167 }
 168
 169 ///////////////////////////////////////////////////////////////////////////
 170 // senf::ppi::connector::ActiveConnector
 171
 172 prefix_ senf::ppi::connector::PassiveConnector & senf::ppi::connector::ActiveConnector::peer()
 173     const
 174 {
 175     return dynamic_cast<PassiveConnector&>(Connector::peer());
 176 }
 177
 178 prefix_ void senf::ppi::connector::ActiveConnector::onThrottle()
 179 {
 180     throttleCallback_ = Callback();
 181 }
 182
 183 prefix_ void senf::ppi::connector::ActiveConnector::onUnthrottle()
 184 {
 185     unthrottleCallback_ = Callback();
 186 }
 187
 188 prefix_ bool senf::ppi::connector::ActiveConnector::throttled()
 189     const
 190 {
 191     return ! connected() || peer().throttled();
 192 }
 193
 194 ////////////////////////////////////////
 195 // protected members
 196
 197 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
 198     : throttleCallback_(), unthrottleCallback_(), notifyRoutes_(), throttled_(false)
 199 {}
 200
 201 ///////////////////////////////////////////////////////////////////////////
 202 // senf::ppi::connector::InputConnector
 203
 204 prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
 205 {
 206     return operator()();
 207 }
 208
 209 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
 210     const
 211 {
 212     return dynamic_cast<OutputConnector &>(Connector::peer());
 213 }
 214
 215 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 216 senf::ppi::connector::InputConnector::begin()
 217     const
 218 {
 219     return queue_.begin();
 220 }
 221
 222 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 223 senf::ppi::connector::InputConnector::end()
 224     const
 225 {
 226     return queue_.end();
 227 }
 228
 229 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
 230     const
 231 {
 232     SENF_ASSERT( ! queue_.empty() );
 233     return queue_.back();
 234 }
 235
 236 prefix_ senf::ppi::connector::InputConnector::size_type
 237 senf::ppi::connector::InputConnector::queueSize()
 238     const
 239 {
 240     return queue_.size();
 241 }
 242
 243 prefix_ bool senf::ppi::connector::InputConnector::empty()
 244     const
 245 {
 246     return queue_.empty();
 247 }
 248
 249 ////////////////////////////////////////
 250 // protected members
 251
 252 prefix_ senf::ppi::connector::InputConnector::InputConnector()
 253 {}
 254
 255 ////////////////////////////////////////
 256 // private members
 257
 258 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet p)
 259 {
 260     queue_.push_front(p);
 261     v_enqueueEvent();
 262 }
 263
 264 ///////////////////////////////////////////////////////////////////////////
 265 // senf::ppi::connector::OutputConnector
 266
 267 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
 268     const
 269 {
 270     return dynamic_cast<InputConnector&>(Connector::peer());
 271 }
 272
 273 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet p)
 274 {
 275     if (connected())
 276         peer().enqueue(p);
 277 }
 278
 279 prefix_ void senf::ppi::connector::OutputConnector::write(Packet p)
 280 {
 281     operator()(p);
 282 }
 283
 284 ////////////////////////////////////////
 285 // protected members
 286
 287 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
 288 {}
 289
 290 ///////////////////////////////////////////////////////////////////////////
 291 // senf::ppi::connector::GenericPassiveInput
 292
 293 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
 294     : qdisc_(new ThresholdQueueing(1,0))
 295 {}
 296
 297 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
 298     const
 299 {
 300     return dynamic_cast<GenericActiveOutput&>(Connector::peer());
 301 }
 302
 303 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
 304     const
 305 {
 306     return ! empty();
 307 }
 308
 309 ///////////////////////////////////////////////////////////////////////////
 310 // senf::ppi::connector::GenericPassiveOutput
 311
 312 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
 313     const
 314 {
 315     return dynamic_cast<GenericActiveInput&>(Connector::peer());
 316 }
 317
 318 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
 319     const
 320 {
 321     return  true;
 322 }
 323
 324 prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveInput & target)
 325 {
 326     Connector::connect(target);
 327 }
 328
 329 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
 330 {}
 331
 332 ///////////////////////////////////////////////////////////////////////////
 333 // senf::ppi::connector::GenericActiveInput
 334
 335 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
 336     const
 337 {
 338     return dynamic_cast<GenericPassiveOutput&>(Connector::peer());
 339 }
 340
 341 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
 342     const
 343 {
 344     return ! empty() || (connected() && ! peer().throttled());
 345 }
 346
 347 prefix_ void senf::ppi::connector::GenericActiveInput::request()
 348 {
 349     if (connected())
 350         peer().emit();
 351 }
 352
 353 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
 354 {}
 355
 356 ///////////////////////////////////////////////////////////////////////////
 357 // senf::ppi::connector::GenericActiveOutput
 358
 359 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
 360     const
 361 {
 362     return dynamic_cast<GenericPassiveInput&>(Connector::peer());
 363 }
 364
 365 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
 366     const
 367 {
 368     return connected() && ! peer().throttled();
 369 }
 370
 371 prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveInput & target)
 372 {
 373     Connector::connect(target);
 374 }
 375
 376 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
 377 {}
 378
 379 ///////////////////////////////cci.e///////////////////////////////////////
 380 #undef prefix_
 381
 382 \f
 383 // Local Variables:
 384 // mode: c++
 385 // fill-column: 100
 386 // comment-column: 40
 387 // c-file-style: "senf"
 388 // indent-tabs-mode: nil
 389 // ispell-local-dictionary: "american"
 390 // compile-command: "scons -u test"
 391 // End: