QueuePushHandler.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of RSB project
 *
 * Copyright (C) 2010-2013 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 <boost/shared_ptr.hpp>
#include <boost/type_traits.hpp>

#include <rsc/threading/SynchronizedQueue.h>
#include <rsc/misc/langutils.h>

#include "../Handler.h"

namespace rsb {
namespace util {

template<class T, class DisableEventWarning = void>
class QueuePushHandler: public Handler {
private:
    boost::shared_ptr<rsc::threading::SynchronizedQueue<boost::shared_ptr<T> > >
            queue;
public:

    // Catch the common error that people use this class to receive complete events
    STATIC_ASSERT_WARN_TEMPLATE(QUEUE_PUSH_HANDLER_EVENT_WARNING,
            (boost::is_same<DisableEventWarning, Event>::value || !boost::is_same<T, Event>::value),
            "You probably do not want to use QueuePushHandler with type Event. \
If you want to receive complete Event instances inside a queue, you need to use EventQueuePushHandler. \
If you really want to use this class and want to get rid of this warning, define the second template parameter of this class to Event, too.");

    QueuePushHandler(
            boost::shared_ptr<rsc::threading::SynchronizedQueue<
                    boost::shared_ptr<T> > > queue,
            const std::string& method = "") :
        Handler(method), queue(queue) {
    }

    std::string getClassName() const {
        return "QueuePushHandler";
    }

    void printContents(std::ostream& stream) const {
        stream << "queue = " << queue;
    }

    void handle(EventPtr event) {
        queue->push(boost::static_pointer_cast<T>(event->getData()));
    }
};

}
}