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