xorp

unexpanded_xrl.hh

00001 // -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
00002 
00003 // Copyright (c) 2001-2009 XORP, Inc.
00004 //
00005 // This program is free software; you can redistribute it and/or modify
00006 // it under the terms of the GNU General Public License, Version 2, June
00007 // 1991 as published by the Free Software Foundation. Redistribution
00008 // and/or modification of this program under the terms of any other
00009 // version of the GNU General Public License is not permitted.
00010 // 
00011 // This program is distributed in the hope that it will be useful, but
00012 // WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For more details,
00014 // see the GNU General Public License, Version 2, a copy of which can be
00015 // found in the XORP LICENSE.gpl file.
00016 // 
00017 // XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
00018 // http://xorp.net
00019 
00020 // $XORP: xorp/rtrmgr/unexpanded_xrl.hh,v 1.15 2008/10/02 21:58:26 bms Exp $
00021 
00022 #ifndef __RTRMGR_UNEXPANDED_XRL_HH__
00023 #define __RTRMGR_UNEXPANDED_XRL_HH__
00024 
00025 
00026 #include "libxipc/xrl_router.hh"
00027 
00028 
00029 class MasterConfigTreeNode;
00030 class XrlAction;
00031 
00032 //
00033 // We want to build a queue of XRLs, but the variables needed for those
00034 // XRLs may depend on the results from previous XRLs.  So we need to
00035 // delay expanding them until we're actually going to send the XRL
00036 // request.
00037 //
00038 
00039 class UnexpandedXrl {
00040 public:
00041     UnexpandedXrl(const MasterConfigTreeNode& node, const XrlAction& action);
00042     ~UnexpandedXrl();
00043 
00052     Xrl* expand(string& errmsg) const;
00053 
00059     string return_spec() const;
00060 
00061     string str() const;
00062 
00063 private:
00064     const MasterConfigTreeNode& _node;
00065     const XrlAction& _action;
00066 
00067     // _xrl is mutable because expanding the XRL doesn't conceptually
00068     // change the UnexpandedXrl - storing the result here is purely an
00069     // optimization.
00070     mutable Xrl* _xrl;
00071 };
00072 
00073 #endif // __RTRMGR_UNEXPANDED_XRL_HH__
 All Classes Namespaces Functions Variables Typedefs Enumerations