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 inline non-template implementation */
27 #include <senf/Utils/TypeInfo.hh>
28 #include <senf/Utils/senfassert.hh>
31 #define prefix_ inline
32 ///////////////////////////////cci.p///////////////////////////////////////
34 #ifdef SENF_PPI_NOTRACE
35 # define SENF_PPI_THROTTLE_TRACE(label, type)
36 # define SENF_PPI_TRACE(packet, label)
38 # define SENF_PPI_THROTTLE_TRACE(label, type) throttleTrace(label, type)
39 # define SENF_PPI_TRACE(packet, label) trace(packet, label)
42 ///////////////////////////////////////////////////////////////////////////
43 // senf::ppi::connector::Connector
45 prefix_ senf::ppi::connector::Connector & senf::ppi::connector::Connector::peer()
48 // The connector is not connected
49 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
53 prefix_ senf::ppi::module::Module & senf::ppi::connector::Connector::module()
56 // The connector is not registered in the module -> probably a route() or noroute() statement is
58 SENF_ASSERT(module_, "Connector not registered: Missing route() or noroute()");
62 prefix_ void senf::ppi::connector::Connector::tracing(TraceState state)
67 prefix_ senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::tracing()
72 ////////////////////////////////////////
75 prefix_ senf::ppi::connector::Connector::Connector()
79 prefix_ senf::ppi::connector::Connector::~Connector()
82 Connector & peer (*peer_);
84 if (! peer.initializationScheduled())
85 peer.enqueueInitializable();
86 peer.v_disconnected();
90 prefix_ bool senf::ppi::connector::Connector::connected()
96 prefix_ void senf::ppi::connector::Connector::unregisterConnector()
99 module_->unregisterConnector(*this);
102 ////////////////////////////////////////
105 prefix_ void senf::ppi::connector::Connector::setModule(module::Module & module)
110 ///////////////////////////////////////////////////////////////////////////
111 // senf::ppi::connector::PassiveConnector
113 prefix_ senf::ppi::connector::ActiveConnector & senf::ppi::connector::PassiveConnector::peer()
116 return dynamic_cast<ActiveConnector&>(Connector::peer());
119 prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
122 return nativeThrottled_ || remoteThrottled_;
125 ////////////////////////////////////////
128 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
130 SENF_PPI_THROTTLE_TRACE("OUT", "throttle");
132 peer().notifyThrottle();
135 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
137 SENF_PPI_THROTTLE_TRACE("OUT", "unthrottle");
139 peer().notifyUnthrottle();
144 prefix_ void senf::ppi::connector::PassiveConnector::notifyThrottle()
147 remoteThrottled_ = true;
151 remoteThrottled_ = true;
154 prefix_ void senf::ppi::connector::PassiveConnector::registerRoute(ForwardingRoute & route)
156 routes_.push_back(&route);
159 prefix_ void senf::ppi::connector::PassiveConnector::unregisterRoute(ForwardingRoute & route)
161 Routes::iterator i (std::find(routes_.begin(), routes_.end(), &route));
162 if (i != routes_.end())
168 prefix_ bool senf::ppi::connector::PassiveConnector::nativeThrottled()
171 return nativeThrottled_;
174 prefix_ void senf::ppi::connector::PassiveConnector::throttle()
177 nativeThrottled_ = true;
180 nativeThrottled_ = true;
183 prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
185 if (throttled() && ! remoteThrottled_) {
186 nativeThrottled_ = false;
189 nativeThrottled_ = false;
193 ////////////////////////////////////////
196 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
197 : callback_(), remoteThrottled_(), nativeThrottled_()
200 prefix_ void senf::ppi::connector::PassiveConnector::emit()
202 // No event callback has been registered (onRequest() call missing)
203 SENF_ASSERT(callback_, "senf::ppi::connector::PassiveConnector: missing onRequest()");
207 SENF_PPI_THROTTLE_TRACE("IN ", "queueing packet");
211 ///////////////////////////////////////////////////////////////////////////
212 // senf::ppi::connector::ActiveConnector
214 prefix_ senf::ppi::connector::PassiveConnector & senf::ppi::connector::ActiveConnector::peer()
217 return dynamic_cast<PassiveConnector&>(Connector::peer());
220 prefix_ void senf::ppi::connector::ActiveConnector::onThrottle()
222 throttleCallback_ = Callback();
225 prefix_ void senf::ppi::connector::ActiveConnector::onUnthrottle()
227 unthrottleCallback_ = Callback();
230 prefix_ bool senf::ppi::connector::ActiveConnector::throttled()
233 return ! connected() || peer().throttled();
236 ////////////////////////////////////////
239 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
240 : throttleCallback_(), unthrottleCallback_(), notifyRoutes_(), throttled_(false)
243 ///////////////////////////////////////////////////////////////////////////
244 // senf::ppi::connector::InputConnector
246 prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
251 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
254 return dynamic_cast<OutputConnector &>(Connector::peer());
257 prefix_ senf::ppi::connector::InputConnector::queue_iterator
258 senf::ppi::connector::InputConnector::begin()
261 return queue_.begin();
264 prefix_ senf::ppi::connector::InputConnector::queue_iterator
265 senf::ppi::connector::InputConnector::end()
271 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
274 // Cannot peek() head of empty queue
275 SENF_ASSERT( ! queue_.empty(),
276 "senf::ppi::connector::InputConnector: cannot call peek() on empty queue" );
277 return queue_.back();
280 prefix_ senf::ppi::connector::InputConnector::size_type
281 senf::ppi::connector::InputConnector::queueSize()
284 return queue_.size();
287 prefix_ bool senf::ppi::connector::InputConnector::empty()
290 return queue_.empty();
293 ////////////////////////////////////////
296 prefix_ senf::ppi::connector::InputConnector::InputConnector()
299 ////////////////////////////////////////
302 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
304 queue_.push_front(p);
308 ///////////////////////////////////////////////////////////////////////////
309 // senf::ppi::connector::OutputConnector
311 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
314 return dynamic_cast<InputConnector&>(Connector::peer());
317 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet const & p)
319 SENF_PPI_TRACE(p, "OUT");
324 prefix_ void senf::ppi::connector::OutputConnector::write(Packet const & p)
329 ////////////////////////////////////////
332 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
335 ///////////////////////////////////////////////////////////////////////////
336 // senf::ppi::connector::GenericPassiveInput
338 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
339 : qdisc_(new ThresholdQueueing(1,0))
342 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
345 return dynamic_cast<GenericActiveOutput&>(Connector::peer());
348 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
354 ///////////////////////////////////////////////////////////////////////////
355 // senf::ppi::connector::GenericPassiveOutput
357 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
360 return dynamic_cast<GenericActiveInput&>(Connector::peer());
363 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
369 prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveInput & target)
371 Connector::connect(target);
374 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
377 ///////////////////////////////////////////////////////////////////////////
378 // senf::ppi::connector::GenericActiveInput
380 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
383 return dynamic_cast<GenericPassiveOutput&>(Connector::peer());
386 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
389 return ! empty() || (connected() && ! peer().throttled());
392 prefix_ void senf::ppi::connector::GenericActiveInput::request()
398 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
401 ///////////////////////////////////////////////////////////////////////////
402 // senf::ppi::connector::GenericActiveOutput
404 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
407 return dynamic_cast<GenericPassiveInput&>(Connector::peer());
410 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
413 return connected() && ! peer().throttled();
416 prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveInput & target)
418 Connector::connect(target);
421 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
424 ///////////////////////////////cci.e///////////////////////////////////////
431 // comment-column: 40
432 // c-file-style: "senf"
433 // indent-tabs-mode: nil
434 // ispell-local-dictionary: "american"
435 // compile-command: "scons -u test"