redist.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// vim:set sts=4 ts=8:

// 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/redist.hh,v 1.14 2008/10/02 21:58:17 bms Exp $

#ifndef __RIP_ROUTE_REDIST_HH__
#define __RIP_ROUTE_REDIST_HH__

#include "route_entry.hh"

template <typename A>
class RouteDB;

template <typename A>
class RouteWalker;

template <typename A>
class RedistRouteOrigin :
    public RouteEntryOrigin<A>
{
public:
    RedistRouteOrigin() : RouteEntryOrigin<A>(true) {}

    uint32_t expiry_secs() const;

    uint32_t deletion_secs() const;
};


template <typename A>
class RouteRedistributor :
    public NONCOPYABLE
{
public:
    typedef A Addr;
    typedef IPNet<A> Net;

public:
    RouteRedistributor(RouteDB<A>&  route_db);

    ~RouteRedistributor();

    bool add_route(const Net&       net,
           const Addr&      nexthop,
           const string&    ifname,
           const string&    vifname,
           uint16_t     cost,
           uint16_t     tag,
           const PolicyTags&    policytags);

    bool expire_route(const Net& net);

    uint32_t route_count() const;

    void withdraw_routes();

    bool withdrawing_routes() const;

private:
    bool withdraw_batch();

protected:
    RouteDB<A>&         _route_db;
    RedistRouteOrigin<A>*   _rt_origin;

    RouteWalker<A>*         _wdrawer;   // Route Withdrawl Walker
    XorpTimer           _wtimer;    // Clock for Withdrawls
};

#endif // __RIP_REDIST_HH__