xorp

fibconfig_entry_set.hh

00001 // -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
00002 
00003 // Copyright (c) 2001-2011 XORP, Inc and Others
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/fea/fibconfig_entry_set.hh,v 1.17 2008/10/02 21:56:45 bms Exp $
00021 
00022 #ifndef __FEA_FIBCONFIG_ENTRY_SET_HH__
00023 #define __FEA_FIBCONFIG_ENTRY_SET_HH__
00024 
00025 #include "fte.hh"
00026 #include "iftree.hh"
00027 #include "fea_data_plane_manager.hh"
00028 
00029 class FibConfig;
00030 
00031 
00032 class FibConfigEntrySet {
00033 public:
00040     FibConfigEntrySet(FeaDataPlaneManager& fea_data_plane_manager)
00041     : _is_running(false),
00042       _fibconfig(fea_data_plane_manager.fibconfig()),
00043       _fea_data_plane_manager(fea_data_plane_manager),
00044       _in_configuration(false)
00045     {}
00046 
00050     virtual ~FibConfigEntrySet() {}
00051 
00057     FibConfig&  fibconfig() { return _fibconfig; }
00058 
00064     FeaDataPlaneManager& fea_data_plane_manager() { return _fea_data_plane_manager; }
00065 
00071     virtual bool is_running() const { return _is_running; }
00072 
00079     virtual int start(string& error_msg) = 0;
00080     
00087     virtual int stop(string& error_msg) = 0;
00088     
00101     virtual int start_configuration(string& error_msg) {
00102     // Nothing particular to do, just label start.
00103     return mark_configuration_start(error_msg);
00104     }
00105 
00116     virtual int end_configuration(string& error_msg) {
00117     // Nothing particular to do, just label start.
00118     return mark_configuration_end(error_msg);
00119     }
00120     
00129     virtual int add_entry4(const Fte4& fte) = 0;
00130 
00139     virtual int delete_entry4(const Fte4& fte) = 0;
00140 
00149     virtual int add_entry6(const Fte6& fte) = 0;
00150 
00159     virtual int delete_entry6(const Fte6& fte) = 0;
00160 
00164     virtual int notify_table_id_change(uint32_t new_tbl) = 0;
00165 
00166 protected:
00173     int mark_configuration_start(string& error_msg) {
00174     if (_in_configuration != true) {
00175         _in_configuration = true;
00176         return (XORP_OK);
00177     }
00178     error_msg = c_format("Cannot start configuration: "
00179                  "configuration in progress");
00180     return (XORP_ERROR);
00181     }
00182 
00189     int mark_configuration_end(string& error_msg) {
00190     if (_in_configuration != false) {
00191         _in_configuration = false;
00192         return (XORP_OK);
00193     }
00194     error_msg = c_format("Cannot end configuration: "
00195                  "configuration not in progress");
00196     return (XORP_ERROR);
00197     }
00198     
00199     bool in_configuration() const { return _in_configuration; }
00200 
00201     // Misc other state
00202     bool    _is_running;
00203 
00204 private:
00205     FibConfig&      _fibconfig;
00206     FeaDataPlaneManager& _fea_data_plane_manager;
00207     bool        _in_configuration;
00208 };
00209 
00210 #endif // __FEA_FIBCONFIG_ENTRY_SET_HH__
 All Classes Namespaces Functions Variables Typedefs Enumerations