NetworkInterface.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_NET_NETWORKINTERFACE_H__
#define __M2ETIS_NET_NETWORKINTERFACE_H__

#include "m2etis/util/SystemParameters.h"

#include "m2etis/message/MessageType.h"
#include "m2etis/message/NetworkMessage.h"
#include "m2etis/net/NodeHandle.h"

namespace m2etis {
namespace net {

        template<class Network>
        class NetworkCallbackInterface;

        template<class NetworkType>
        class NetworkInterface {
        public:
                virtual ~NetworkInterface() {
                }

                void setCallback(NetworkCallbackInterface<NetworkType> * cb) {
                        _callback = cb;
                }

                virtual void send(const typename message::NetworkMessage<NetworkType>::Ptr msg, typename NodeHandle<NetworkType>::Ptr_const hint) = 0;

                virtual typename NodeHandle<NetworkType>::Ptr getSelfNodeHandle() const = 0;

                virtual void registerMessageType(const typename NetworkType::MessageType type, const bool ack) const = 0;

                // virtual typename NetworkType::Message::Ptr createNetMessage() = 0;

                // virtual typename NetworkType::Message::Ptr deserializeMessage(const std::vector<unsigned char>& serialized_message) = 0;

                // virtual NodeHandleList neighborSet(const int num) const = 0;

                // virtual NodeHandleList replicaSet(const std::string& key, const int maxRank) const  = 0;

                // virtual bool range(const NodeHandle& node, const int rank, const std::string& lkey, const std::string& rkey) const = 0;

        protected:
                net::NetworkCallbackInterface<NetworkType> * _callback;
        };

} /* namespace net */
} /* namespace m2etis */

#endif /* __M2ETIS_NET_NETWORKINTERFACE_H__ */