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