BaseRouting.h

Go to the documentation of this file.

/*
 Copyright (2016) Michael Baer, Daniel Bonrath, All rights reserved.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */

#ifndef __M2ETIS_PUBSUB_ROUTING_BASEROUTING_H__
#define __M2ETIS_PUBSUB_ROUTING_BASEROUTING_H__

#include "m2etis/parameters/RoutingParameters.h"
#include "m2etis/pubsub/ControlTargets.h"

namespace m2etis {
namespace pubsub {
namespace routing {

        template<class NetworkType>
        class BaseRouting {
                typedef std::vector<typename NetworkType::Key> KeyList;

        public:
                BaseRouting(unsigned int, PubSubSystemEnvironment *) : sendCtrlMsg_() {
                }

                virtual ~BaseRouting() {
                }

                void configureSendCallback(const boost::function<void(typename message::RoutingInfo<NetworkType>::Ptr, const typename NetworkType::Key &, ControlTarget)> & func) {
                        sendCtrlMsg_ = func;
                }

                virtual bool processSubscribePayload(typename message::RoutingInfo<NetworkType>::Ptr routingInfo, const typename NetworkType::Key & sender, typename NetworkType::Key & receiver, message::ActionType & msgType) = 0;

                virtual void processUnsubscribePayload(typename message::RoutingInfo<NetworkType>::Ptr routingInfo, const typename NetworkType::Key & sender, typename NetworkType::Key & receiver, message::ActionType & msgType) = 0;

                virtual void processPublishPayload(typename message::RoutingInfo<NetworkType>::Ptr routingInfo, const typename NetworkType::Key & sender, typename NetworkType::Key & receiver, message::ActionType & msgType) = 0;

                virtual void processNotifyPayload(typename message::RoutingInfo<NetworkType>::Ptr routingInfo, const typename NetworkType::Key & sender, typename NetworkType::Key & receiver, message::ActionType & msgType) = 0;

                virtual void processControlPayload(typename message::RoutingInfo<NetworkType>::Ptr routingInfo, const typename NetworkType::Key & sender, typename NetworkType::Key & receiver, message::ActionType & msgType) = 0;

                virtual KeyList getTargetNodes(const message::ActionType mtype, typename message::RoutingInfo<NetworkType>::Ptr routingInfo, typename NetworkType::Key & receiver) const = 0;

                virtual void configureRoutingInfo(message::ActionType & msgType, typename message::RoutingInfo<NetworkType>::Ptr routingInfo, typename NetworkType::Key & receiver) = 0;

                virtual void setUnsubscriptionListener(const boost::function<void(const typename NetworkType::Key)> & listener) = 0;

        protected:
                boost::function<void(typename message::RoutingInfo<NetworkType>::Ptr, typename NetworkType::Key, ControlTarget)> sendCtrlMsg_;
        };

} /* namespace routing */
} /* namespace pubsub */
} /* namespace m2etis */

#endif /* __M2ETIS_PUBSUB_ROUTING_BASEROUTING_H__ */