Assembly.h

Go to the documentation of this file.

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

#include <boost/cstdint.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <boost/date_time/posix_time/ptime.hpp>

#include <rsc/logging/Logger.h>
#include <rsc/threading/PeriodicTask.h>
#include <rsc/threading/ThreadedTaskExecutor.h>

#include "../../protocol/Notification.h"
#include "../../protocol/FragmentedNotification.h"
#include "rsb/rsbexports.h"

namespace rsb {
namespace spread {

class RSB_EXPORT Assembly {
public:

    Assembly(rsb::protocol::FragmentedNotificationPtr n);
    ~Assembly();

    rsb::protocol::NotificationPtr getCompleteNotification() const;

    bool add(rsb::protocol::FragmentedNotificationPtr n);

    bool isComplete() const;

    unsigned int age() const;

private:
    rsc::logging::LoggerPtr logger;
    unsigned int receivedParts;
    std::vector<rsb::protocol::FragmentedNotificationPtr> store;
    boost::posix_time::ptime birthTime;

};

typedef boost::shared_ptr<Assembly> AssemblyPtr;

class RSB_EXPORT AssemblyPool {
public:

    explicit AssemblyPool(const unsigned int& ageS = 20,
            const unsigned int& pruningIntervalMs = 4000);

    ~AssemblyPool();

    bool isPruning() const;

    void setPruning(const bool& prune);

    rsb::protocol::NotificationPtr add(
            rsb::protocol::FragmentedNotificationPtr notification);

private:
    typedef std::map<std::string, boost::shared_ptr<Assembly> > Pool;

    class PruningTask: public rsc::threading::PeriodicTask {
    public:

        PruningTask(Pool& pool, boost::recursive_mutex& poolMutex,
                const unsigned int& ageS,
                const unsigned int& pruningIntervalMs);

        void execute();

    private:
        rsc::logging::LoggerPtr logger;
        Pool& pool;
        boost::recursive_mutex& poolMutex;
        unsigned int maxAge;
    };

    rsc::logging::LoggerPtr logger;
    Pool pool;
    boost::recursive_mutex poolMutex;

    const unsigned int pruningAgeS;
    const unsigned int pruningIntervalMs;

    rsc::threading::ThreadedTaskExecutor executor;
    mutable boost::recursive_mutex pruningMutex;
    rsc::threading::TaskPtr pruningTask;
};

typedef boost::shared_ptr<AssemblyPool> AssemblyPoolPtr;

}
}