Factory.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project.
 *
 * Copyright (C) 2011 by Johannes Wienke <jwienke 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 <vector>

#include <boost/shared_ptr.hpp>

#include <boost/signals2.hpp>

#include <boost/thread/recursive_mutex.hpp>

#include <rsc/misc/langutils.h>
#include <rsc/logging/Logger.h>
#include <rsc/runtime/TypeStringTools.h>
#include <rsc/config/OptionHandler.h>
#include <rsc/plugins/Manager.h>

#include "rsb/rsbexports.h"

#include "ParticipantConfig.h"
#include "Reader.h"
#include "Listener.h"
#include "Informer.h"

#include "transport/Connector.h"
#include "transport/Factory.h"

#include "patterns/LocalServer.h"
#include "patterns/RemoteServer.h"

namespace rsb {

typedef boost::signals2::signal<void(ParticipantPtr, ParticipantPtr)> SignalParticipantCreated;
typedef boost::shared_ptr<SignalParticipantCreated> SignalParticipantCreatedPtr;

class Factory;

RSB_EXPORT Factory& getFactory();

class RSB_EXPORT Factory {
public:

    virtual ~Factory();

    SignalParticipantCreatedPtr getSignalParticipantCreated();

    SignalParticipantDestroyedPtr getSignalParticipantDestroyed();

    template<class DataType>
    typename Informer<DataType>::Ptr
    createInformer(const Scope&             scope,
                   const ParticipantConfig& config
                   = getFactory().getDefaultParticipantConfig(),
                   const std::string&       dataType
                   = detail::TypeName<DataType>()(),
                   ParticipantPtr           parent
                   = ParticipantPtr()) {
        typename Informer<DataType>::Ptr informer(
            new Informer<DataType>(createOutConnectors(config), scope,
                                   config, dataType));
        informer->setSignalParticipantDestroyed(this->signalParticipantDestroyed);
        (*this->signalParticipantCreated)(informer, parent);
        return informer;
    }

    InformerBasePtr createInformerBase(const Scope&             scope,
                                       const std::string&       dataType
                                       = "",
                                       const ParticipantConfig& config
                                       = getFactory().getDefaultParticipantConfig(),
                                       ParticipantPtr           parent
                                       = ParticipantPtr());

    ListenerPtr createListener(const Scope&             scope,
                               const ParticipantConfig& config
                               = getFactory().getDefaultParticipantConfig(),
                               ParticipantPtr           parent
                               = ParticipantPtr());

    ReaderPtr createReader(const Scope&             scope,
                           const ParticipantConfig& config
                           = getFactory().getDefaultParticipantConfig(),
                           ParticipantPtr           parent
                           = ParticipantPtr());

    patterns::LocalServer::LocalMethodPtr createLocalMethod(
        const Scope&                       scope,
        patterns::LocalServer::CallbackPtr callback,
        const ParticipantConfig&           listenerConfig
        = getFactory().getDefaultParticipantConfig(),
        const ParticipantConfig&           informerConfig
        = getFactory().getDefaultParticipantConfig(),
        ParticipantPtr                     parent
        = ParticipantPtr());

    patterns::LocalServerPtr createLocalServer(
            const Scope&             scope,
            const ParticipantConfig& listenerConfig
            = getFactory().getDefaultParticipantConfig(),
            const ParticipantConfig& informerConfig
            = getFactory().getDefaultParticipantConfig(),
            ParticipantPtr           parent
            = ParticipantPtr());

    patterns::RemoteServer::RemoteMethodPtr createRemoteMethod(
        const Scope&             scope,
        const ParticipantConfig& listenerConfig
        = getFactory().getDefaultParticipantConfig(),
        const ParticipantConfig& informerConfig
        = getFactory().getDefaultParticipantConfig(),
        ParticipantPtr           parent
        = ParticipantPtr());

    patterns::RemoteServerPtr createRemoteServer(
            const Scope&             scope,
            const ParticipantConfig& listenerConfig
            = getFactory().getDefaultParticipantConfig(),
            const ParticipantConfig& informerConfig
            = getFactory().getDefaultParticipantConfig(),
            ParticipantPtr           parent
            = ParticipantPtr());

    ParticipantConfig getDefaultParticipantConfig() const;

    void setDefaultParticipantConfig(const ParticipantConfig& config);

    rsc::plugins::ManagerPtr getPluginManager() const;

    static void provideConfigOptions(const std::string&          environmentVariablePrefix,
                                     rsc::config::OptionHandler& handler,
                                     bool                        stripPrefix = true);

private:
    Factory();

    friend Factory& getFactory();

    rsc::logging::LoggerPtr logger;

    rsc::plugins::ManagerPtr pluginManager;

    ParticipantConfig defaultConfig;
    mutable boost::recursive_mutex configMutex;

    SignalParticipantCreatedPtr signalParticipantCreated;
    SignalParticipantDestroyedPtr signalParticipantDestroyed;

    std::vector<transport::OutConnectorPtr>
        createOutConnectors(const ParticipantConfig& config);

    std::vector<transport::InPullConnectorPtr>
        createInPullConnectors(const ParticipantConfig& config);

    std::vector<transport::InPushConnectorPtr>
        createInPushConnectors(const ParticipantConfig& config);

    void configureSubsystem(rsc::config::OptionHandler& handler,
                            const std::string& environmentVariablePrefix = "RSB_");

};

}