src.main/CjNP_collection.hh

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
/*
 * mitie
 * Copyright (C) Jason Spencer 2009 <mitie@jasonspencer.org>
 * 
 * mitie is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * mitie is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef __CJNP_COLLECTION_H_
#define __CJNP_COLLECTION_H_ 1

#include <vector>
#include <functional>
#include <boost/shared_ptr.hpp>
#include "CjNetworkProcess.hh"

namespace jmitie {

class CjNP_collection {
public:
typedef boost::shared_ptr<CjNetworkProcess> procEntry_t;
typedef std::vector< procEntry_t > procList_t;

protected:
unsigned int m_epoch;
unsigned int m_clearout_period;
mutable bool m_active_list_valid;
bool m_assume_all_active;               // TODO WTF is this? COMMENT
procList_t m_master_list;
// procList_t::iterator m_master_list_end;      // marks end of m_master_list once expired entries have been removed
mutable procList_t m_active_list;
procList_t m_end_list;

struct priolist_cmp_lt : public std::binary_function<procEntry_t, procEntry_t, bool> {
        bool operator()( const procEntry_t & lhs, const procEntry_t & rhs ) { return lhs->getProcessPriority() < rhs->getProcessPriority(); }
        };

public:
CjNP_collection(unsigned int clearout_period = 50, bool assume_all_active = false);
unsigned int setClearoutPeriod(unsigned int period);
unsigned int getClearoutPeriod() const;
void clear();
void append( procEntry_t & proc);
CjNP_collection::procList_t::size_type size() const;
CjNP_collection::procList_t::size_type endlist_size() const;
unsigned int incrementEpoch();
unsigned int getEpoch() const;
CjNP_collection::procList_t get_epochBundle() const;
CjNP_collection::procList_t get_endBundle() const;
bool allExpired() const;

};

} // namespace jmitie

#endif // __CJNP_COLLECTION_H_