4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Connectors non-inline non-template implementation */
26 #include "Connectors.hh"
27 #include "Connectors.ih"
30 #include "ModuleManager.hh"
31 #include <senf/Utils/Console/ParsedCommand.hh>
33 //#include "Connectors.mpp"
35 ///////////////////////////////cc.p////////////////////////////////////////
37 ///////////////////////////////////////////////////////////////////////////
38 // senf::ppi::connector::Connector
40 prefix_ senf::ppi::connector::Connector::~Connector()
43 Connector & peer (*peer_);
45 if (! peer.initializationScheduled())
46 peer.enqueueInitializable();
47 peer.v_disconnected();
51 prefix_ void senf::ppi::connector::Connector::connect(Connector & target)
53 // The connector is not registered -> route() or noroute() statement missing
55 "senf::ppi::connector::Connector::connect(): (source) "
56 "Missing route() or noroute()" );
57 // The connector is already connected
59 "senf::ppi::connector::Connector::connect(): (source) "
60 "duplicate connection" );
61 // The target connector is not registered -> route() or noroute() statement missing
62 SENF_ASSERT( target.module_,
63 "senf::ppi::connector::Connector::connect(): (target) "
64 "Missing route() or noroute()" );
65 // The target connector is already connected
66 SENF_ASSERT( ! target.peer_,
67 "senf::ppi::connector::Connector::connect(): (target) "
68 "duplicate connection" );
69 if (! (packetTypeID() == typeid(void) ||
70 target.packetTypeID() == typeid(void) ||
71 packetTypeID() == target.packetTypeID()) )
72 throw IncompatibleConnectorsException()
73 << ": " << prettyName(packetTypeID())
74 << " [in module " << prettyName(typeid(*module_)) << "] "
75 << ", " << prettyName(target.packetTypeID())
76 << " [in module " << prettyName(typeid(*target.module_)) << "]";
81 if (! initializationScheduled())
82 enqueueInitializable();
83 if (! peer().initializationScheduled())
84 peer().enqueueInitializable();
91 senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::traceState_ (
92 senf::ppi::connector::Connector::NO_TRACING);
94 prefix_ void senf::ppi::connector::Connector::trace(Packet const & p, char const * label)
96 if (traceState_ == NO_TRACING)
99 std::string type (prettyName(p.typeId().id()));
100 log << "PPI packet trace: " << label << " 0x" << std::hex << p.id() << " "
101 << type.substr(21, type.size()-22) << " on " << & module() << " "
102 << prettyName(typeid(module())) << " connector 0x" << this << "\n";
103 if (traceState_ == TRACE_CONTENTS)
108 prefix_ void senf::ppi::connector::Connector::throttleTrace(char const * label,
111 if (traceState_ == NO_TRACING)
114 log << "PPI throttling trace: " << label << " " << type << " on " << & module()
115 << " " << prettyName(typeid(module())) << " connector 0x" << this << "\n";
119 namespace senf { namespace ppi { namespace connector {
121 SENF_CONSOLE_REGISTER_ENUM_MEMBER(
122 Connector, TraceState, (NO_TRACING)(TRACE_IDS)(TRACE_CONTENTS) );
128 struct ConsoleRegister
133 ConsoleRegister::ConsoleRegister()
135 #ifndef SENF_PPI_NOTRACE
136 senf::ppi::ModuleManager::instance().consoleDir()
137 .add("tracing", senf::console::factory::Command(
138 SENF_FNP(senf::ppi::connector::Connector::TraceState,
139 senf::ppi::connector::Connector::tracing, ()))
140 .doc("Log every packet sent or received by any module.\n"
141 "There are three different tracing levels:\n"
143 " NO_TRACING don't output any tracing information\n"
144 " TRACE_IDS trace packet id's but do not show packet contents\n"
145 " TRACE_CONTENTS trace complete packet contents\n"
147 "A log message is generated whenever the packet traverses a connector. The\n"
148 "TRACE_IDS log message has the following format:\n"
150 " PPI packet trace: <direction> <packet-id> <packet-type>\n"
151 " on <module-id> <module-type> connector <connector-id>\n"
152 " PPI throttling trace: <direction> <throttle-msg>\n"
153 " on <module-id> <module-type> connector <connector-id>\n"
157 " direction 'IN' for packets/throttle notifications entering the module,\n"
158 " 'OUT' for packets/throttle notifications leaving it\n"
159 " packet-id Numeric unique packet id. This value is unique for packets\n"
160 " alive at the same time, packets at different times may (and\n"
161 " will) share id's\n"
162 " packet-type The type of the packet header\n"
163 " module-id Unique module id\n"
164 " module-type Type of the module the packet is sent to/from\n"
165 " connector-id Unique connector id\n"
166 " throttle-msg Type of throttling event\n")
169 senf::ppi::ModuleManager::instance().consoleDir()
170 .add("tracing", senf::console::factory::Command(
171 SENF_FNP(void, senf::ppi::connector::Connector::tracing,
172 (senf::ppi::connector::Connector::TraceState)))
173 .arg("state", "new tracing state")
178 ConsoleRegister consoleRegister;
182 prefix_ void senf::ppi::connector::Connector::disconnect()
184 // Cannot disconnected a non-connected connector
186 "senf::ppi::connector::Connector::disconnect(): Not connected" );
188 Connector & peer (*peer_);
192 if (! initializationScheduled())
193 enqueueInitializable();
194 if (! peer.initializationScheduled())
195 peer.enqueueInitializable();
198 peer.v_disconnected();
201 prefix_ std::type_info const & senf::ppi::connector::Connector::packetTypeID()
206 prefix_ void senf::ppi::connector::Connector::unregisterConnector()
209 module_->unregisterConnector(*this);
212 prefix_ void senf::ppi::connector::Connector::setModule(module::Module & module)
217 prefix_ void senf::ppi::connector::Connector::v_disconnected()
220 prefix_ void senf::ppi::connector::Connector::v_connected()
223 ///////////////////////////////////////////////////////////////////////////
224 // senf::ppi::connector::PassiveConnector
226 prefix_ senf::ppi::connector::PassiveConnector::~PassiveConnector()
228 // Must be here and NOT in base so it is called before destructing the routes_ member
229 unregisterConnector();
232 prefix_ void senf::ppi::connector::PassiveConnector::v_disconnected()
234 Connector::v_disconnected();
238 prefix_ void senf::ppi::connector::PassiveConnector::v_connected()
240 Connector::v_connected();
241 peer_ = & dynamic_cast<ActiveConnector&>(Connector::peer());
244 ////////////////////////////////////////
247 prefix_ void senf::ppi::connector::PassiveConnector::v_init()
249 Routes::const_iterator i (routes_.begin());
250 Routes::const_iterator const i_end (routes_.end());
251 for (; i != i_end; ++i)
252 if ((*i)->throttled())
255 remoteThrottled_ = false;
262 prefix_ void senf::ppi::connector::PassiveConnector::registerRoute(ForwardingRoute & route)
264 routes_.push_back(&route);
267 prefix_ void senf::ppi::connector::PassiveConnector::unregisterRoute(ForwardingRoute & route)
269 Routes::iterator i (std::find(routes_.begin(), routes_.end(), &route));
270 if (i != routes_.end())
274 prefix_ void senf::ppi::connector::PassiveConnector::v_unthrottleEvent()
277 prefix_ void senf::ppi::connector::PassiveConnector::notifyUnthrottle()
279 if (std::find_if(routes_.begin(), routes_.end(),
280 boost::bind(&ForwardingRoute::throttled, _1)) == routes_.end()) {
281 remoteThrottled_ = false;
282 if (!nativeThrottled_)
285 SENF_PPI_THROTTLE_TRACE("OUT", "not forwarding unthrottle event");
288 ///////////////////////////////////////////////////////////////////////////
289 // senf::ppi::connector::ActiveConnector
291 prefix_ senf::ppi::connector::ActiveConnector::~ActiveConnector()
293 // Must be here and NOT in base so it is called before destructing the routes_ member
294 unregisterConnector();
297 prefix_ void senf::ppi::connector::ActiveConnector::v_disconnected()
299 Connector::v_disconnected();
303 prefix_ void senf::ppi::connector::ActiveConnector::v_connected()
305 Connector::v_connected();
306 peer_ = & dynamic_cast<PassiveConnector&>(Connector::peer());
309 ////////////////////////////////////////
312 prefix_ void senf::ppi::connector::ActiveConnector::v_init()
318 prefix_ void senf::ppi::connector::ActiveConnector::notifyThrottle()
320 SENF_PPI_THROTTLE_TRACE("IN ", "throttle");
323 if (throttleCallback_)
325 NotifyRoutes::const_iterator i (notifyRoutes_.begin());
326 NotifyRoutes::const_iterator const i_end (notifyRoutes_.end());
327 for (; i != i_end; ++i)
328 (*i)->notifyThrottle();
332 prefix_ void senf::ppi::connector::ActiveConnector::notifyUnthrottle()
334 SENF_PPI_THROTTLE_TRACE("IN ", "unthrottle");
337 if (unthrottleCallback_)
338 unthrottleCallback_();
339 NotifyRoutes::const_iterator i (notifyRoutes_.begin());
340 NotifyRoutes::const_iterator const i_end (notifyRoutes_.end());
341 for (; i != i_end; ++i)
342 (*i)->notifyUnthrottle();
346 prefix_ void senf::ppi::connector::ActiveConnector::registerRoute(ForwardingRoute & route)
348 notifyRoutes_.push_back(&route);
351 prefix_ void senf::ppi::connector::ActiveConnector::unregisterRoute(ForwardingRoute & route)
353 NotifyRoutes::iterator i (std::find(notifyRoutes_.begin(), notifyRoutes_.end(), &route));
354 if (i != notifyRoutes_.end())
355 notifyRoutes_.erase(i);
358 ///////////////////////////////////////////////////////////////////////////
359 // senf::ppi::connector::InputConnector
361 prefix_ senf::Packet senf::ppi::connector::InputConnector::operator()()
366 Packet p ( queue_.back());
369 SENF_PPI_TRACE(p, "IN ");
372 SENF_PPI_TRACE(Packet(), "IN ");
377 prefix_ void senf::ppi::connector::InputConnector::v_disconnected()
379 Connector::v_disconnected();
383 prefix_ void senf::ppi::connector::InputConnector::v_connected()
385 Connector::v_connected();
386 peer_ = & dynamic_cast<OutputConnector&>(Connector::peer());
389 ////////////////////////////////////////
392 prefix_ void senf::ppi::connector::InputConnector::v_requestEvent()
395 prefix_ void senf::ppi::connector::InputConnector::v_enqueueEvent()
398 prefix_ void senf::ppi::connector::InputConnector::v_dequeueEvent()
401 ///////////////////////////////////////////////////////////////////////////
402 // senf::ppi::connector::OutputConnector
404 prefix_ void senf::ppi::connector::OutputConnector::v_disconnected()
406 Connector::v_disconnected();
410 prefix_ void senf::ppi::connector::OutputConnector::v_connected()
412 Connector::v_connected();
413 peer_ = & dynamic_cast<InputConnector&>(Connector::peer());
416 ///////////////////////////////////////////////////////////////////////////
417 // senf::ppi::connector::GenericActiveInput
419 ////////////////////////////////////////
422 prefix_ void senf::ppi::connector::GenericActiveInput::v_requestEvent()
427 ///////////////////////////////////////////////////////////////////////////
428 // senf::ppi::connector::GenericPassiveInput
430 prefix_ void senf::ppi::connector::GenericPassiveInput::v_disconnected()
432 PassiveConnector::v_disconnected();
433 InputConnector::v_disconnected();
437 prefix_ void senf::ppi::connector::GenericPassiveInput::v_connected()
439 PassiveConnector::v_connected();
440 InputConnector::v_connected();
441 peer_ = & dynamic_cast<GenericActiveOutput&>(Connector::peer());
444 ////////////////////////////////////////
447 prefix_ void senf::ppi::connector::GenericPassiveInput::v_enqueueEvent()
451 qdisc_->update(*this, QueueingDiscipline::ENQUEUE);
454 prefix_ void senf::ppi::connector::GenericPassiveInput::v_dequeueEvent()
457 qdisc_->update(*this, QueueingDiscipline::DEQUEUE);
460 prefix_ void senf::ppi::connector::GenericPassiveInput::qdisc(QueueingDiscipline::None_t)
465 prefix_ void senf::ppi::connector::GenericPassiveInput::v_unthrottleEvent()
467 size_type n (queueSize());
470 size_type nn (queueSize());
477 ///////////////////////////////////////////////////////////////////////////
478 // senf::ppi::connector::GenericPassiveOutput
480 prefix_ void senf::ppi::connector::GenericPassiveOutput::v_disconnected()
482 PassiveConnector::v_disconnected();
483 OutputConnector::v_disconnected();
487 prefix_ void senf::ppi::connector::GenericPassiveOutput::v_connected()
489 PassiveConnector::v_connected();
490 OutputConnector::v_connected();
491 peer_ = & dynamic_cast<GenericActiveInput&>(Connector::peer());
494 ///////////////////////////////////////////////////////////////////////////
495 // senf::ppi::connector::GenericActiveInput
497 prefix_ void senf::ppi::connector::GenericActiveInput::v_disconnected()
499 ActiveConnector::v_disconnected();
500 InputConnector::v_disconnected();
504 prefix_ void senf::ppi::connector::GenericActiveInput::v_connected()
506 ActiveConnector::v_connected();
507 InputConnector::v_connected();
508 peer_ = & dynamic_cast<GenericPassiveOutput&>(Connector::peer());
511 ///////////////////////////////////////////////////////////////////////////
512 // senf::ppi::connector::GenericActiveOutput
514 prefix_ void senf::ppi::connector::GenericActiveOutput::v_disconnected()
516 ActiveConnector::v_disconnected();
517 OutputConnector::v_disconnected();
521 prefix_ void senf::ppi::connector::GenericActiveOutput::v_connected()
523 ActiveConnector::v_connected();
524 OutputConnector::v_connected();
525 peer_ = & dynamic_cast<GenericPassiveInput&>(Connector::peer());
529 ///////////////////////////////cc.e////////////////////////////////////////
531 //#include "Connectors.mpp"
537 // comment-column: 40
538 // c-file-style: "senf"
539 // indent-tabs-mode: nil
540 // ispell-local-dictionary: "american"
541 // compile-command: "scons -u test"