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"
32 #include "ModuleManager.hh"
33 #include <senf/Utils/Console/Console.hh>
35 //#include "Connectors.mpp"
37 ///////////////////////////////cc.p////////////////////////////////////////
39 ///////////////////////////////////////////////////////////////////////////
40 // senf::ppi::connector::Connector
42 prefix_ void senf::ppi::connector::Connector::connect(Connector & target)
44 // The connector is not registered -> route() or noroute() statement missing
45 SENF_ASSERT( module_ &&
46 "senf::ppi::connector::Connector::connect(): (source) "
47 "Missing route() or noroute()" );
48 // The connector is already connected
49 SENF_ASSERT( ! peer_ &&
50 "senf::ppi::connector::Connector::connect(): (source) "
51 "duplicate connection" );
52 // The target connector is not registered -> route() or noroute() statement missing
53 SENF_ASSERT( target.module_ &&
54 "senf::ppi::connector::Connector::connect(): (target) "
55 "Missing route() or noroute()" );
56 // The target connector is already connected
57 SENF_ASSERT( ! target.peer_ &&
58 "senf::ppi::connector::Connector::connect(): (target) "
59 "duplicate connection" );
60 if (! (packetTypeID() == typeid(void) ||
61 target.packetTypeID() == typeid(void) ||
62 packetTypeID() == target.packetTypeID()) )
63 throw IncompatibleConnectorsException()
64 << ": " << prettyName(packetTypeID())
65 << " [in module " << prettyName(typeid(*module_)) << "] "
66 << ", " << prettyName(target.packetTypeID())
67 << " [in module " << prettyName(typeid(*target.module_)) << "]";
72 if (! initializationScheduled())
73 enqueueInitializable();
74 if (! peer().initializationScheduled())
75 peer().enqueueInitializable();
78 senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::traceState_ (
79 senf::ppi::connector::Connector::NO_TRACING);
81 prefix_ void senf::ppi::connector::Connector::trace(Packet const & p, char const * label)
83 if (traceState_ == NO_TRACING)
86 std::string type (prettyName(p.typeId().id()));
87 log << "PPI packet trace: " << label << " 0x" << std::hex << p.id() << " "
88 << type.substr(21, type.size()-22) << " on " << & module() << " "
89 << prettyName(typeid(module())) << " connector 0x" << this << "\n";
90 if (traceState_ == TRACE_CONTENTS)
95 prefix_ void senf::ppi::connector::Connector::throttleTrace(char const * label,
98 if (traceState_ == NO_TRACING)
101 log << "PPI throttling trace: " << label << " " << type << " on " << & module()
102 << " " << prettyName(typeid(module())) << " connector 0x" << this << "\n";
106 namespace senf { namespace ppi { namespace connector {
108 SENF_CONSOLE_REGISTER_ENUM_MEMBER(
109 Connector, TraceState, (NO_TRACING)(TRACE_IDS)(TRACE_CONTENTS) );
115 struct ConsoleRegister
120 ConsoleRegister::ConsoleRegister()
122 senf::ppi::ModuleManager::instance().consoleDir()
123 .add("tracing", SENF_FNP(senf::ppi::connector::Connector::TraceState,
124 senf::ppi::connector::Connector::tracing, ()))
125 .doc("Log every packet sent or received by any module.\n"
126 "There are three different tracing levels:\n"
128 " NO_TRACING don't output any tracing information\n"
129 " TRACE_IDS trace packet id's but do not show packet contents\n"
130 " TRACE_CONTENTS trace complete packet contents\n"
132 "A log message is generated whenever the packet traverses a connector. The\n"
133 "TRACE_IDS log message has the following format:\n"
135 " PPI packet trace: <direction> <packet-id> <packet-type>\n"
136 " on <module-id> <module-type> connector <connector-id>\n"
137 " PPI throttling trace: <direction> <throttle-msg>\n"
138 " on <module-id> <module-type> connector <connector-id>\n"
142 " direction 'IN' for packets/throttle notifications entering the module,\n"
143 " 'OUT' for packets/throttle notifications leaving it\n"
144 " packet-id Numeric unique packet id. This value is unique for packets\n"
145 " alive at the same time, packets at different times may (and\n"
146 " will) share id's\n"
147 " packet-type The type of the packet header\n"
148 " module-id Unique module id\n"
149 " module-type Type of the module the packet is sent to/from\n"
150 " connector-id Unique connector id\n"
151 " throttle-msg Type of throttling event\n");
153 senf::ppi::ModuleManager::instance().consoleDir()
154 .add("tracing", SENF_FNP(void, senf::ppi::connector::Connector::tracing,
155 (senf::ppi::connector::Connector::TraceState)))
156 .arg("state", "new tracing state");
159 ConsoleRegister consoleRegister;
163 prefix_ void senf::ppi::connector::Connector::disconnect()
165 // Cannot disconnected a non-connected connector
166 SENF_ASSERT( peer_ &&
167 "senf::ppi::connector::Connector::disconnect(): Not connected" );
169 Connector & peer (*peer_);
173 if (! initializationScheduled())
174 enqueueInitializable();
175 if (! peer.initializationScheduled())
176 peer.enqueueInitializable();
179 peer.v_disconnected();
182 prefix_ std::type_info const & senf::ppi::connector::Connector::packetTypeID()
187 prefix_ void senf::ppi::connector::Connector::v_disconnected()
191 ///////////////////////////////////////////////////////////////////////////
192 // senf::ppi::connector::PassiveConnector
194 ////////////////////////////////////////
197 prefix_ void senf::ppi::connector::PassiveConnector::v_init()
199 Routes::const_iterator i (routes_.begin());
200 Routes::const_iterator const i_end (routes_.end());
201 for (; i != i_end; ++i)
202 if ((*i)->throttled())
205 remoteThrottled_ = false;
212 prefix_ void senf::ppi::connector::PassiveConnector::v_unthrottleEvent()
215 prefix_ void senf::ppi::connector::PassiveConnector::notifyUnthrottle()
217 if (std::find_if(routes_.begin(), routes_.end(),
218 boost::bind(&ForwardingRoute::throttled, _1)) == routes_.end()) {
219 remoteThrottled_ = false;
220 if (!nativeThrottled_)
223 throttleTrace("OUT", "not forwarding unthrottle event");
226 ///////////////////////////////////////////////////////////////////////////
227 // senf::ppi::connector::ActiveConnector
229 ////////////////////////////////////////
232 prefix_ void senf::ppi::connector::ActiveConnector::v_init()
238 prefix_ void senf::ppi::connector::ActiveConnector::notifyThrottle()
240 throttleTrace("IN ", "throttle");
243 if (throttleCallback_)
245 NotifyRoutes::const_iterator i (notifyRoutes_.begin());
246 NotifyRoutes::const_iterator const i_end (notifyRoutes_.end());
247 for (; i != i_end; ++i)
248 (*i)->notifyThrottle();
252 prefix_ void senf::ppi::connector::ActiveConnector::notifyUnthrottle()
254 throttleTrace("IN ", "unthrottle");
257 if (unthrottleCallback_)
258 unthrottleCallback_();
259 NotifyRoutes::const_iterator i (notifyRoutes_.begin());
260 NotifyRoutes::const_iterator const i_end (notifyRoutes_.end());
261 for (; i != i_end; ++i)
262 (*i)->notifyUnthrottle();
266 prefix_ void senf::ppi::connector::ActiveConnector::registerRoute(ForwardingRoute & route)
268 notifyRoutes_.push_back(&route);
271 prefix_ void senf::ppi::connector::ActiveConnector::unregisterRoute(ForwardingRoute & route)
273 NotifyRoutes::iterator i (std::find(notifyRoutes_.begin(), notifyRoutes_.end(), &route));
274 if (i != notifyRoutes_.end())
275 notifyRoutes_.erase(i);
278 ///////////////////////////////////////////////////////////////////////////
279 // senf::ppi::connector::InputConnector
281 prefix_ senf::Packet senf::ppi::connector::InputConnector::operator()()
295 ////////////////////////////////////////
298 prefix_ void senf::ppi::connector::InputConnector::v_requestEvent()
301 prefix_ void senf::ppi::connector::InputConnector::v_enqueueEvent()
304 prefix_ void senf::ppi::connector::InputConnector::v_dequeueEvent()
307 ///////////////////////////////////////////////////////////////////////////
308 // senf::ppi::connector::GenericActiveInput
310 ////////////////////////////////////////
313 prefix_ void senf::ppi::connector::GenericActiveInput::v_requestEvent()
318 ///////////////////////////////////////////////////////////////////////////
319 // senf::ppi::connector::GenericPassiveInput
321 ////////////////////////////////////////
324 prefix_ void senf::ppi::connector::GenericPassiveInput::v_enqueueEvent()
327 qdisc_->update(*this, QueueingDiscipline::ENQUEUE);
330 prefix_ void senf::ppi::connector::GenericPassiveInput::v_dequeueEvent()
332 qdisc_->update(*this, QueueingDiscipline::DEQUEUE);
335 prefix_ void senf::ppi::connector::GenericPassiveInput::v_unthrottleEvent()
337 size_type n (queueSize());
340 size_type nn (queueSize());
347 ///////////////////////////////cc.e////////////////////////////////////////
349 //#include "Connectors.mpp"
355 // comment-column: 40
356 // c-file-style: "senf"
357 // indent-tabs-mode: nil
358 // ispell-local-dictionary: "american"
359 // compile-command: "scons -u test"