Source: ../../fea/ifconfig_observer.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/ifconfig_observer.hh,v 1.18 2007/02/16 22:45:43 pavlin Exp $
#ifndef __FEA_IFCONFIG_OBSERVER_HH__
#define __FEA_IFCONFIG_OBSERVER_HH__
#include "netlink_socket.hh"
#include "routing_socket.hh"
class IfConfig;
class IfTree;
class IfConfigObserver {
public:
IfConfigObserver(IfConfig& ifc);
virtual ~IfConfigObserver();
IfConfig& ifc() { return _ifc; }
virtual void register_ifc_primary();
virtual void register_ifc_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;
/**
* Receive data from the underlying system.
*
* @param buffer the buffer with the received data.
*/
virtual void receive_data(const vector<uint8_t>& buffer) = 0;
protected:
// Misc other state
bool _is_running;
private:
IfConfig& _ifc;
bool _is_primary; // True -> primary, false -> secondary method
};
class IfConfigObserverDummy : public IfConfigObserver {
public:
IfConfigObserverDummy(IfConfig& ifc);
virtual ~IfConfigObserverDummy();
/**
* 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);
/**
* Receive data from the underlying system.
*
* @param buffer the buffer with the received data.
*/
virtual void receive_data(const vector<uint8_t>& buffer);
private:
};
class IfConfigObserverRtsock : public IfConfigObserver,
public RoutingSocket,
public RoutingSocketObserver {
public:
IfConfigObserverRtsock(IfConfig& ifc);
virtual ~IfConfigObserverRtsock();
/**
* 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);
/**
* Receive data from the underlying system.
*
* @param buffer the buffer with the received data.
*/
virtual void receive_data(const vector<uint8_t>& buffer);
void rtsock_data(const vector<uint8_t>& buffer);
private:
};
class IfConfigObserverNetlink : public IfConfigObserver,
public NetlinkSocket,
public NetlinkSocketObserver {
public:
IfConfigObserverNetlink(IfConfig& ifc);
virtual ~IfConfigObserverNetlink();
/**
* 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);
/**
* Receive data from the underlying system.
*
* @param buffer the buffer with the received data.
*/
virtual void receive_data(const vector<uint8_t>& buffer);
void nlsock_data(const vector<uint8_t>& buffer);
private:
};
class IfConfigObserverIPHelper : public IfConfigObserver {
public:
IfConfigObserverIPHelper(IfConfig& ifc);
virtual ~IfConfigObserverIPHelper();
/**
* 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);
/**
* Receive data from the underlying system.
*
* @param buffer the buffer with the received data.
*/
virtual void receive_data(const vector<uint8_t>& buffer);
};
#endif // __FEA_IFCONFIG_OBSERVER_HH__
Generated by: pavlin on possum.icir.org on Wed Mar 21 11:23:22 2007, using kdoc $.