4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
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 Route internal header */
30 #include <boost/type_traits/is_convertible.hpp>
31 #include <boost/type_traits/is_base_of.hpp>
32 #include <boost/mpl/if.hpp>
33 #include <boost/mpl/bool.hpp>
34 #include <boost/static_assert.hpp>
36 ///////////////////////////////ih.p////////////////////////////////////////
42 // This is the RoutingTraits implementation for Connectors. Events are handled in the
43 // specialization below
44 template <class Connector, bool isEvent>
45 struct RoutingTraitsImplementation
47 BOOST_STATIC_ASSERT((boost::is_base_of<connector::Connector, Connector>::value));
49 static bool const notifySource = boost::is_base_of<
50 connector::ActiveConnector, Connector>::value;
51 static bool const notifyTarget = boost::is_base_of<
52 connector::PassiveConnector, Connector>::value;
54 static bool const dataSource = boost::is_base_of<
55 connector::InputConnector, Connector>::value;
56 static bool const dataTarget = boost::is_base_of<
57 connector::OutputConnector, Connector>::value;
59 typedef Connector type;
62 // RoutingTraits specialization for Event types. Events may be both dataSource or dataTarget but
63 // cannot be notifySource.
64 template <class Event>
65 struct RoutingTraitsImplementation<Event,true>
67 static bool const notifySource = false;
68 static bool const notifyTarget = true;
70 static bool const dataSource = true;
71 static bool const dataTarget = true;
73 typedef EventDescriptor type;
76 // The RoutingTraits give routing related information about the argument type:
77 // - Wether the type is a notifySource or notifyTarget
78 // - Wether the type is dataSource or dataTarget
79 // - Provide the generalized target type
81 // The real implementation is in RoutingTraitsImplementation which is appropriately specialized
83 template <class Object>
85 : public RoutingTraitsImplementation<Object,
86 boost::is_convertible<Object*,
87 EventDescriptor*>::value>
90 // This is the generic route implementation for all routes. It just provides access to the
92 template <class Source, class Target, class Base>
93 class BaseRouteImplementation
97 typedef Source source_type;
98 typedef Target target_type;
100 Source & source() const;
101 Target & target() const;
104 BaseRouteImplementation(module::Module & module, Source & source, Target & target);
111 // The ForwardingRouteImplementation is based on the same BaseRouteImplementation
112 // as non-forwarding routes are but injects a different base-class (the third template
113 // argument to BaseRouteImplementation). ForwardingRouteImplementation has two additional
115 // 1) Register the ForwardingRoute with the notifySource
116 // 2) Implement the abstract ForwardingRoute interface
118 // Since we don't know explicitly, which of Source or Target is the notifySource or
119 // notifyTarget, the implementation calls registerRoute and notifyThrottle/notifyUnthrottle on
120 // *both*, the source and target, however qualified with an additional argument of type
121 // boost::mpl::bool_ which is used to select the correct overloads, of which the 'false'
122 // overload always is a no-op. This way, only the correct call will generate any code, the
123 // disabled call will be optimized away.
124 template <class Source, class Target>
125 class ForwardingRouteImplementation
126 : public BaseRouteImplementation<Source, Target, ForwardingRoute>
128 typedef BaseRouteImplementation<Source, Target, ForwardingRoute> Base;
131 ForwardingRouteImplementation(module::Module & module, Source & source, Target & target);
134 // send a throttle/unthrottle notification only if the second argument is a 'true' type
135 template <class T> void notifyThrottle(T & ob, boost::mpl::bool_<true> const &);
136 template <class T> void notifyThrottle(T & ob, boost::mpl::bool_<false> const &);
137 template <class T> void notifyUnthrottle(T & ob, boost::mpl::bool_<true> const &);
138 template <class T> void notifyUnthrottle(T & ob, boost::mpl::bool_<false> const &);
140 template <class T> bool throttled(T & ob, boost::mpl::bool_<true> const &) const;
141 template <class T> bool throttled(T & ob, boost::mpl::bool_<false> const &) const;
143 virtual void v_notifyThrottle();
144 virtual void v_notifyUnthrottle();
145 virtual bool v_throttled() const;
148 // This helper class finds the base-class suitable for a specific route. Routes are classified
150 // 1) A forwarding routes is a routed which forwards notifications from a notifySource to a
151 // notifyTarget. Forwarding routes are implemneted using ForwardingRouteImplementation
152 // 2) Non-forwarding routes don't forward notifications. They are implemented directly
153 // using BaseRouteImplementation
154 template <class Source, class Target>
155 struct RouteImplementationBase
157 typedef RoutingTraits<Source> srcTrait;
158 typedef RoutingTraits<Target> trgTrait;
160 static bool const isForwarding = (srcTrait::notifySource && trgTrait::notifyTarget)
161 || (srcTrait::notifyTarget && trgTrait::notifySource);
163 typedef typename boost::mpl::if_c<
165 ForwardingRouteImplementation<Source,Target>,
166 BaseRouteImplementation<Source,Target,RouteBase> >::type base;
169 // RouteImplementation2 has two purposes:
170 // 1) Ensure, that routing is always from a data source to a data target
171 // 2) To find the correct base-class. This is delegated to RouteImplementationBase
172 template <class Source, class Target>
173 class RouteImplementation2
174 : public RouteImplementationBase<Source,Target>::base
176 typedef typename RouteImplementationBase<Source,Target>::base Base;
178 BOOST_STATIC_ASSERT( RoutingTraits<Source>::dataSource &&
179 RoutingTraits<Target>::dataTarget );
182 RouteImplementation2(module::Module & module, Source & source, Target & target);
185 // RouteImplementation just forwards to RouteImplementation2 replacing the template arguments
186 // with the appropriately generalized type: If either Source or Target is an Event type, it is
187 // replaced with the general Event base-class EventDescriptor. Connector types are left as is.
188 template <class Source, class Target>
189 class RouteImplementation
190 : public RouteImplementation2<typename RoutingTraits<Source>::type,
191 typename RoutingTraits<Target>::type>
193 typedef RouteImplementation2<typename RoutingTraits<Source>::type,
194 typename RoutingTraits<Target>::type> Base;
197 RouteImplementation(module::Module & module, Source & source, Target & target);
202 ///////////////////////////////ih.e////////////////////////////////////////
209 // comment-column: 40
210 // c-file-style: "senf"
211 // indent-tabs-mode: nil
212 // ispell-local-dictionary: "american"
213 // compile-command: "scons -u test"