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_);
  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_);
  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 (onEvent() call missing)
 166     SENF_ASSERT(callback_);
 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     return queue_.back();
 237 }
 238
 239 prefix_ senf::ppi::connector::InputConnector::size_type
 240 senf::ppi::connector::InputConnector::queueSize()
 241     const
 242 {
 243     return queue_.size();
 244 }
 245
 246 prefix_ bool senf::ppi::connector::InputConnector::empty()
 247     const
 248 {
 249     return queue_.empty();
 250 }
 251
 252 ////////////////////////////////////////
 253 // protected members
 254
 255 prefix_ senf::ppi::connector::InputConnector::InputConnector()
 256 {}
 257
 258 ////////////////////////////////////////
 259 // private members
 260
 261 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet p)
 262 {
 263     queue_.push_front(p);
 264     v_enqueueEvent();
 265 }
 266
 267 ///////////////////////////////////////////////////////////////////////////
 268 // senf::ppi::connector::OutputConnector
 269
 270 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
 271     const
 272 {
 273     return dynamic_cast<InputConnector&>(Connector::peer());
 274 }
 275
 276 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet p)
 277 {
 278     if (connected())
 279         peer().enqueue(p);
 280 }
 281
 282 prefix_ void senf::ppi::connector::OutputConnector::write(Packet p)
 283 {
 284     operator()(p);
 285 }
 286
 287 ////////////////////////////////////////
 288 // protected members
 289
 290 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
 291 {}
 292
 293 ///////////////////////////////////////////////////////////////////////////
 294 // senf::ppi::connector::GenericPassiveInput
 295
 296 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
 297     : qdisc_(new ThresholdQueueing(1,0))
 298 {}
 299
 300 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
 301     const
 302 {
 303     return dynamic_cast<GenericActiveOutput&>(Connector::peer());
 304 }
 305
 306 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
 307     const
 308 {
 309     return ! empty();
 310 }
 311
 312 ///////////////////////////////////////////////////////////////////////////
 313 // senf::ppi::connector::GenericPassiveOutput
 314
 315 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
 316     const
 317 {
 318     return dynamic_cast<GenericActiveInput&>(Connector::peer());
 319 }
 320
 321 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
 322     const
 323 {
 324     return  true;
 325 }
 326
 327 prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveInput & target)
 328 {
 329     Connector::connect(target);
 330 }
 331
 332 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
 333 {}
 334
 335 ///////////////////////////////////////////////////////////////////////////
 336 // senf::ppi::connector::GenericActiveInput
 337
 338 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
 339     const
 340 {
 341     return dynamic_cast<GenericPassiveOutput&>(Connector::peer());
 342 }
 343
 344 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
 345     const
 346 {
 347     return ! empty() || (connected() && ! peer().throttled());
 348 }
 349
 350 prefix_ void senf::ppi::connector::GenericActiveInput::request()
 351 {
 352     if (connected())
 353         peer().emit();
 354 }
 355
 356 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
 357 {}
 358
 359 ///////////////////////////////////////////////////////////////////////////
 360 // senf::ppi::connector::GenericActiveOutput
 361
 362 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
 363     const
 364 {
 365     return dynamic_cast<GenericPassiveInput&>(Connector::peer());
 366 }
 367
 368 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
 369     const
 370 {
 371     return connected() && ! peer().throttled();
 372 }
 373
 374 prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveInput & target)
 375 {
 376     Connector::connect(target);
 377 }
 378
 379 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
 380 {}
 381
 382 ///////////////////////////////cci.e///////////////////////////////////////
 383 #undef prefix_
 384
 385 \f
 386 // Local Variables:
 387 // mode: c++
 388 // fill-column: 100
 389 // comment-column: 40
 390 // c-file-style: "senf"
 391 // indent-tabs-mode: nil
 392 // ispell-local-dictionary: "american"
 393 // compile-command: "scons -u test"
 394 // End: