Listener.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 <set>

#include <boost/scoped_ptr.hpp>

#include <rsc/logging/Logger.h>

#include <boost/shared_ptr.hpp>

#include "rsb/rsbexports.h"
#include "Participant.h"

namespace rsb {

class Event;
typedef boost::shared_ptr<Event> EventPtr;
class Handler;
typedef boost::shared_ptr<Handler> HandlerPtr;

namespace filter {
class Filter;
typedef boost::shared_ptr<Filter> FilterPtr;
}

namespace eventprocessing {
class PushInRouteConfigurator;
typedef boost::shared_ptr<PushInRouteConfigurator> PushInRouteConfiguratorPtr;
}

namespace transport {
class InPushConnector;
typedef boost::shared_ptr<InPushConnector> InPushConnectorPtr;
}

class RSB_EXPORT Listener: public Participant {
public:

    Listener(const std::vector<transport::InPushConnectorPtr>& connectors,
            const Scope& scope, const ParticipantConfig& config);

    virtual ~Listener();

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

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

    void addFilter(filter::FilterPtr filter);

    void removeFilter(filter::FilterPtr filter);

    virtual void addHandler(HandlerPtr h, bool wait = true);

    void removeHandler(HandlerPtr h, bool wait = true);

private:

    class Impl;
    boost::scoped_ptr<Impl> d;

    void initialize(const std::vector<transport::InPushConnectorPtr>& connectors,
                    const Scope&                                      scope,
                    const ParticipantConfig&                          config);
};

typedef boost::shared_ptr<Listener> ListenerPtr;

}