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