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