PPI/Connectors.cci

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   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::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
 197     const
 198 {
 199     return dynamic_cast<OutputConnector &>(Connector::peer());
 200 }
 201
 202 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 203 senf::ppi::connector::InputConnector::begin()
 204     const
 205 {
 206     return queue_.begin();
 207 }
 208
 209 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 210 senf::ppi::connector::InputConnector::end()
 211     const
 212 {
 213     return queue_.end();
 214 }
 215
 216 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
 217     const
 218 {
 219     BOOST_ASSERT( ! queue_.empty() );
 220     return queue_.back();
 221 }
 222
 223 prefix_ senf::ppi::connector::InputConnector::size_type
 224 senf::ppi::connector::InputConnector::queueSize()
 225     const
 226 {
 227     return queue_.size();
 228 }
 229
 230 prefix_ bool senf::ppi::connector::InputConnector::empty()
 231     const
 232 {
 233     return queue_.empty();
 234 }
 235
 236 ////////////////////////////////////////
 237 // protected members
 238
 239 prefix_ senf::ppi::connector::InputConnector::InputConnector()
 240 {}
 241
 242 ////////////////////////////////////////
 243 // private members
 244
 245 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet p)
 246 {
 247     queue_.push_front(p);
 248     v_enqueueEvent();
 249 }
 250
 251 ///////////////////////////////////////////////////////////////////////////
 252 // senf::ppi::connector::OutputConnector
 253
 254 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet p)
 255 {
 256     peer().enqueue(p);
 257 }
 258
 259 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
 260     const
 261 {
 262     return dynamic_cast<InputConnector&>(Connector::peer());
 263 }
 264
 265 ////////////////////////////////////////
 266 // protected members
 267
 268 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
 269 {}
 270
 271 ///////////////////////////////////////////////////////////////////////////
 272 // senf::ppi::connector::PassiveInput
 273
 274 prefix_ senf::ppi::connector::PassiveInput::PassiveInput()
 275     : qdisc_(new ThresholdQueueing(1,0))
 276 {}
 277
 278 prefix_ senf::ppi::connector::ActiveOutput & senf::ppi::connector::PassiveInput::peer()
 279     const
 280 {
 281     return dynamic_cast<ActiveOutput&>(Connector::peer());
 282 }
 283
 284 prefix_ bool senf::ppi::connector::PassiveInput::boolean_test()
 285     const
 286 {
 287     return ! empty();
 288 }
 289
 290 ///////////////////////////////////////////////////////////////////////////
 291 // senf::ppi::connector::PassiveOutput
 292
 293 prefix_ senf::ppi::connector::ActiveInput & senf::ppi::connector::PassiveOutput::peer()
 294     const
 295 {
 296     return dynamic_cast<ActiveInput&>(Connector::peer());
 297 }
 298
 299 prefix_ bool senf::ppi::connector::PassiveOutput::boolean_test()
 300     const
 301 {
 302     return  true;
 303 }
 304
 305 prefix_ void senf::ppi::connector::PassiveOutput::connect(ActiveInput & target)
 306 {
 307     Connector::connect(target);
 308 }
 309
 310 ///////////////////////////////////////////////////////////////////////////
 311 // senf::ppi::connector::ActiveInput
 312
 313 prefix_ senf::ppi::connector::PassiveOutput & senf::ppi::connector::ActiveInput::peer()
 314     const
 315 {
 316     return dynamic_cast<PassiveOutput&>(Connector::peer());
 317 }
 318
 319 prefix_ bool senf::ppi::connector::ActiveInput::boolean_test()
 320     const
 321 {
 322     return ! empty() || ! peer().throttled();
 323 }
 324
 325 prefix_ void senf::ppi::connector::ActiveInput::request()
 326 {
 327     peer().emit();
 328 }
 329
 330 ///////////////////////////////////////////////////////////////////////////
 331 // senf::ppi::connector::ActiveOutput
 332
 333 prefix_ senf::ppi::connector::PassiveInput & senf::ppi::connector::ActiveOutput::peer()
 334     const
 335 {
 336     return dynamic_cast<PassiveInput&>(Connector::peer());
 337 }
 338
 339 prefix_ bool senf::ppi::connector::ActiveOutput::boolean_test()
 340     const
 341 {
 342     return ! peer().throttled();
 343 }
 344
 345 prefix_ void senf::ppi::connector::ActiveOutput::connect(PassiveInput & target)
 346 {
 347     Connector::connect(target);
 348 }
 349
 350 ///////////////////////////////cci.e///////////////////////////////////////
 351 #undef prefix_
 352
 353 \f
 354 // Local Variables:
 355 // mode: c++
 356 // fill-column: 100
 357 // comment-column: 40
 358 // c-file-style: "senf"
 359 // indent-tabs-mode: nil
 360 // ispell-local-dictionary: "american"
 361 // compile-command: "scons -u test"
 362 // End: