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_ bool senf::ppi::connector::Connector::connected()
85 ///////////////////////////////////////////////////////////////////////////
86 // senf::ppi::connector::PassiveConnector
88 prefix_ senf::ppi::connector::ActiveConnector & senf::ppi::connector::PassiveConnector::peer()
91 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
95 prefix_ bool senf::ppi::connector::PassiveConnector::throttled()
98 return nativeThrottled_ || remoteThrottled_;
101 ////////////////////////////////////////
104 prefix_ void senf::ppi::connector::PassiveConnector::emitThrottle()
106 SENF_PPI_THROTTLE_TRACE("OUT", "throttle");
108 peer().notifyThrottle();
111 prefix_ void senf::ppi::connector::PassiveConnector::emitUnthrottle()
113 SENF_PPI_THROTTLE_TRACE("OUT", "unthrottle");
115 peer().notifyUnthrottle();
120 prefix_ void senf::ppi::connector::PassiveConnector::notifyThrottle()
123 remoteThrottled_ = true;
127 remoteThrottled_ = true;
132 prefix_ bool senf::ppi::connector::PassiveConnector::nativeThrottled()
135 return nativeThrottled_;
138 prefix_ void senf::ppi::connector::PassiveConnector::throttle()
141 nativeThrottled_ = true;
144 nativeThrottled_ = true;
147 prefix_ void senf::ppi::connector::PassiveConnector::unthrottle()
149 if (throttled() && ! remoteThrottled_) {
150 nativeThrottled_ = false;
153 nativeThrottled_ = false;
157 ////////////////////////////////////////
160 prefix_ senf::ppi::connector::PassiveConnector::PassiveConnector()
161 : callback_(), remoteThrottled_(), nativeThrottled_()
164 prefix_ void senf::ppi::connector::PassiveConnector::emit()
166 // No event callback has been registered (onRequest() call missing)
167 SENF_ASSERT(callback_, "senf::ppi::connector::PassiveConnector: missing onRequest()");
171 SENF_PPI_THROTTLE_TRACE("IN ", "queueing packet");
175 ///////////////////////////////////////////////////////////////////////////
176 // senf::ppi::connector::ActiveConnector
178 prefix_ senf::ppi::connector::PassiveConnector & senf::ppi::connector::ActiveConnector::peer()
181 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
185 prefix_ void senf::ppi::connector::ActiveConnector::onThrottle()
187 throttleCallback_ = Callback();
190 prefix_ void senf::ppi::connector::ActiveConnector::onUnthrottle()
192 unthrottleCallback_ = Callback();
195 prefix_ bool senf::ppi::connector::ActiveConnector::throttled()
198 return ! connected() || peer().throttled();
201 ////////////////////////////////////////
204 prefix_ senf::ppi::connector::ActiveConnector::ActiveConnector()
205 : throttleCallback_(), unthrottleCallback_(), notifyRoutes_(), throttled_(false)
208 ///////////////////////////////////////////////////////////////////////////
209 // senf::ppi::connector::InputConnector
211 prefix_ senf::Packet senf::ppi::connector::InputConnector::read()
216 prefix_ senf::ppi::connector::OutputConnector & senf::ppi::connector::InputConnector::peer()
219 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
223 prefix_ senf::ppi::connector::InputConnector::queue_iterator
224 senf::ppi::connector::InputConnector::begin()
227 return queue_.begin();
230 prefix_ senf::ppi::connector::InputConnector::queue_iterator
231 senf::ppi::connector::InputConnector::end()
237 prefix_ senf::Packet senf::ppi::connector::InputConnector::peek()
240 // Cannot peek() head of empty queue
241 SENF_ASSERT( ! queue_.empty(),
242 "senf::ppi::connector::InputConnector: cannot call peek() on empty queue" );
243 return queue_.back();
246 prefix_ senf::ppi::connector::InputConnector::size_type
247 senf::ppi::connector::InputConnector::queueSize()
250 return queue_.size();
253 prefix_ bool senf::ppi::connector::InputConnector::empty()
256 return queue_.empty();
259 ////////////////////////////////////////
262 prefix_ senf::ppi::connector::InputConnector::InputConnector()
265 ////////////////////////////////////////
268 prefix_ void senf::ppi::connector::InputConnector::enqueue(Packet const & p)
270 queue_.push_front(p);
274 ///////////////////////////////////////////////////////////////////////////
275 // senf::ppi::connector::OutputConnector
277 prefix_ senf::ppi::connector::InputConnector & senf::ppi::connector::OutputConnector::peer()
280 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
284 prefix_ void senf::ppi::connector::OutputConnector::operator()(Packet const & p)
286 SENF_PPI_TRACE(p, "OUT");
291 prefix_ void senf::ppi::connector::OutputConnector::write(Packet const & p)
296 ////////////////////////////////////////
299 prefix_ senf::ppi::connector::OutputConnector::OutputConnector()
302 ///////////////////////////////////////////////////////////////////////////
303 // senf::ppi::connector::GenericPassiveInput
305 prefix_ senf::ppi::connector::GenericPassiveInput::GenericPassiveInput()
306 : qdisc_(new ThresholdQueueing(1,0))
309 prefix_ senf::ppi::connector::GenericActiveOutput & senf::ppi::connector::GenericPassiveInput::peer()
312 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
316 prefix_ bool senf::ppi::connector::GenericPassiveInput::boolean_test()
322 ///////////////////////////////////////////////////////////////////////////
323 // senf::ppi::connector::GenericPassiveOutput
325 prefix_ senf::ppi::connector::GenericActiveInput & senf::ppi::connector::GenericPassiveOutput::peer()
328 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
332 prefix_ bool senf::ppi::connector::GenericPassiveOutput::boolean_test()
338 prefix_ void senf::ppi::connector::GenericPassiveOutput::connect(GenericActiveInput & target)
340 Connector::connect(target);
343 prefix_ senf::ppi::connector::GenericPassiveOutput::GenericPassiveOutput()
346 ///////////////////////////////////////////////////////////////////////////
347 // senf::ppi::connector::GenericActiveInput
349 prefix_ senf::ppi::connector::GenericPassiveOutput & senf::ppi::connector::GenericActiveInput::peer()
352 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
356 prefix_ bool senf::ppi::connector::GenericActiveInput::boolean_test()
359 return ! empty() || (connected() && ! peer().throttled());
362 prefix_ void senf::ppi::connector::GenericActiveInput::request()
368 prefix_ senf::ppi::connector::GenericActiveInput::GenericActiveInput()
371 ///////////////////////////////////////////////////////////////////////////
372 // senf::ppi::connector::GenericActiveOutput
374 prefix_ senf::ppi::connector::GenericPassiveInput & senf::ppi::connector::GenericActiveOutput::peer()
377 SENF_ASSERT(peer_, "senf::ppi::connect() call missing");
381 prefix_ bool senf::ppi::connector::GenericActiveOutput::boolean_test()
384 return connected() && ! peer().throttled();
387 prefix_ void senf::ppi::connector::GenericActiveOutput::connect(GenericPassiveInput & target)
389 Connector::connect(target);
392 prefix_ senf::ppi::connector::GenericActiveOutput::GenericActiveOutput()
395 ///////////////////////////////cci.e///////////////////////////////////////
402 // comment-column: 40
403 // c-file-style: "senf"
404 // indent-tabs-mode: nil
405 // ispell-local-dictionary: "american"
406 // compile-command: "scons -u test"