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 PassiveQueue public header */
31 #ifndef HH_SENF_PPI_PassiveQueue_
32 #define HH_SENF_PPI_PassiveQueue_ 1
35 #include "Connectors.hh"
39 //#include "PassiveQueue.mpp"
40 //-/////////////////////////////////////////////////////////////////////////////////////////////////
46 /** \brief Adaptor to connect active a pair of active connectors.
48 This adaptor queue is used to connect two active connectors to each other. The queue
49 receives data in it's passive input and places them in it's queue. Whenever data is
50 requested from the passive output, a packet is dequeued.
52 The PassiveQueue will automatically throttle in both directions. Throttling on the input
53 connector is the standard throttling as implemented in
54 connector::PassiveInput<>. Additional forward throttling notifications are sent out
55 whenever the queue is empty.
57 \ingroup adapter_modules
60 : public module::Module
62 SENF_PPI_MODULE(PassiveQueue);
64 connector::PassiveInput<> input;
65 connector::PassiveOutput<> output;
69 template <class QDiscipline>
70 void qdisc(QDiscipline const & disc); ///< Change the queueing discipline
71 /**< This call changes the queueing discipline of the
72 queue. This call is just forwarded to the \a input
75 \see connector::GenericPassiveInput::qdisc() */
78 virtual void v_init();
86 //-/////////////////////////////////////////////////////////////////////////////////////////////////
87 #include "PassiveQueue.cci"
88 //#include "PassiveQueue.ct"
89 #include "PassiveQueue.cti"
96 // c-file-style: "senf"
97 // indent-tabs-mode: nil
98 // ispell-local-dictionary: "american"
99 // compile-command: "scons -u test"
100 // comment-column: 40