RemoteServer.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 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 <stdexcept>
#include <string>

#include <boost/noncopyable.hpp>
#include <boost/thread/mutex.hpp>

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

#include "../Event.h"
#include "../Exception.h"
#include "../Informer.h"
#include "../Listener.h"
#include "../ParticipantConfig.h"
#include "../Scope.h"
#include "rsb/rsbexports.h"

namespace rsb {
namespace patterns {

class WaitingEventHandler;

class RSB_EXPORT RemoteServer: public boost::noncopyable {
public:
    typedef rsc::threading::Future<EventPtr> FutureType;
    typedef boost::shared_ptr<FutureType> FuturePtr;

    template <typename O>
    class DataFuture  {
    public:
        DataFuture(FuturePtr target):
            target(target) {
        }

        bool isDone() {
            return this->target->isDone();
        }

        boost::shared_ptr<O> get(double timeout) {
            return boost::static_pointer_cast<O>(this->target->get(timeout)->getData());
        }
    private:
        FuturePtr target;
    };

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

    template<class I>
    EventPtr prepareRequestEvent(boost::shared_ptr<I> args) {
        EventPtr request(new Event);
        request->setType(rsc::runtime::typeName<I>());
        request->setData(args);
        return request;
    }

    FuturePtr callAsync(const std::string& methodName, EventPtr data);

    template <typename O, typename I>
    DataFuture<O> callAsync(const std::string&    methodName,
                            boost::shared_ptr<I> args) {
        return DataFuture<O>(callAsync(methodName, prepareRequestEvent(args)));
    }

    template <typename O>
    DataFuture<O> callAsync(const std::string& methodName) {
        EventPtr request(new Event());
        request->setType(rsc::runtime::typeName<void>());
        request->setData(VoidPtr(malloc(10)));
        return DataFuture<O>(callAsync(methodName, request));
    }

    EventPtr call(const std::string& methodName,
                  EventPtr          data,
                  unsigned int      maxReplyWaitTime = 25);

    template <typename O, typename I>
    boost::shared_ptr<O> call(const std::string&    methodName,
                              boost::shared_ptr<I> args,
                              unsigned int         maxReplyWaitTime = 25) {
        return callAsync<O>(methodName, args).get(maxReplyWaitTime);
    }

    template <typename O>
    boost::shared_ptr<O> call(const std::string& methodName,
                              unsigned int       maxReplyWaitTime = 25) {
        return callAsync<O>(methodName).get(maxReplyWaitTime);
    }
private:
    rsc::logging::LoggerPtr logger;

    Scope scope;
    ParticipantConfig listenerConfig;
    ParticipantConfig informerConfig;

    class MethodSet {
    public:
        std::string methodName;
        std::string sendType;
        boost::shared_ptr<WaitingEventHandler> handler;
        ListenerPtr replyListener;
        Informer<void>::Ptr requestInformer;
    };

    boost::mutex methodSetMutex;
    std::map<std::string, MethodSet> methodSets;

    MethodSet getMethodSet(const std::string& methodName,
                           const std::string& sendType);

};

typedef boost::shared_ptr<RemoteServer> RemoteServerPtr;

}
}