update_queue.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-

// Copyright (c) 2001-2011 XORP, Inc and Others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
// 
// This program 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. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
// 
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net

// $XORP: xorp/rip/update_queue.hh,v 1.17 2008/10/02 21:58:18 bms Exp $

#ifndef __RIP_UPDATE_QUEUE__
#define __RIP_UPDATE_QUEUE__


#include "route_db.hh"

template <typename A>
class UpdateQueueImpl;


template <typename A>
class UpdateQueueReader {
public:
    UpdateQueueReader(UpdateQueueImpl<A>* i);
    ~UpdateQueueReader();

    uint32_t id() const;
    bool parent_is(const UpdateQueueImpl<A>* o) const;

private:
    UpdateQueueImpl<A>* _impl;
    uint32_t        _id;
};


template <typename A>
class UpdateQueue {
protected:
    typedef UpdateQueueReader<A>    Reader;

public:
    typedef ref_ptr<Reader>     ReadIterator;
    typedef RouteEntryRef<A>        RouteUpdate;

public:
    UpdateQueue();
    ~UpdateQueue();

    void push_back(const RouteUpdate& ru);

    void flush();

    ReadIterator create_reader();

    void destroy_reader(ReadIterator& r);

    bool reader_valid(const ReadIterator& r);

    const RouteEntry<A>* next(ReadIterator& r);

    const RouteEntry<A>* get(ReadIterator& r) const;

    void ffwd(ReadIterator& r);

    void rwd(ReadIterator& r);

    uint32_t updates_queued() const;

protected:
    UpdateQueueImpl<A>* _impl;
};

#endif // __RIP_UPDATE_QUEUE__