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