4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at
9 // http://senf.berlios.de/license.html
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
15 // Software distributed under the License is distributed on an "AS IS" basis,
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
17 // for the specific language governing rights and limitations under the License.
19 // The Original Code is Fraunhofer FOKUS code.
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
26 // Stefan Bund <g0dil@berlios.de>
29 \brief Connectors inline non-template implementation */
32 #include <senf/Utils/TypeInfo.hh>
33 #include <senf/Utils/senfassert.hh>
36 #define prefix_ inline
37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
39 #ifdef SENF_PPI_NOTRACE
40 # define SENF_PPI_THROTTLE_TRACE(label, type)
41 # define SENF_PPI_TRACE(packet, label)
43 # define SENF_PPI_THROTTLE_TRACE(label, type) throttleTrace(label, type)
44 # define SENF_PPI_TRACE(packet, label) trace(packet, label)
47 //-/////////////////////////////////////////////////////////////////////////////////////////////////
48 // senf::ppi::connector::Connector
50 prefix_ senf::ppi::connector::Connector & senf::ppi::connector::Connector::peer()
53 // The connector is not connected
54 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
58 prefix_ senf::ppi::module::Module & senf::ppi::connector::Connector::module()
61 // The connector is not registered in the module -> probably a route() or noroute() statement is
63 SENF_ASSERT(module_, "Connector not registered: Missing route() or noroute()");
67 prefix_ void senf::ppi::connector::Connector::tracing(TraceState state)
72 prefix_ senf::ppi::connector::Connector::TraceState senf::ppi::connector::Connector::tracing()
77 //-/////////////////////////////////////////////////////////////////////////////////////////////////
80 prefix_ senf::ppi::connector::Connector::Connector()
84 prefix_ bool senf::ppi::connector::Connector::connected()
90 //-/////////////////////////////////////////////////////////////////////////////////////////////////
91 // senf::ppi::connector::PassiveConnector
93 prefix_ senf::ppi::connector::ActiveConnector & senf::ppi::connector::PassiveConnector::peer()
96 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
100 prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
103 return nativeThrottled_ || remoteThrottled_;
106 //-/////////////////////////////////////////////////////////////////////////////////////////////////
109 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
111 SENF_PPI_THROTTLE_TRACE("OUT", "throttle");
113 peer().notifyThrottle();
116 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
118 SENF_PPI_THROTTLE_TRACE("OUT", "unthrottle");
120 peer().notifyUnthrottle();
125 prefix_ void senf::ppi::connector::PassiveConnector::notifyThrottle()
128 remoteThrottled_ = true;
132 remoteThrottled_ = true;
137 prefix_ bool senf::ppi::connector::PassiveConnector::nativeThrottled()
140 return nativeThrottled_;
143 prefix_ void senf::ppi::connector::PassiveConnector::throttle()
146 nativeThrottled_ = true;
149 nativeThrottled_ = true;
152 prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
154 if (throttled() && ! remoteThrottled_) {
155 nativeThrottled_ = false;
158 nativeThrottled_ = false;
162 //-/////////////////////////////////////////////////////////////////////////////////////////////////
165 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
166 : callback_(), remoteThrottled_(), nativeThrottled_()
169 prefix_ void senf::ppi::connector::PassiveConnector::emit()
171 // No event callback has been registered (onRequest() call missing)
172 SENF_ASSERT(callback_, "senf::ppi::connector::PassiveConnector: missing onRequest()");
176 SENF_PPI_THROTTLE_TRACE("IN ", "queueing packet");
180 //-/////////////////////////////////////////////////////////////////////////////////////////////////
181 // senf::ppi::connector::ActiveConnector
183 prefix_ senf::ppi::connector::PassiveConnector & senf::ppi::connector::ActiveConnector::peer()
186 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
190 prefix_ void senf::ppi::connector::ActiveConnector::onThrottle()
192 throttleCallback_ = Callback();
195 prefix_ void senf::ppi::connector::ActiveConnector::onUnthrottle()
197 unthrottleCallback_ = Callback();
200 prefix_ bool senf::ppi::connector::ActiveConnector::throttled()
203 return ! connected() || peer().throttled();
206 //-/////////////////////////////////////////////////////////////////////////////////////////////////
209 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
210 : throttleCallback_(), unthrottleCallback_(), notifyRoutes_(), throttled_(false)
213 //-/////////////////////////////////////////////////////////////////////////////////////////////////
214 // senf::ppi::connector::InputConnector
216 prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
221 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
224 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
228 prefix_ senf::ppi::connector::InputConnector::queue_iterator
229 senf::ppi::connector::InputConnector::begin()
232 return queue_.begin();
235 prefix_ senf::ppi::connector::InputConnector::queue_iterator
236 senf::ppi::connector::InputConnector::end()
242 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
245 // Cannot peek() head of empty queue
246 SENF_ASSERT( ! queue_.empty(),
247 "senf::ppi::connector::InputConnector: cannot call peek() on empty queue" );
248 return queue_.back();
251 prefix_ senf::ppi::connector::InputConnector::size_type
252 senf::ppi::connector::InputConnector::queueSize()
255 return queue_.size();
258 prefix_ bool senf::ppi::connector::InputConnector::empty()
261 return queue_.empty();
264 //-/////////////////////////////////////////////////////////////////////////////////////////////////
267 prefix_ senf::ppi::connector::InputConnector::InputConnector()
270 //-/////////////////////////////////////////////////////////////////////////////////////////////////
273 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
275 queue_.push_front(p);
279 //-/////////////////////////////////////////////////////////////////////////////////////////////////
280 // senf::ppi::connector::OutputConnector
282 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
285 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
289 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet const & p)
291 SENF_PPI_TRACE(p, "OUT");
296 prefix_ void senf::ppi::connector::OutputConnector::write(Packet const & p)
301 //-/////////////////////////////////////////////////////////////////////////////////////////////////
304 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
307 //-/////////////////////////////////////////////////////////////////////////////////////////////////
308 // senf::ppi::connector::GenericPassiveInput
310 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
311 : qdisc_(new ThresholdQueueing(1,0))
314 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
317 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
321 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
327 //-/////////////////////////////////////////////////////////////////////////////////////////////////
328 // senf::ppi::connector::GenericPassiveOutput
330 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
333 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
337 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
343 prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveInput & target)
345 Connector::connect(target);
348 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
351 //-/////////////////////////////////////////////////////////////////////////////////////////////////
352 // senf::ppi::connector::GenericActiveInput
354 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
357 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
361 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
364 return ! empty() || (connected() && ! peer().throttled());
367 prefix_ void senf::ppi::connector::GenericActiveInput::request()
373 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
376 //-/////////////////////////////////////////////////////////////////////////////////////////////////
377 // senf::ppi::connector::GenericActiveOutput
379 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
382 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
386 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
389 return connected() && ! peer().throttled();
392 prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveInput & target)
394 Connector::connect(target);
397 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
400 //-/////////////////////////////////////////////////////////////////////////////////////////////////
407 // comment-column: 40
408 // c-file-style: "senf"
409 // indent-tabs-mode: nil
410 // ispell-local-dictionary: "american"
411 // compile-command: "scons -u test"