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::notifyUnthrottle()
 138 {
 139     if (throttled() && !nativeThrottled_) {
 140         remoteThrottled_ = false;
 141         emitUnthrottle();
 142     }
 143     else
 144         remoteThrottled_ = false;
 145 }
 146
 147 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
 148 {
 149     peer().notifyThrottle();
 150 }
 151
 152 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
 153 {
 154     peer().notifyUnthrottle();
 155     v_unthrottleEvent();
 156 }
 157
 158 prefix_ void senf::ppi::connector::PassiveConnector::v_unthrottleEvent()
 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 ////////////////////////////////////////
 181 // protected members
 182
 183 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
 184     : throttleCallback_(), unthrottleCallback_(), notifyRoutes_()
 185 {}
 186
 187 ///////////////////////////////////////////////////////////////////////////
 188 // senf::ppi::connector::InputConnector
 189
 190 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
 191     const
 192 {
 193     return dynamic_cast<OutputConnector &>(Connector::peer());
 194 }
 195
 196 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 197 senf::ppi::connector::InputConnector::begin()
 198     const
 199 {
 200     return queue_.begin();
 201 }
 202
 203 prefix_ senf::ppi::connector::InputConnector::queue_iterator
 204 senf::ppi::connector::InputConnector::end()
 205     const
 206 {
 207     return queue_.end();
 208 }
 209
 210 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
 211     const
 212 {
 213     BOOST_ASSERT( ! queue_.empty() );
 214     return queue_.back();
 215 }
 216
 217 prefix_ senf::ppi::connector::InputConnector::size_type
 218 senf::ppi::connector::InputConnector::queueSize()
 219     const
 220 {
 221     return queue_.size();
 222 }
 223
 224 prefix_ bool senf::ppi::connector::InputConnector::empty()
 225     const
 226 {
 227     return queue_.empty();
 228 }
 229
 230 ////////////////////////////////////////
 231 // protected members
 232
 233 prefix_ senf::ppi::connector::InputConnector::InputConnector()
 234 {}
 235
 236 ////////////////////////////////////////
 237 // private members
 238
 239 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet p)
 240 {
 241     queue_.push_front(p);
 242     v_enqueueEvent();
 243 }
 244
 245 ///////////////////////////////////////////////////////////////////////////
 246 // senf::ppi::connector::OutputConnector
 247
 248 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet p)
 249 {
 250     peer().enqueue(p);
 251 }
 252
 253 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
 254     const
 255 {
 256     return dynamic_cast<InputConnector&>(Connector::peer());
 257 }
 258
 259 ////////////////////////////////////////
 260 // protected members
 261
 262 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
 263 {}
 264
 265 ///////////////////////////////////////////////////////////////////////////
 266 // senf::ppi::connector::PassiveInput
 267
 268 prefix_ senf::ppi::connector::PassiveInput::PassiveInput()
 269     : qdisc_(new ThresholdQueueing(1,0))
 270 {}
 271
 272 prefix_ senf::ppi::connector::ActiveOutput & senf::ppi::connector::PassiveInput::peer()
 273     const
 274 {
 275     return dynamic_cast<ActiveOutput&>(Connector::peer());
 276 }
 277
 278 prefix_ bool senf::ppi::connector::PassiveInput::boolean_test()
 279     const
 280 {
 281     return ! empty();
 282 }
 283
 284 ///////////////////////////////////////////////////////////////////////////
 285 // senf::ppi::connector::PassiveOutput
 286
 287 prefix_ senf::ppi::connector::ActiveInput & senf::ppi::connector::PassiveOutput::peer()
 288     const
 289 {
 290     return dynamic_cast<ActiveInput&>(Connector::peer());
 291 }
 292
 293 prefix_ bool senf::ppi::connector::PassiveOutput::boolean_test()
 294     const
 295 {
 296     return  true;
 297 }
 298
 299 prefix_ void senf::ppi::connector::PassiveOutput::connect(ActiveInput & target)
 300 {
 301     Connector::connect(target);
 302 }
 303
 304 ///////////////////////////////////////////////////////////////////////////
 305 // senf::ppi::connector::ActiveInput
 306
 307 prefix_ senf::ppi::connector::PassiveOutput & senf::ppi::connector::ActiveInput::peer()
 308     const
 309 {
 310     return dynamic_cast<PassiveOutput&>(Connector::peer());
 311 }
 312
 313 prefix_ bool senf::ppi::connector::ActiveInput::boolean_test()
 314     const
 315 {
 316     return ! empty() || ! peer().throttled();
 317 }
 318
 319 prefix_ void senf::ppi::connector::ActiveInput::request()
 320 {
 321     peer().emit();
 322 }
 323
 324 ///////////////////////////////////////////////////////////////////////////
 325 // senf::ppi::connector::ActiveOutput
 326
 327 prefix_ senf::ppi::connector::PassiveInput & senf::ppi::connector::ActiveOutput::peer()
 328     const
 329 {
 330     return dynamic_cast<PassiveInput&>(Connector::peer());
 331 }
 332
 333 prefix_ bool senf::ppi::connector::ActiveOutput::boolean_test()
 334     const
 335 {
 336     return ! peer().throttled();
 337 }
 338
 339 prefix_ void senf::ppi::connector::ActiveOutput::connect(PassiveInput & target)
 340 {
 341     Connector::connect(target);
 342 }
 343
 344 ///////////////////////////////cci.e///////////////////////////////////////
 345 #undef prefix_
 346
 347 \f
 348 // Local Variables:
 349 // mode: c++
 350 // fill-column: 100
 351 // comment-column: 40
 352 // c-file-style: "senf"
 353 // indent-tabs-mode: nil
 354 // ispell-local-dictionary: "american"
 355 // compile-command: "scons -u test"
 356 // End: