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