Source: ../../fea/fticonfig_entry_get.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_entry_get.hh,v 1.28 2007/02/16 22:45:37 pavlin Exp $
#ifndef __FEA_FTICONFIG_ENTRY_GET_HH__
#define __FEA_FTICONFIG_ENTRY_GET_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 IPv4;
class IPv6;
class FtiConfig;
class FtiConfigEntryGet {
public:
FtiConfigEntryGet(FtiConfig& ftic);
virtual ~FtiConfigEntryGet();
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;
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return bool on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte) = 0;
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte) = 0;
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte) = 0;
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte) = 0;
/**
* Parse information about routing entry information received from
* the underlying system.
*
* The information to parse is in RTM format
* (e.g., obtained by routing sockets or by sysctl(3) mechanism).
*
* @param fte the Fte storage to store the parsed information.
* @param buffer the buffer with the data to parse.
* @param filter the set of messages that caller is interested in.
* @return true on success, otherwise false.
* @see FteX.
*/
bool parse_buffer_rtm(FteX& fte, const vector<uint8_t>& buffer,
FtiFibMsgSet filter);
/**
* Parse information about routing entry information received from
* the underlying system.
*
* The information to parse is in NETLINK format
* (e.g., obtained by netlink(7) sockets mechanism).
*
* @param fte the Fte storage to store the parsed information.
* @param buffer the buffer with the data to parse.
* @param is_nlm_get_only if true, consider only the entries obtained
* by RTM_GETROUTE.
* @return true on success, otherwise false.
* @see FteX.
*/
bool parse_buffer_nlm(FteX& fte, const vector<uint8_t>& buffer,
bool is_nlm_get_only);
protected:
int sock(int family);
int _s4;
int _s6;
// Misc other stat
bool _is_running;
private:
FtiConfig& _ftic;
bool _is_primary; // True -> primary, false -> secondary method
};
class FtiConfigEntryGetDummy : public FtiConfigEntryGet {
public:
FtiConfigEntryGetDummy(FtiConfig& ftic);
virtual ~FtiConfigEntryGetDummy();
/**
* 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);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte);
private:
};
class FtiConfigEntryGetRtsock : public FtiConfigEntryGet,
public RoutingSocket {
public:
FtiConfigEntryGetRtsock(FtiConfig& ftic);
virtual ~FtiConfigEntryGetRtsock();
/**
* 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);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte);
private:
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest(const IPvX& dst, FteX& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network(const IPvXNet& dst, FteX& fte);
RoutingSocketReader _rs_reader;
};
class FtiConfigEntryGetNetlink : public FtiConfigEntryGet,
public NetlinkSocket {
public:
FtiConfigEntryGetNetlink(FtiConfig& ftic);
virtual ~FtiConfigEntryGetNetlink();
/**
* 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);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte);
private:
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest(const IPvX& dst, FteX& fte);
NetlinkSocketReader _ns_reader;
};
class FtiConfigEntryGetClick : public FtiConfigEntryGet,
public ClickSocket {
public:
FtiConfigEntryGetClick(FtiConfig& ftic);
virtual ~FtiConfigEntryGetClick();
/**
* 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);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte);
private:
ClickSocketReader _cs_reader;
};
class FtiConfigEntryGetIPHelper : public FtiConfigEntryGet {
public:
FtiConfigEntryGetIPHelper(FtiConfig& ftic);
virtual ~FtiConfigEntryGetIPHelper();
/**
* 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);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte);
private:
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest(const IPvX& dst, FteX& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network(const IPvXNet& dst, FteX& fte);
};
class FtiConfigEntryGetRtmV2 : public FtiConfigEntryGet {
public:
FtiConfigEntryGetRtmV2(FtiConfig& ftic);
virtual ~FtiConfigEntryGetRtmV2();
/**
* 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);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest4(const IPv4& dst, Fte4& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network4(const IPv4Net& dst, Fte4& fte);
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest6(const IPv6& dst, Fte6& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network6(const IPv6Net& dst, Fte6& fte);
private:
/**
* Lookup a route by destination address.
*
* @param dst host address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_dest(const IPvX& dst, FteX& fte);
/**
* Lookup route by network address.
*
* @param dst network address to resolve.
* @param fte return-by-reference forwarding table entry.
*
* @return true on success, otherwise false.
*/
virtual bool lookup_route_by_network(const IPvXNet& dst, FteX& fte);
};
#endif // __FEA_FTICONFIG_ENTRY_GET_HH__
Generated by: pavlin on possum.icir.org on Wed Mar 21 11:23:22 2007, using kdoc $.
