Source: ../../fea/firewall_set.hh
|
|
|
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2008 XORP, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software")
// to deal in the Software without restriction, subject to the conditions
// listed in the XORP LICENSE file. These conditions include: you must
// preserve this copyright notice, and you cannot mention the copyright
// holders in advertising related to the Software without their permission.
// The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
// notice is a summary of the XORP LICENSE file; the license in that file is
// legally binding.
// $XORP: xorp/fea/firewall_set.hh,v 1.4 2008/07/23 05:10:08 pavlin Exp $
#ifndef __FEA_FIREWALL_SET_HH__
#define __FEA_FIREWALL_SET_HH__
#include "firewall_entry.hh"
#include "iftree.hh"
#include "fea_data_plane_manager.hh"
class FirewallManager;
class FirewallSet {
public:
/**
* Constructor.
*
* @param fea_data_plane_manager the corresponding data plane manager
* (@ref FeaDataPlaneManager).
*/
FirewallSet(FeaDataPlaneManager& fea_data_plane_manager)
: _is_running(false),
_firewall_manager(fea_data_plane_manager.firewall_manager()),
_fea_data_plane_manager(fea_data_plane_manager)
{}
/**
* Virtual destructor.
*/
virtual ~FirewallSet() {}
/**
* Get the @ref FirewallManager instance.
*
* @return the @ref FirewallManager instance.
*/
FirewallManager& firewall_manager() { return _firewall_manager; }
/**
* Get the @ref FeaDataPlaneManager instance.
*
* @return the @ref FeaDataPlaneManager instance.
*/
FeaDataPlaneManager& fea_data_plane_manager() { return _fea_data_plane_manager; }
/**
* Test whether this instance is running.
*
* @return true if the instance is running, otherwise false.
*/
virtual bool is_running() const { return _is_running; }
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg) = 0;
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg) = 0;
/**
* Update the firewall entries by pushing them into the underlying system.
*
* @param added_entries the entries to add.
* @param replaced_entries the entries to replace.
* @param deleted_entries the deleted entries.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int update_entries(const list<FirewallEntry>& added_entries,
const list<FirewallEntry>& replaced_entries,
const list<FirewallEntry>& deleted_entries,
string& error_msg) = 0;
/**
* Set the IPv4 firewall table.
*
* @param firewall_entry_list the list with all entries to install into
* the IPv4 firewall table.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int set_table4(const list<FirewallEntry>& firewall_entry_list,
string& error_msg) = 0;
/**
* Delete all entries in the IPv4 firewall table.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int delete_all_entries4(string& error_msg) = 0;
/**
* Set the IPv6 firewall table.
*
* @param firewall_entry_list the list with all entries to install into
* the IPv6 firewall table.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int set_table6(const list<FirewallEntry>& firewall_entry_list,
string& error_msg) = 0;
/**
* Delete all entries in the IPv6 firewall table.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int delete_all_entries6(string& error_msg) = 0;
protected:
// Misc other state
bool _is_running;
private:
FirewallManager& _firewall_manager;
FeaDataPlaneManager& _fea_data_plane_manager;
};
#endif // __FEA_FIREWALL_SET_HH__
Generated by: bms on anglepoise.lon.incunabulum.net on Wed Jul 23 10:05:50 2008, using kdoc 2.0a54+XORP.