ifconfig_reporter.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-

// 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/fea/ifconfig_reporter.hh,v 1.9 2008/10/02 21:56:47 bms Exp $

#ifndef __FEA_IFCONFIG_REPORTER_HH__
#define __FEA_IFCONFIG_REPORTER_HH__


//
// Mechanism for reporting network interface related information to
// interested parties.
//



class IfConfigUpdateReplicator;
class IfTree;
class IPv4;
#ifdef HAVE_IPV6
class IPv6;
#endif

class IfConfigUpdateReporterBase {
public:
    enum Update { CREATED, DELETED, CHANGED };

    IfConfigUpdateReporterBase(IfConfigUpdateReplicator& update_replicator);

    IfConfigUpdateReporterBase(IfConfigUpdateReplicator& update_replicator,
                   const IfTree& observed_iftree);

    virtual ~IfConfigUpdateReporterBase() {}

    const IfTree& observed_iftree() const { return (_observed_iftree); }

    void add_to_replicator();

    void remove_from_replicator();

    virtual void interface_update(const string& ifname,
                  const Update& u) = 0;

    virtual void vif_update(const string& ifname,
                const string& vifname,
                const Update& u) = 0;

    virtual void vifaddr4_update(const string& ifname,
                 const string& vifname,
                 const IPv4&   addr,
                 const Update& u) = 0;

#ifdef HAVE_IPV6
    virtual void vifaddr6_update(const string& ifname,
                 const string& vifname,
                 const IPv6&   addr,
                 const Update& u) = 0;
#endif

    virtual void updates_completed() = 0;

private:
    IfConfigUpdateReplicator& _update_replicator;
    const IfTree&   _observed_iftree;
};

class IfConfigUpdateReplicator : public IfConfigUpdateReporterBase {
public:
    typedef IfConfigUpdateReporterBase::Update Update;

public:
    IfConfigUpdateReplicator(const IfTree& observed_iftree)
    : IfConfigUpdateReporterBase(*this, observed_iftree)
    {}
    virtual ~IfConfigUpdateReplicator();

    int add_reporter(IfConfigUpdateReporterBase* rp);

    int remove_reporter(IfConfigUpdateReporterBase* rp);

    void interface_update(const string& ifname,
              const Update& u);

    void vif_update(const string& ifname,
            const string& vifname,
            const Update& u);

    void vifaddr4_update(const string& ifname,
             const string& vifname,
             const IPv4&   addr,
             const Update& u);

#ifdef HAVE_IPV6

    void vifaddr6_update(const string& ifname,
             const string& vifname,
             const IPv6&   addr,
             const Update& u);
#endif

    void updates_completed();

protected:
    list<IfConfigUpdateReporterBase*> _reporters;
};

class IfConfigErrorReporterBase {
public:
    IfConfigErrorReporterBase() : _error_cnt(0) {}
    virtual ~IfConfigErrorReporterBase() {}

    virtual void config_error(const string& error_msg) = 0;

    virtual void interface_error(const string& ifname,
                 const string& error_msg) = 0;

    virtual void vif_error(const string& ifname,
               const string& vifname,
               const string& error_msg) = 0;

    virtual void vifaddr_error(const string& ifname,
                   const string& vifname,
                   const IPv4&   addr,
                   const string& error_msg) = 0;

#ifdef HAVE_IPV6
    virtual void vifaddr_error(const string& ifname,
                   const string& vifname,
                   const IPv6&   addr,
                   const string& error_msg) = 0;
#endif

    const string& first_error() const       { return _first_error; }

    const string& last_error() const        { return _last_error; }

    uint32_t error_count() const        { return _error_cnt; }

    void reset() {
    _first_error.erase();
    _last_error.erase();
    _error_cnt = 0;
    }

    void log_error(const string& s) {
    if (0 == _error_cnt)
        _first_error = s;
    _last_error = s;
    _error_cnt++;
    }

private:
    string  _last_error;    // last error reported
    string  _first_error;   // first error reported

    uint32_t    _error_cnt; // number of errors reported
};

class IfConfigErrorReporter : public IfConfigErrorReporterBase {
public:
    IfConfigErrorReporter();

    void config_error(const string& error_msg);

    void interface_error(const string& ifname,
             const string& error_msg);

    void vif_error(const string& ifname,
           const string& vifname,
           const string& error_msg);

    void vifaddr_error(const string& ifname,
               const string& vifname,
               const IPv4&   addr,
               const string& error_msg);

#ifdef HAVE_IPV6
    void vifaddr_error(const string& ifname,
               const string& vifname,
               const IPv6&   addr,
               const string& error_msg);
#endif

private:
};

#endif // __FEA_IFCONFIG_REPORTER_HH__