cfibentry.h

/*
 * cfibentry.h
 *
 *  Created on: 15.07.2013
 *      Author: andreas
 */

#ifndef CFIBENTRY_H_
#define CFIBENTRY_H_ 1

#include <ostream>
#include <inttypes.h>

#include <rofl/common/ciosrv.h>
#include <rofl/common/caddress.h>
#include <rofl/common/crofbase.h>
#include <rofl/common/crofdpt.h>
#include <rofl/common/logging.h>
#include <rofl/common/ctimerid.h>

namespace rofl {
namespace examples {
namespace ethswctld {

namespace exceptions {

class eFibBase                  : public std::runtime_error {
public:
        eFibBase(const std::string& __arg) : std::runtime_error(__arg) {};
};

class eFibInval                 : public eFibBase {
public:
        eFibInval(const std::string& __arg) : eFibBase(__arg) {};
};

class eFibNotFound              : public eFibBase {
public:
        eFibNotFound(const std::string& __arg) : eFibBase(__arg) {};
};

}; // namespace exceptions


class cfibentry; // forward declaration


class cfibentry_env {
        friend class cfibentry;
public:

        virtual
        ~cfibentry_env()
        {};

protected:

        virtual void
        fib_timer_expired(
                        const rofl::caddress_ll& hwaddr) = 0;

        virtual void
        fib_port_update(
                        const cfibentry& entry) = 0;
};



class cfibentry : public rofl::ciosrv {
public:

        cfibentry(
                        cfibentry_env *env,
                        const rofl::cdptid& dptid,
                        const rofl::caddress_ll& hwaddr,
                        uint32_t port_no);

        virtual
        ~cfibentry();

public:

        uint32_t
        get_port_no() const
        { return port_no; };

        void
        set_port_no(uint32_t port_no);

        const rofl::caddress_ll&
        get_hwaddr() const
        { return hwaddr; };

private:

        virtual void
        handle_timeout(
                        int opaque,
                        void* data = (void*)NULL);

public:

        friend std::ostream&
        operator<< (std::ostream& os, cfibentry const& entry) {
                os << rofl::indent(0) << "<cfibentry portno: "
                                << entry.port_no << " >" << std::endl;
                rofl::indent i(2);
                os << entry.hwaddr;
                return os;
        };

private:

#define CFIBENTRY_DEFAULT_TIMEOUT               60

        enum cfibentry_timer_t {
                CFIBENTRY_ENTRY_EXPIRED = 1,
        };

        // pointer to class defining the environment for this cfibentry
        cfibentry_env*              env;
        // rofl-common's internal datapath handle
        rofl::cdptid                dptid;

        // OpenFlow port number pointing towards port
        uint32_t                    port_no;
        // station ethernet hardware address
        rofl::caddress_ll           hwaddr;

        // timeout value in seconds for this FIB entry
        int                         entry_timeout;
        // timer handle obtained from rofl::ciosrv when registering this timer
        rofl::ctimerid              expiration_timer_id;
};

}; // namespace ethswctld
}; // namespace examples
}; // namespace rofl

#endif /* CFIBENTRY_H_ */