Source: ../../fea/fticonfig_table_set.hh
|
|
|
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001-2007 International Computer Science Institute
//
// 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/fticonfig_table_set.hh,v 1.20 2007/02/16 22:45:40 pavlin Exp $
#ifndef __FEA_FTICONFIG_TABLE_SET_HH__
#define __FEA_FTICONFIG_TABLE_SET_HH__
#include "libxorp/xorp.h"
#include "libxorp/ipvx.hh"
#include "fte.hh"
#include "click_socket.hh"
#include "netlink_socket.hh"
#include "routing_socket.hh"
class FtiConfig;
class FtiConfigTableSet {
public:
FtiConfigTableSet(FtiConfig& ftic);
virtual ~FtiConfigTableSet();
FtiConfig& ftic() { return _ftic; }
virtual void register_ftic_primary();
virtual void register_ftic_secondary();
virtual void set_primary() { _is_primary = true; }
virtual void set_secondary() { _is_primary = false; }
virtual bool is_primary() const { return _is_primary; }
virtual bool is_secondary() const { return !_is_primary; }
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;
/**
* Start a configuration interval. All modifications to FtiConfig
* state must be within a marked "configuration" interval.
*
* This method provides derived classes with a mechanism to perform
* any actions necessary before forwarding table modifications can
* be made.
*
* @param error_msg the error message (if error).
* @return true if configuration successfully started.
*/
virtual bool start_configuration(string& error_msg) {
// Nothing particular to do, just label start.
return mark_configuration_start(error_msg);
}
/**
* End of configuration interval.
*
* This method provides derived classes with a mechanism to
* perform any actions necessary at the end of a configuration, eg
* write a file.
*
* @param error_msg the error message (if error).
* @return true configuration success pushed down into forwarding table.
*/
virtual bool end_configuration(string& error_msg) {
// Nothing particular to do, just label start.
return mark_configuration_end(error_msg);
}
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list) = 0;
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4() = 0;
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list) = 0;
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6() = 0;
protected:
/**
* Mark start of a configuration.
*
* @param error_msg the error message (if error).
* @return true if configuration can be marked as started, false otherwise.
*/
inline bool mark_configuration_start(string& error_msg) {
if (false == _in_configuration) {
_in_configuration = true;
return true;
}
error_msg = c_format("Cannot start configuration: "
"configuration in progress");
return false;
}
/**
* Mark end of a configuration.
*
* @param error_msg the error message (if error).
* @return true if configuration can be marked as ended, false otherwise.
*/
inline bool mark_configuration_end(string& error_msg) {
if (true == _in_configuration) {
_in_configuration = false;
return true;
}
error_msg = c_format("Cannot end configuration: "
"configuration not in progress");
return false;
}
inline bool in_configuration() const { return _in_configuration; }
// Misc other state
bool _is_running;
private:
FtiConfig& _ftic;
bool _in_configuration;
bool _is_primary; // True -> primary, false -> secondary method
};
class FtiConfigTableSetDummy : public FtiConfigTableSet {
public:
FtiConfigTableSetDummy(FtiConfig& ftic);
virtual ~FtiConfigTableSetDummy();
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg);
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg);
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4();
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6();
private:
};
class FtiConfigTableSetRtsock : public FtiConfigTableSet {
public:
FtiConfigTableSetRtsock(FtiConfig& ftic);
virtual ~FtiConfigTableSetRtsock();
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg);
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg);
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4();
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6();
private:
};
class FtiConfigTableSetNetlink : public FtiConfigTableSet {
public:
FtiConfigTableSetNetlink(FtiConfig& ftic);
virtual ~FtiConfigTableSetNetlink();
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg);
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg);
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4();
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6();
private:
};
class FtiConfigTableSetClick : public FtiConfigTableSet,
public ClickSocket {
public:
FtiConfigTableSetClick(FtiConfig& ftic);
virtual ~FtiConfigTableSetClick();
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg);
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg);
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4();
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6();
private:
ClickSocketReader _cs_reader;
};
class FtiConfigTableSetIPHelper : public FtiConfigTableSet {
public:
FtiConfigTableSetIPHelper(FtiConfig& ftic);
virtual ~FtiConfigTableSetIPHelper();
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg);
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg);
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4();
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6();
};
class FtiConfigTableSetRtmV2 : public FtiConfigTableSet {
public:
FtiConfigTableSetRtmV2(FtiConfig& ftic);
virtual ~FtiConfigTableSetRtmV2();
/**
* Start operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int start(string& error_msg);
/**
* Stop operation.
*
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
virtual int stop(string& error_msg);
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table4(const list<Fte4>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries4();
/**
* Set the unicast forwarding table.
*
* @param fte_list the list with all entries to install into
* the unicast forwarding table.
*
* @return true on success, otherwise false.
*/
virtual bool set_table6(const list<Fte6>& fte_list);
/**
* Delete all entries in the routing table. Must be within a
* configuration interval.
*
* @return true on success, otherwise false.
*/
virtual bool delete_all_entries6();
private:
};
#endif // __FEA_FTICONFIG_TABLE_SET_HH__
Generated by: pavlin on possum.icir.org on Wed Mar 21 11:23:22 2007, using kdoc $.
