// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// vim:set sts=4 ts=8:
// Copyright (c) 2001-2009 XORP, Inc.
//
// 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/ospf/io.hh,v 1.32 2009/01/05 18:31:01 jtc Exp $
#ifndef __OSPF_IO_HH__
#define __OSPF_IO_HH__
/**
* An abstract class that defines packet reception and
* transmission. The details of how packets are received or transmitted
* are therefore hidden from the internals of the OSPF code.
*/
template <typename A>
class IO : public ServiceBase {
public:
IO() : _ip_router_alert(false)
{}
virtual ~IO() {}
/**
* Get OSPF protocol number.
*/
uint16_t get_ip_protocol_number() const {
return OspfTypes::IP_PROTOCOL_NUMBER;
}
/**
* Send Raw frames.
*/
virtual bool send(const string& interface, const string& vif,
A dst, A src,
int ttl, uint8_t* data, uint32_t len) = 0;
/**
* Send router alerts in IP packets?
*/
bool set_ip_router_alert(bool alert) {
_ip_router_alert = alert;
return true;
}
/**
* Get router alert state.
*/
bool get_ip_router_alert() const { return _ip_router_alert; }
typedef typename XorpCallback6<void, const string&, const string&,
A, A,
uint8_t*,
uint32_t>::RefPtr ReceiveCallback;
/**
* Register for receiving raw frames.
*/
void register_receive(ReceiveCallback cb) { _receive_cb = cb; }
/**
* Enable the interface/vif to receive frames.
*/
virtual bool enable_interface_vif(const string& interface,
const string& vif) = 0;
/**
* Disable this interface/vif from receiving frames.
*/
virtual bool disable_interface_vif(const string& interface,
const string& vif) = 0;
/**
* Test whether this interface is enabled.
*
* @return true if it exists and is enabled, otherwise false.
*/
virtual bool is_interface_enabled(const string& interface) const = 0;
/**
* Test whether this interface/vif is enabled.
*
* @return true if it exists and is enabled, otherwise false.
*/
virtual bool is_vif_enabled(const string& interface,
const string& vif) const = 0;
/**
* Test whether this interface/vif/address is enabled.
*
* @return true if it exists and is enabled, otherwise false.
*/
virtual bool is_address_enabled(const string& interface, const string& vif,
const A& address) const = 0;
typedef typename XorpCallback2<void, const string&,
bool>::RefPtr InterfaceStatusCb;
typedef typename XorpCallback3<void, const string&, const string&,
bool>::RefPtr VifStatusCb;
typedef typename XorpCallback4<void, const string&, const string&, A,
bool>::RefPtr AddressStatusCb;
/**
* Add a callback for tracking the interface status.
*
* The callback will be invoked whenever the status of the interface
* is changed from disabled to enabled or vice-versa.
*
* @param cb the callback to register.
*/
void register_interface_status(InterfaceStatusCb cb) {
_interface_status_cb = cb;
}
/**
* Add a callback for tracking the interface/vif status.
*
* The callback will be invoked whenever the status of the interface/vif
* is changed from disabled to enabled or vice-versa.
*
* @param cb the callback to register.
*/
void register_vif_status(VifStatusCb cb) {
_vif_status_cb = cb;
}
/**
* Add a callback for tracking the interface/vif/address status.
*
* The callback will be invoked whenever the status of the tuple
* (interface, vif, address) is changed from disabled to enabled
* or vice-versa.
*
* @param cb the callback to register.
*/
void register_address_status(AddressStatusCb cb) {
_address_status_cb = cb;
}
/**
* Get all addresses associated with this interface/vif.
*
* @param interface the name of the interface
* @param vif the name of the vif
* @param addresses (out argument) list of associated addresses
*
* @return true if there are no errors.
*/
virtual bool get_addresses(const string& interface,
const string& vif,
list<A>& addresses) const = 0;
/**
* Get a link local address for this interface/vif if available.
*
* @param interface the name of the interface
* @param vif the name of the vif
* @param address (out argument) set if address is found.
*
* @return true if a link local address is available.
*/
virtual bool get_link_local_address(const string& interface,
const string& vif,
A& address) = 0;
/**
* @return the interface id for this interface.
*/
virtual bool get_interface_id(const string& interface,
uint32_t& interface_id) = 0;
/**
* @return prefix length for this address.
*/
virtual uint32_t get_prefix_length(const string& interface,
const string& vif,
A address) = 0;
/**
* @return the mtu for this interface.
*/
virtual uint32_t get_mtu(const string& interface) = 0;
/**
* On the interface/vif join this multicast group.
*/
virtual bool join_multicast_group(const string& interface,
const string& vif, A mcast) = 0;
/**
* On the interface/vif leave this multicast group.
*/
virtual bool leave_multicast_group(const string& interface,
const string& vif, A mcast) = 0;
/**
* Add route
*
* @param net network
* @param nexthop
* @param nexthop_id interface ID towards the nexthop
* @param metric to network
* @param equal true if this in another route to the same destination.
* @param discard true if this is a discard route.
* @param policytags policy info to the RIB.
*/
virtual bool add_route(IPNet<A> net,
A nexthop,
uint32_t nexthop_id,
uint32_t metric,
bool equal,
bool discard, const PolicyTags& policytags) = 0;
/**
* Replace route
*
* @param net network
* @param nexthop
* @param nexthop_id interface ID towards the nexthop
* @param metric to network
* @param equal true if this in another route to the same destination.
* @param discard true if this is a discard route.
* @param policytags policy info to the RIB.
*/
virtual bool replace_route(IPNet<A> net,
A nexthop,
uint32_t nexthop_id,
uint32_t metric,
bool equal,
bool discard, const PolicyTags& policytags) = 0;
/**
* Delete route
*/
virtual bool delete_route(IPNet<A> net) = 0;
/**
* Store a mapping of the OSPF internal interface ID to
* interface/vif. This will be required by when installing a route.
*/
void set_interface_mapping(uint32_t interface_id, const string& interface,
const string& vif) {
interface_vif iv;
iv._interface_name = interface;
iv._vif_name = vif;
_interface_vif[interface_id] = iv;
}
/**
* Given an OSPF internal interface ID return the interface/vif.
*/
bool get_interface_vif_by_interface_id(uint32_t interface_id,
string& interface, string& vif) {
if (0 == _interface_vif.count(interface_id))
return false;
interface_vif iv = _interface_vif[interface_id];
interface = iv._interface_name;
vif = iv._vif_name;
return true;
}
protected:
ReceiveCallback _receive_cb;
InterfaceStatusCb _interface_status_cb;
VifStatusCb _vif_status_cb;
AddressStatusCb _address_status_cb;
bool _ip_router_alert;
struct interface_vif {
string _interface_name;
string _vif_name;
};
map<uint32_t, interface_vif> _interface_vif;
};
#endif // __OSPF_IO_HH__
Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:11:07 2009, using kdoc 2.0a54+XORP.
