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