Messenger.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013-2016, SimQuest Solutions Inc.
//
// 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 SURGSIM_FRAMEWORK_MESSENGER_H
#define SURGSIM_FRAMEWORK_MESSENGER_H


#include "SurgSim/Framework/Timer.h"
#include "SurgSim/Framework/Component.h"

#include <boost/thread/mutex.hpp>

namespace SurgSim
{
namespace Framework
{

class Messenger
{
public:

    struct Event
    {
        Event(const std::string& name, const std::string& sender, double time, const boost::any& data) :
            name(name), sender(sender), time(time), data(data) {}

        Event() : time(0.0) {}
        std::string name; 
        std::string sender; 
        double time; 
        boost::any data; 
    };

    typedef std::function<void(const Event&)> EventCallback; 


    Messenger();

    void update();

    void publish(const std::string& event, const std::string& sender, const boost::any& data = boost::any());

    void publish(const std::string& event,
                 const std::shared_ptr<Component>& sender,
                 const boost::any& data = boost::any());

    void subscribe(const std::string& event, const std::shared_ptr<SurgSim::Framework::Component>& subscriber,
                   const EventCallback& callback);

    void subscribe(const std::shared_ptr<SurgSim::Framework::Component>& subscriber,
                   const EventCallback& callback);

    void unsubscribe(const std::string& event, const std::shared_ptr<SurgSim::Framework::Component>& subscriber);

    void unsubscribe(const std::shared_ptr<SurgSim::Framework::Component>& subscriber);

private:

    SurgSim::Framework::Timer m_timer;

    typedef std::pair<std::weak_ptr<SurgSim::Framework::Component>, EventCallback> Subscriber;

    std::unordered_map<std::string, std::vector<Subscriber>> m_subscribers;

    std::vector<Subscriber> m_universalSubscribers;

    boost::mutex m_subscriberMutex;

    std::vector<Event> m_events;

    boost::mutex m_eventMutex;

    void sendEvent(const Event& event, const std::vector<Subscriber>& receivers);

};
}
}

#endif