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