Informer.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project
 *
 * Copyright (C) 2010 by Sebastian Wrede <swrede at techfak dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <string>

#include <boost/cstdint.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/mutex.hpp>

#include <rsc/runtime/TypeStringTools.h>
#include <rsc/logging/Logger.h>

#include "rsb/rsbexports.h"

#include "Event.h"
#include "QualityOfServiceSpec.h"
#include "Participant.h"

#include "eventprocessing/OutRouteConfigurator.h"

#include "transport/Connector.h"

namespace rsb {

class AnyType {
};

namespace detail {

template<typename T>
struct TypeName {
    std::string operator()() const {
        return rsc::runtime::typeName<T>();
    }
};

template<>
struct TypeName<AnyType> {
    std::string operator()() const {
        return "";
    }
};

}

class RSB_EXPORT InformerBase: public Participant {
public:
    template<typename T>
    struct DataPtr {
        typedef boost::shared_ptr<T> type;
    };

    InformerBase(const std::vector<transport::OutConnectorPtr>& connectors,
            const Scope& scope, const ParticipantConfig& config,
            const std::string& defaultType);

    virtual ~InformerBase();

    void printContents(std::ostream& stream) const;

    // Overrides method in Participant.
    virtual std::string getKind() const;

    // Overrides method in Participant.
    virtual const std::set<std::string> getTransportURLs() const;

    std::string getType() const;

    void setQualityOfSerivceSpecs(const QualityOfServiceSpec& specs);

    template<class T1>
    EventPtr publish(boost::shared_ptr<T1> data,
            std::string type = rsc::runtime::typeName<T1>()) {
        VoidPtr p = boost::static_pointer_cast<void>(data);
        return publish(p, type);
    }

    template<class T1>
    EventPtr uncheckedPublish(boost::shared_ptr<T1> data,
            const std::string& type = rsc::runtime::typeName<T1>()) {
        VoidPtr p = boost::static_pointer_cast<void>(data);
        return uncheckedPublish(p, type);
    }

    virtual EventPtr createEvent() const;

    EventPtr publish(VoidPtr data, const std::string& type);
    EventPtr uncheckedPublish(VoidPtr data, const std::string& type);

    EventPtr publish(EventPtr event);

protected:
    void checkedPublish(EventPtr event);
    void uncheckedPublish(EventPtr event);

    boost::uint32_t nextSequenceNumber();

    std::string defaultType;
    eventprocessing::OutRouteConfiguratorPtr configurator;

private:
    rsc::logging::LoggerPtr logger;
    boost::uint32_t currentSequenceNumber;
    boost::mutex sequenceNumberMutex;
};

typedef boost::shared_ptr<InformerBase> InformerBasePtr;

template<class T>
class Informer: public InformerBase {
public:

    typedef boost::shared_ptr<Informer<T> > Ptr;

    typedef boost::shared_ptr<T> DataPtr;

    Informer(const std::vector<transport::OutConnectorPtr>& connectors,
            const Scope& scope, const ParticipantConfig& config,
            const std::string& type = detail::TypeName<T>()()) :
        InformerBase(connectors, scope, config, type),
                logger(rsc::logging::Logger::getLogger(getClassName())) {
    }

    virtual ~Informer() {
    }

    std::string getClassName() const {
        return rsc::runtime::typeName<Informer<T> >();
    }

    EventPtr createEvent() const {
        EventPtr event = InformerBase::createEvent();
        event->setType(getType());
        return event;
    }

    EventPtr publish(boost::shared_ptr<T> data) {
        VoidPtr p = boost::static_pointer_cast<void>(data);
        return InformerBase::publish(p, this->getType());
    }

    template<class T1>
    EventPtr publish(boost::shared_ptr<T1> data,
            std::string type = rsc::runtime::typeName(typeid(T1))) {
        return InformerBase::publish(data, type);
    }

    EventPtr publish(EventPtr event) {
        return InformerBase::publish(event);
    }
private:
    rsc::logging::LoggerPtr logger;
};

}