LocalServer.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of RSB project
 *
 * Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
 * Copyright (C) 2011, 2012, 2013, 2014, 2015 Jan Moringen <jmoringe@techfak.uni-bielefeld.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 <map>

#include <boost/shared_ptr.hpp>
#include <boost/enable_shared_from_this.hpp>

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

#include "../Handler.h"

#include "Server.h"

#include "rsb/rsbexports.h"

namespace rsb {
namespace patterns {

class RSB_EXPORT LocalServer: public Participant,
                              public boost::enable_shared_from_this<LocalServer> {
public:

    class RSB_EXPORT IntlCallback {
    public:
        virtual ~IntlCallback();

        virtual EventPtr intlCall(const std::string& methodName,
                                  EventPtr request) = 0;
    };

    typedef boost::shared_ptr<IntlCallback> CallbackPtr;

    class RSB_EXPORT EventCallback : public IntlCallback {
    public:
        virtual EventPtr call(const std::string& methodName, EventPtr request) = 0;
    private:
        EventPtr intlCall(const std::string& methodName, EventPtr request);
    };

    class RSB_EXPORT CallbackBase : public IntlCallback {
    public:
        virtual const std::string& getRequestType() const;
        virtual const std::string& getReplyType() const;
    protected:
        CallbackBase(const std::string& requestType,
                     const std::string& replyType);

        std::string requestType;
        std::string replyType;
    };

    template<class RequestType>
    class RSB_EXPORT AnyReplyTypeCallback : public CallbackBase {
    public:
        // typeid is due to msvc strangeness
        AnyReplyTypeCallback(const std::string& requestType
                 = rsc::runtime::typeName(typeid(RequestType))) :
            CallbackBase(requestType, "") {
        }

        virtual AnnotatedData call(const std::string& methodName,
                boost::shared_ptr<RequestType> input) = 0;
    private:
        EventPtr intlCall(const std::string& methodName, EventPtr request) {
            boost::shared_ptr<RequestType> argument
                = boost::static_pointer_cast<RequestType>(request->getData());
            AnnotatedData result = call(methodName, argument);
            EventPtr reply(new Event());
            reply->setType(result.first);
            reply->setData(result.second);
            return reply;
        }

    };

    template<class RequestType, class ReplyType>
    class Callback: public CallbackBase {
    public:
        // typeid is due to msvc strangeness
        Callback(const std::string& requestType
                 = rsc::runtime::typeName(typeid(RequestType)),
                 const std::string& replyType
                 = rsc::runtime::typeName(typeid(ReplyType))) :
            CallbackBase(requestType, replyType) {
        }

        virtual boost::shared_ptr<ReplyType> call(const std::string& methodName,
                                                  boost::shared_ptr<RequestType> input) = 0;
    private:
        EventPtr intlCall(const std::string& methodName, EventPtr request) {
            boost::shared_ptr<RequestType> argument
                = boost::static_pointer_cast<RequestType>(request->getData());
            boost::shared_ptr<ReplyType> result = call(methodName, argument);
            EventPtr reply(new Event());
            reply->setType(getReplyType());
            reply->setData(result);
            return reply;
        }
    };

    template<class RequestType>
    class Callback<RequestType, void>: public CallbackBase {
    public:
        // typeid is due to msvc strangeness
        Callback(const std::string& requestType
                 = rsc::runtime::typeName(typeid(RequestType)),
                 const std::string& replyType
                 = rsc::runtime::typeName(typeid(void))) :
            CallbackBase(requestType, replyType) {
        }

        virtual void call(const std::string& methodName,
                          boost::shared_ptr<RequestType> input) = 0;
    private:
        EventPtr intlCall(const std::string& methodName, EventPtr request) {
            boost::shared_ptr<RequestType> argument
                = boost::static_pointer_cast<RequestType>(request->getData());
            call(methodName, argument);
            EventPtr reply(new Event());
            reply->setType(getReplyType());
            reply->setData(boost::shared_ptr<void>());
            return reply;
        }

    };

    template<class ReplyType>
    class Callback<void, ReplyType>: public CallbackBase {
    public:
      // typeid is due to msvc strangeness
      Callback(const std::string& requestType
           = rsc::runtime::typeName(typeid(void)),
           const std::string& replyType
           = rsc::runtime::typeName(typeid(ReplyType))) :
      CallbackBase(requestType, replyType) {
      }

        virtual boost::shared_ptr<ReplyType> call(
                const std::string& methodName) = 0;
    private:
        EventPtr intlCall(const std::string& methodName, EventPtr /*request*/) {
            EventPtr reply(new Event());
            reply->setType(getReplyType());
            reply->setData(call(methodName));
            return reply;
        }

    };

    template<class RequestType, class ReplyType>
    class FunctionCallback: public CallbackBase {
    public:
        typedef boost::function<
                typename boost::shared_ptr<ReplyType>(
                        typename boost::shared_ptr<RequestType>)> FunctionType;

        explicit FunctionCallback(FunctionType function,
                const std::string& requestType = rsc::runtime::typeName(
                        typeid(RequestType)), const std::string& replyType =
                        rsc::runtime::typeName(typeid(ReplyType))) :
                CallbackBase(requestType, replyType), function(function) {
        }

    private:
        EventPtr intlCall(const std::string& /*methodName*/, EventPtr request) {
            boost::shared_ptr<RequestType> argument
                = boost::static_pointer_cast<RequestType>(request->getData());
            boost::shared_ptr<ReplyType> result = function(argument);
            EventPtr reply(new Event());
            reply->setType(getReplyType());
            reply->setData(result);
            return reply;
        }

        FunctionType function;
    };

    template<class RequestType>
    class FunctionCallback<RequestType, void>: public CallbackBase {
    public:
        typedef boost::function<void(typename boost::shared_ptr<RequestType>)> FunctionType;

        explicit FunctionCallback(FunctionType function,
                const std::string& requestType = rsc::runtime::typeName(
                        typeid(RequestType)), const std::string& replyType =
                        rsc::runtime::typeName(typeid(void))) :
                CallbackBase(requestType, replyType), function(function) {
        }

    private:
        EventPtr intlCall(const std::string& /*methodName*/, EventPtr request) {
            boost::shared_ptr<RequestType> argument =
                    boost::static_pointer_cast<RequestType>(request->getData());
            function(argument);
            EventPtr reply(new Event());
            reply->setType(getReplyType());
            reply->setData(boost::shared_ptr<void>());
            return reply;
        }

        FunctionType function;
    };

    template<class ReplyType>
    class FunctionCallback<void, ReplyType>: public CallbackBase {
    public:
        typedef boost::function<
                typename boost::shared_ptr<ReplyType>(void)> FunctionType;

        explicit FunctionCallback(FunctionType function,
                const std::string& requestType = rsc::runtime::typeName(
                        typeid(void)), const std::string& replyType =
                        rsc::runtime::typeName(typeid(ReplyType))) :
                CallbackBase(requestType, replyType), function(function) {
        }

    private:
        EventPtr intlCall(const std::string& /*methodName*/,
                EventPtr /*request*/) {
            boost::shared_ptr<ReplyType> result = function();
            EventPtr reply(new Event());
            reply->setType(getReplyType());
            reply->setData(result);
            return reply;
        }

        FunctionType function;
    };

    class LocalMethod: public Method {
    public:
        LocalMethod(const Scope&             scope,
                    const std::string&       name,
                    const ParticipantConfig& listenerConfig,
                    const ParticipantConfig& informerConfig,
                    CallbackPtr              callback);
        virtual ~LocalMethod();

        // Overrides method in Participant.
        virtual std::string getKind() const;
    private:
        rsc::logging::LoggerPtr logger;

        CallbackPtr             callback;

        ListenerPtr makeListener();

        void handle(EventPtr event);
    };

    typedef boost::shared_ptr<LocalMethod> LocalMethodPtr;

    LocalServer(const Scope&             scope,
                const ParticipantConfig &listenerConfig,
                const ParticipantConfig &informerConfig);
    virtual ~LocalServer();

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

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

    void registerMethod(const std::string& name, CallbackPtr callback);

private:
    ParticipantConfig                     listenerConfig;
    ParticipantConfig                     informerConfig;

    std::map<std::string, LocalMethodPtr> methods;
};

// Since these are complete specializations, they
// cannot be declared inline in Server like the partial
// specializations (see C++03, §14.7.3/2:).

template<>
class RSB_EXPORT LocalServer::Callback<void, void>: public LocalServer::CallbackBase {
public:
    // typeid is due to msvc strangeness
    Callback() :
        LocalServer::CallbackBase(rsc::runtime::typeName(typeid(void)),
                                  rsc::runtime::typeName(typeid(void))) {
    }

    virtual void call(const std::string& methodName) = 0;
private:
    EventPtr intlCall(const std::string& methodName, EventPtr /*request*/) {
        call(methodName);
        EventPtr reply(new Event());
        reply->setType(getReplyType());
        reply->setData(boost::shared_ptr<void>());
        return reply;
    }

};

template<>
class RSB_EXPORT LocalServer::FunctionCallback<void, void>: public LocalServer::CallbackBase {
public:
    typedef boost::function<void(void)> FunctionType;

    explicit FunctionCallback(FunctionType function,
            const std::string& requestType = rsc::runtime::typeName(
                    typeid(void)), const std::string& replyType =
                    rsc::runtime::typeName(typeid(void))) :
            LocalServer::CallbackBase(requestType, replyType), function(
                    function) {
    }

private:
    EventPtr intlCall(const std::string& /*methodName*/, EventPtr /*request*/) {
        function();
        EventPtr reply(new Event());
        reply->setType(getReplyType());
        reply->setData(boost::shared_ptr<void>());
        return reply;
    }

    FunctionType function;
};

typedef boost::shared_ptr<LocalServer> LocalServerPtr;

}
}