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 public header */
26 #ifndef HH_SENF_PPI_Connectors_
27 #define HH_SENF_PPI_Connectors_ 1
31 #include <boost/utility.hpp>
32 #include <boost/scoped_ptr.hpp>
33 #include <senf/Utils/safe_bool.hh>
34 #include <senf/Utils/Exception.hh>
35 #include <senf/Packets/Packets.hh>
37 #include "detail/Callback.hh"
38 #include "Queueing.hh"
39 #include "ModuleManager.hh"
41 //#include "Connectors.mpp"
42 ///////////////////////////////hh.p////////////////////////////////////////
48 /** \namespace senf::ppi::connector
49 \brief Connector classes
51 A connector has three independent properties
52 \li it may be \e active or \e passive
53 \li it may be an \e input or an \e output
54 \li it has an (optional) packet type
56 \e Active connectors are activated from within the module, \e passive connectors are
57 signaled by the external framework. \e Input connectors receive packets, \e output
58 connectors send packets.
60 All passive connectors call some onRequest callback whenever I/O needs to be performed. All
61 input connectors possess a packet queue.
63 We therefore have 4 connector types each of which is parameterized by the type of packet
64 traversing the connector:
65 \li senf::ppi::connector::ActiveInput
66 \li senf::ppi::connector::ActiveOutput
67 \li senf::ppi::connector::PassiveInput
68 \li senf::ppi::connector::PassiveOutput.
70 Connectors are declared as module data members and are then externally connected to other
73 The connectors each take an optional template argument. If this argument is specified, it
74 must be the type of packet expected or sent on this connector. If it is not specified,
75 packets will be passed using the generic Packet handle.
78 class IpFilter : public senf::ppi::module::Module
80 SENF_PPI_MODULE(SomeModule);
83 senf::ppi::connector::ActiveInput<senf::EthernetPacket> input;
84 senf::ppi::connector::PassiveOutput<senf::IpPacket> output;
88 input.onRequest(&IpFilter::onRequest);
93 // 'input()' will return a senf::EthernetPacket packet handle
94 try { output( input().find<senf::IpPacket>() ); }
95 catch (senf::InvalidPacketChainException & ex) { ; }
101 \section ppi_jacks Jacks
103 A Jack is a packet type aware and possibly packet type converting reference to an arbitrary
104 connector of the same type. Jacks are used in groups to indirectly declare the input's and
111 senf::ppi::module::PassiveQueue queue;
112 senf::ppi::module::RateAnalyzer analyzer;
115 senf::ppi::connector::ActiveInputJack<senf::EthernetPacket> input;
116 senf::ppi::connector::ActiveOutputJack<senf::EthernetPacket> output;
119 : queue (), analyzer (), input (queue.input), output (analyzer.output)
121 senf::ppi::connect(queue, analyzer);
126 The jacks are initialized by passing an arbitrary compatible connector to the jack
127 constructor. A connector is compatible, if
128 \li It has the same input/output active/passive specification
129 \li Either the Jack or the Connector are generic (senf::Packet) or Jack and Connector have
132 Jacks can be used wherever connectors may be used. Jacks may be defined anywhere, not only
133 in modules. It is however important to ensure that the lifetime of the jack does not exceed
134 the lifetime of the referenced connector.
137 senf::ppi::module::Module \n
138 senf::ppi::connect() \n
142 /** \brief Incompatible connectors connected
144 This exception is thrown, when two incompatible connectors are connected. This happens if
145 both connectors of a senf::ppi::connect() statement declare a packet type (the connector
146 template argument) but they don't declare the same packet type.
148 You need to ensure, that both connectors use the same packet type.
150 \see senf::ppi::connect()
152 struct IncompatibleConnectorsException : public senf::Exception
153 { IncompatibleConnectorsException() : senf::Exception("Incompatible connectors") {} };
155 /** \brief Connector base-class
157 This connector provides access to the generic connector facilities. This includes the
158 connection management (access to the connected peer) and the containment management (access
159 to the containing module)
162 : ModuleManager::Initializable, boost::noncopyable
164 SENF_LOG_CLASS_AREA();
165 SENF_LOG_DEFAULT_LEVEL(senf::log::NOTICE);
167 Connector & peer() const; ///< Get peer connected to this connector
168 module::Module & module() const; ///< Get this connectors containing module
170 bool connected() const; ///< \c true, if connector connected, \c false otherwise
172 void disconnect(); ///< Disconnect connector from peer
174 enum TraceState { NO_TRACING, TRACE_IDS, TRACE_CONTENTS };
176 static void tracing(TraceState state);
177 static TraceState tracing();
181 virtual ~Connector();
183 void connect(Connector & target);
185 void trace(Packet const & p, char const * label);
186 void throttleTrace(char const * label, char const * type);
188 void unregisterConnector();
191 virtual std::type_info const & packetTypeID();
193 virtual void v_disconnected() const;
195 void setModule(module::Module & module);
198 module::Module * module_;
200 static TraceState traceState_;
202 friend class module::Module;
205 /** \brief Passive connector base-class
207 A passive connector is a connector which is activated externally whenever an I/O request
208 occurs. Passive connectors are the origin of throttling notifications. Depending on the type
209 of connector (output or input) the respective throttling is called forward or backward
212 Passive connectors always handle two throttling states:
214 - The \e native throttling state is set manually by the module. It is the throttling state
215 originating in the current module
216 - The \e forwarded throttling state is the state as it is received by throttling
219 The accumulative throttling state is generated by combining all sub-states.
221 class PassiveConnector
222 : public virtual Connector
227 template <class Handler>
228 void onRequest(Handler handler);///< Register I/O event handler
229 /**< The registered handler will be called, whenever packets
230 arrive or should be generated by the module depending
231 on the connector type (input or output). The \a handler
232 argument is either an arbitrary callable object or it
233 is a pointer-to-member to a member of the class which
234 holds this input. In the second case, the pointer will
235 automatically be bound to the containing instance.
237 \param[in] handler Handler to call, whenever an I/O
238 operation is to be performed. */
241 bool throttled() const; ///< Get accumulative throttling state
242 bool nativeThrottled() const; ///< Get native throttling state
244 void throttle(); ///< Set native throttling
245 void unthrottle(); ///< Revoke native throttling
247 ActiveConnector & peer() const;
255 virtual void v_init();
257 // Called by the routing to change the throttling state from forwarding routes
258 void notifyThrottle(); ///< Forward a throttle notification to this connector
259 void notifyUnthrottle(); ///< Forward an unthrottle notification to this connector
261 // Internal members to emit throttling notifications to the connected peer
263 void emitUnthrottle();
265 // Called after unthrottling the connector
266 virtual void v_unthrottleEvent();
268 // called by ForwardingRoute to register a new route
269 void registerRoute(ForwardingRoute & route);
270 void unregisterRoute(ForwardingRoute & route);
272 typedef ppi::detail::Callback<>::type Callback;
275 bool remoteThrottled_;
276 bool nativeThrottled_;
278 typedef std::vector<ForwardingRoute*> Routes;
281 friend class senf::ppi::ForwardingRoute;
284 /** \brief Active connector base-class
286 An active connector is a connector which emits I/O requests. Active connectors receive
287 throttling notifications. Depending on the type of connector (input or output) the
288 respective throttling is called forward or backward throttling.
290 Active connectors do not handle any throttling state, they just receive the
291 notifications. These notifications should then either be processed by the module or be
292 forwarded to other connectors.
294 class ActiveConnector
295 : public virtual Connector
297 typedef ppi::detail::Callback<>::type Callback;
301 template <class Handler>
302 void onThrottle(Handler handler); ///< Register throttle notification handler
303 /**< The handler register here will be called, whenever a
304 throttle notification comes in. The \a handler argument
305 is either an arbitrary callable object or it is a
306 pointer-to-member to a member of the class which holds
307 this input. In the second case, the pointer will
308 automatically be bound to the containing instance.
310 \param[in] handler Handler to call on throttle
312 void onThrottle(); ///< Clear throttle notification handler
314 template <class Handler>
315 void onUnthrottle(Handler handler); ///< Register unthrottle notification handler
316 /**< The handler register here will be called, whenever an
317 unthrottle notification comes in. The \a handler
318 argument is either an arbitrary callable object or it
319 is a pointer-to-member to a member of the class which
320 holds this input. In the second case, the pointer will
321 automatically be bound to the containing instance.
323 \param[in] handler Handler to call on unthrottle
325 void onUnthrottle(); ///< Clear unthrottle notification handler
327 bool throttled() const; ///< \c true, if peer() is throttled
329 PassiveConnector & peer() const;
335 virtual void v_init();
337 // called by the peer() to forward throttling notifications
338 void notifyThrottle();
339 void notifyUnthrottle();
341 // called by ForwardingRoute to register a new route
342 void registerRoute(ForwardingRoute & route);
343 void unregisterRoute(ForwardingRoute & route);
345 Callback throttleCallback_;
346 Callback unthrottleCallback_;
348 typedef std::vector<ForwardingRoute*> NotifyRoutes;
349 NotifyRoutes notifyRoutes_;
353 friend class senf::ppi::ForwardingRoute;
354 friend class PassiveConnector;
357 /** \brief Input connector base-class
359 An input connector receives packets. It may be either an ActiveConnector or a
360 PassiveConnector. An input connector contains a packet queue. This queue enables processing
361 packets in batches or generating multiple output packets from a single input packet. The
362 queues have the potential to greatly simplify the module implementations.
364 \implementation Which container to use?
365 \li list has good insertion and deletion properties on both ends but it costs a dynamic
366 memory allocation for every insertion. A very good property is, that iterators stay
367 valid across insertions/deletions
368 \li vector is fast and has good amortized dynamic allocation properties. However, it is
369 quite unusable as a queue
370 \li deque has comparable dynamic allocation properties as vector but also has good
371 insertion/removal properties on both ends.
373 So probably we will use a deque. I'd like a container which keeps iterators intact on
374 insertion/deletion but I believe that list is just to expensive since every packet will
375 be added to the queue before it can be processed.
378 : public virtual Connector
380 typedef std::deque<Packet> Queue;
382 typedef Queue::const_iterator queue_iterator; ///< Iterator type of the embedded queue
383 typedef Queue::size_type size_type; ///< Unsigned type for counting queue elements
386 Packet operator()(); ///< Get a packet
387 /**< This member is the primary method to access received
388 data. On passive connectors, this operator will just
389 dequeue a packet from the packet queue. If the
390 connector is active, the connector will request new
391 packets from the connected module. If the packet
392 request cannot be fulfilled an in-valid Packet is
395 Packet read(); ///< Alias for operator()()
397 OutputConnector & peer() const;
399 queue_iterator begin() const; ///< Access queue begin (head)
400 queue_iterator end() const; ///< Access queue past-the-end (tail)
401 Packet peek() const; ///< Return head element from the queue
403 size_type queueSize() const; ///< Return number of elements in the queue
404 bool empty() const; ///< Return queueSize() == 0
410 void enqueue(Packet const & p);
412 virtual void v_requestEvent();
413 virtual void v_enqueueEvent();
414 virtual void v_dequeueEvent();
418 friend class OutputConnector;
421 /** \brief Output connector base-class
423 An output connector sends out packets. It may be either an ActiveConnector or a
424 PassiveConnector. An output connector does \e not have an built-in queueing, it relies on
425 the queueing of the connected input.
427 class OutputConnector
428 : public virtual Connector
431 void operator()(Packet const & p); ///< Send out a packet
433 void write(Packet const & p); ///< Alias for operator()(Packet p)
435 InputConnector & peer() const;
441 /** \brief Combination of PassiveConnector and InputConnector
443 The GenericPassiveInput automatically controls the connectors throttling state using a
444 queueing discipline. The standard queueing discipline is ThresholdQueueing, which throttles
445 the connection whenever the queue length reaches the high threshold and unthrottles the
446 connection when the queue reaches the low threshold. The default queueing discipline is
447 <tt>ThresholdQueueing(1,0)</tt> which will throttle the input whenever the queue is
450 class GenericPassiveInput
451 : public PassiveConnector, public InputConnector,
452 public safe_bool<GenericPassiveInput>
455 GenericActiveOutput & peer() const;
457 bool boolean_test() const; ///< \c true, if ! empty()
459 template <class QDisc>
460 void qdisc(QDisc const & disc); ///< Change the queueing discipline
461 /**< The queueing discipline is a class which provides the
462 QueueingDiscipline interface.
464 \param[in] disc New queueing discipline */
465 void qdisc(QueueingDiscipline::None_t);
466 ///< Disable queueing discipline
470 GenericPassiveInput();
473 void v_enqueueEvent();
474 void v_dequeueEvent();
475 void v_unthrottleEvent();
477 boost::scoped_ptr<QueueingDiscipline> qdisc_;
480 /** \brief Combination of PassiveConnector and OutputConnector
482 class GenericPassiveOutput
483 : public PassiveConnector, public OutputConnector,
484 public safe_bool<GenericPassiveOutput>
487 GenericActiveInput & peer() const;
489 bool boolean_test() const; ///< Always \c true
491 void connect(GenericActiveInput & target); ///< Internal: Use senf::ppi::connect() instead
493 friend class GenericActiveInput;
496 GenericPassiveOutput();
500 /** \brief Combination of ActiveConnector and InputConnector
502 class GenericActiveInput
503 : public ActiveConnector, public InputConnector,
504 public safe_bool<GenericActiveInput>
507 GenericPassiveOutput & peer() const;
509 bool boolean_test() const; ///< \c true, if ! empty() or ! throttled()
511 void request(); ///< request more packets without dequeuing any packet
514 GenericActiveInput();
517 void v_requestEvent();
520 /** \brief Combination of ActiveConnector and OutputConnector
522 class GenericActiveOutput
523 : public ActiveConnector, public OutputConnector,
524 public safe_bool<GenericActiveOutput>
527 GenericPassiveInput & peer() const;
529 bool boolean_test() const; ///< \c true if peer() is ! throttled()
531 void connect(GenericPassiveInput & target); ///< Internal: Use senf::ppi::connect() instead
534 GenericActiveOutput();
540 # define TypedConnector_Input read
541 # define TypedConnector_Output write
542 # define TypedConnector(pType, dir) \
543 template <class PacketType> \
545 : public Generic ## pType ## dir, \
546 private detail::Typed ## dir ## Mixin<pType ## dir <PacketType>, PacketType> \
548 typedef detail::Typed ## dir ## Mixin<pType ## dir <PacketType>, PacketType> mixin; \
550 using mixin::operator(); \
551 using mixin::TypedConnector_ ## dir ; \
553 virtual std::type_info const & packetTypeID() \
554 { return typeid(typename PacketType::type); } \
555 friend class detail::Typed ## dir ## Mixin<pType ## dir <PacketType>, PacketType>; \
558 class pType ## dir <Packet> : public Generic ## pType ## dir \
561 TypedConnector( Passive, Input );
562 TypedConnector( Passive, Output );
563 TypedConnector( Active, Input );
564 TypedConnector( Active, Output );
566 # undef TypedConnector
567 # undef TypedConnector_Input
568 # undef TypedConnector_Output
572 /** \brief Connector actively reading packets
574 \tparam PacketType Type of packet to read. Defaults to senf::Packet
576 The %ActiveInput %connector template reads data actively from a connected %module. This
577 class is completely implemented via it's base-class, GenericActiveInput, the only
578 difference is that read packets are returned as \a PacketType instead of generic
579 senf::Packet references.
581 \see GenericActiveInput \n
584 template <class PacketType=Packet>
585 class ActiveInput : public GenericActiveInput
588 PacketType operator()(); ///< Read packet
589 /**< \throws std::bad_cast if the %connector receives a
590 Packet which is not of type \a PacketType.
591 \returns newly read packet reference. */
592 PacketType read(); ///< Alias for operator()
595 /** \brief Connector passively receiving packets
597 \tparam PacketType Type of packet to read. Defaults to senf::Packet
599 The %PassiveInput %connector template receives packets sent to it from a connected
600 %module. This class is completely implemented via it's base-class, GenericPassiveInput,
601 the only difference is that read packets are returned as \a PacketType instead of generic
602 senf::Packet references.
604 \see GenericPassiveInput \n
607 template <class PacketType=Packet>
608 class PassiveInput : public GenericPassiveInput
611 PacketType operator()(); ///< Read packet
612 /**< \throws std::bad_cast if the %connector receives a
613 Packet which is not of type \a PacketType.
614 \returns newly read packet reference. */
615 PacketType read(); ///< Alias for operator()
618 /** \brief Connector actively sending packets
620 \tparam PacketType Type of packet to send. Defaults to senf::Packet
622 The %ActiveOutput %connector template sends data actively to a connected %module. This
623 class is completely implemented via it's base-class, GenericActiveOutput, the only
624 difference is that it only sends packets of type \a PacketType.
626 \see GenericActiveOutput \n
629 template <class PacketType=Packet>
630 class ActiveOutput : public GenericActiveOutput
633 operator()(PacketType packet); ///< Send out a packet
634 void write(PacketType packet); ///< Alias for operator()
637 /** \brief Connector passively providing packets
639 \tparam PacketType Type of packet to send. Defaults to senf::Packet
641 The %PassiveOutput %connector template provides data passively to a connected %module
642 whenever signaled. This class is completely implemented via it's base-class,
643 GenericPassiveOutput, the only difference is that it only sends packets of type
646 \see GenericPassiveOutput \n
649 template <class PacketType=Packet>
650 class PassiveOutput : public GenericPassiveOutput
653 operator()(PacketType packet); ///< Send out a packet
654 void write(PacketType packet); ///< Alias for operator()
661 ///////////////////////////////hh.e////////////////////////////////////////
662 #include "Connectors.cci"
663 #include "Connectors.ct"
664 #include "Connectors.cti"
671 // c-file-style: "senf"
672 // indent-tabs-mode: nil
673 // ispell-local-dictionary: "american"
674 // compile-command: "scons -u test"
675 // comment-column: 40