xorp

XrlOspfv2TargetBase Class Reference

Inheritance diagram for XrlOspfv2TargetBase:
XrlOspfV2Target

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlOspfv2TargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlOspfv2TargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.
 XrlOspfv2TargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlOspfv2TargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.

Protected Member Functions

virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError raw_packet4_client_0_1_recv (const string &if_name, const string &vif_name, const IPv4 &src_address, const IPv4 &dst_address, const uint32_t &ip_protocol, const int32_t &ip_ttl, const int32_t &ip_tos, const bool &ip_router_alert, const bool &ip_internet_control, const vector< uint8_t > &payload)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_backend_0_1_configure (const uint32_t &filter, const string &conf)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_backend_0_1_reset (const uint32_t &filter)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_backend_0_1_push_routes ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_redist4_0_1_add_route4 (const IPv4Net &network, const bool &unicast, const bool &multicast, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_redist4_0_1_delete_route4 (const IPv4Net &network, const bool &unicast, const bool &multicast)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_router_id (const IPv4 &id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_rfc1583_compatibility (const bool &compatibility)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_ip_router_alert (const bool &ip_router_alert)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_create_area_router (const IPv4 &area, const string &type)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_change_area_router_type (const IPv4 &area, const string &type)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_destroy_area_router (const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_create_peer (const string &ifname, const string &vifname, const IPv4 &addr, const string &type, const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_peer (const string &ifname, const string &vifname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_peer_state (const string &ifname, const string &vifname, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_add_neighbour (const string &ifname, const string &vifname, const IPv4 &area, const IPv4 &neighbour_address, const IPv4 &neighbour_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_remove_neighbour (const string &ifname, const string &vifname, const IPv4 &area, const IPv4 &neighbour_address, const IPv4 &neighbour_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_create_virtual_link (const IPv4 &neighbour_id, const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_virtual_link (const IPv4 &neighbour_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_transit_area_virtual_link (const IPv4 &neighbour_id, const IPv4 &transit_area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_interface_cost (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &cost)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_retransmit_interval (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &interval)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_inftransdelay (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &delay)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_router_priority (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &priority)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_hello_interval (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &interval)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_router_dead_interval (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &interval)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_simple_authentication_key (const string &ifname, const string &vifname, const IPv4 &area, const string &password)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_simple_authentication_key (const string &ifname, const string &vifname, const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_md5_authentication_key (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &key_id, const string &password, const string &start_time, const string &end_time, const uint32_t &max_time_drift)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_md5_authentication_key (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &key_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_passive (const string &ifname, const string &vifname, const IPv4 &area, const bool &passive, const bool &host)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_originate_default_route (const IPv4 &area, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_stub_default_cost (const IPv4 &area, const uint32_t &cost)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_summaries (const IPv4 &area, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_area_range_add (const IPv4 &area, const IPv4Net &net, const bool &advertise)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_area_range_delete (const IPv4 &area, const IPv4Net &net)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_area_range_change_state (const IPv4 &area, const IPv4Net &net, const bool &advertise)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_trace (const string &tvar, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_lsa (const IPv4 &area, const uint32_t &index, bool &valid, bool &toohigh, bool &self, vector< uint8_t > &lsa)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_area_list (XrlAtomList &areas)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_neighbour_list (XrlAtomList &areas)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_neighbour_info (const uint32_t &nid, string &address, string &interface, string &state, IPv4 &rid, uint32_t &priority, uint32_t &deadtime, IPv4 &area, uint32_t &opt, IPv4 &dr, IPv4 &bdr, uint32_t &up, uint32_t &adjacent)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_clear_database ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError raw_packet4_client_0_1_recv (const string &if_name, const string &vif_name, const IPv4 &src_address, const IPv4 &dst_address, const uint32_t &ip_protocol, const int32_t &ip_ttl, const int32_t &ip_tos, const bool &ip_router_alert, const bool &ip_internet_control, const vector< uint8_t > &payload)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_backend_0_1_configure (const uint32_t &filter, const string &conf)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_backend_0_1_reset (const uint32_t &filter)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_backend_0_1_push_routes ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_redist4_0_1_add_route4 (const IPv4Net &network, const bool &unicast, const bool &multicast, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_redist4_0_1_delete_route4 (const IPv4Net &network, const bool &unicast, const bool &multicast)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_router_id (const IPv4 &id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_rfc1583_compatibility (const bool &compatibility)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_ip_router_alert (const bool &ip_router_alert)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_create_area_router (const IPv4 &area, const string &type)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_change_area_router_type (const IPv4 &area, const string &type)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_destroy_area_router (const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_create_peer (const string &ifname, const string &vifname, const IPv4 &addr, const string &type, const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_peer (const string &ifname, const string &vifname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_peer_state (const string &ifname, const string &vifname, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_add_neighbour (const string &ifname, const string &vifname, const IPv4 &area, const IPv4 &neighbour_address, const IPv4 &neighbour_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_remove_neighbour (const string &ifname, const string &vifname, const IPv4 &area, const IPv4 &neighbour_address, const IPv4 &neighbour_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_create_virtual_link (const IPv4 &neighbour_id, const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_virtual_link (const IPv4 &neighbour_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_transit_area_virtual_link (const IPv4 &neighbour_id, const IPv4 &transit_area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_interface_cost (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &cost)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_retransmit_interval (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &interval)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_inftransdelay (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &delay)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_router_priority (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &priority)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_hello_interval (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &interval)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_router_dead_interval (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &interval)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_simple_authentication_key (const string &ifname, const string &vifname, const IPv4 &area, const string &password)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_simple_authentication_key (const string &ifname, const string &vifname, const IPv4 &area)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_md5_authentication_key (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &key_id, const string &password, const string &start_time, const string &end_time, const uint32_t &max_time_drift)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_delete_md5_authentication_key (const string &ifname, const string &vifname, const IPv4 &area, const uint32_t &key_id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_set_passive (const string &ifname, const string &vifname, const IPv4 &area, const bool &passive, const bool &host)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_originate_default_route (const IPv4 &area, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_stub_default_cost (const IPv4 &area, const uint32_t &cost)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_summaries (const IPv4 &area, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_area_range_add (const IPv4 &area, const IPv4Net &net, const bool &advertise)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_area_range_delete (const IPv4 &area, const IPv4Net &net)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_area_range_change_state (const IPv4 &area, const IPv4Net &net, const bool &advertise)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_trace (const string &tvar, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_lsa (const IPv4 &area, const uint32_t &index, bool &valid, bool &toohigh, bool &self, vector< uint8_t > &lsa)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_area_list (XrlAtomList &areas)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_neighbour_list (XrlAtomList &areas)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_get_neighbour_info (const uint32_t &nid, string &address, string &interface, string &state, IPv4 &rid, uint32_t &priority, uint32_t &deadtime, IPv4 &area, uint32_t &opt, IPv4 &dr, IPv4 &bdr, uint32_t &up, uint32_t &adjacent)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ospfv2_0_1_clear_database ()=0
 Pure-virtual function that needs to be implemented to:

Protected Attributes

XrlCmdMap_cmds

Private Member Functions

XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_raw_packet4_client_0_1_recv (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_backend_0_1_configure (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_backend_0_1_reset (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_backend_0_1_push_routes (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_redist4_0_1_add_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_redist4_0_1_delete_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_router_id (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_rfc1583_compatibility (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_ip_router_alert (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_create_area_router (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_change_area_router_type (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_destroy_area_router (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_create_peer (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_peer (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_peer_state (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_add_neighbour (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_remove_neighbour (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_create_virtual_link (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_virtual_link (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_transit_area_virtual_link (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_interface_cost (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_retransmit_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_inftransdelay (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_router_priority (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_hello_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_router_dead_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_simple_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_simple_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_md5_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_md5_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_passive (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_originate_default_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_stub_default_cost (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_summaries (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_area_range_add (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_area_range_delete (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_area_range_change_state (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_trace (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_lsa (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_area_list (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_neighbour_list (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_neighbour_info (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_clear_database (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()
XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_raw_packet4_client_0_1_recv (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_backend_0_1_configure (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_backend_0_1_reset (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_backend_0_1_push_routes (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_redist4_0_1_add_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_redist4_0_1_delete_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_router_id (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_rfc1583_compatibility (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_ip_router_alert (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_create_area_router (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_change_area_router_type (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_destroy_area_router (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_create_peer (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_peer (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_peer_state (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_add_neighbour (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_remove_neighbour (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_create_virtual_link (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_virtual_link (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_transit_area_virtual_link (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_interface_cost (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_retransmit_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_inftransdelay (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_router_priority (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_hello_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_router_dead_interval (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_simple_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_simple_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_md5_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_delete_md5_authentication_key (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_set_passive (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_originate_default_route (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_stub_default_cost (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_summaries (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_area_range_add (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_area_range_delete (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_area_range_change_state (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_trace (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_lsa (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_area_list (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_neighbour_list (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_get_neighbour_info (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ospfv2_0_1_clear_database (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()

Static Private Attributes

static struct handler_table handlers []
static const size_t num_handlers = (sizeof(XrlOspfv2TargetBase::handlers) / sizeof(XrlOspfv2TargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlOspfv2TargetBase::XrlOspfv2TargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
XrlOspfv2TargetBase::~XrlOspfv2TargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlOspfv2TargetBase::XrlOspfv2TargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
virtual XrlOspfv2TargetBase::~XrlOspfv2TargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_add_neighbour ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const IPv4 neighbour_address,
const IPv4 neighbour_id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a neighbour to the peer.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_add_neighbour ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const IPv4 neighbour_address,
const IPv4 neighbour_id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a neighbour to the peer.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_area_range_add ( const IPv4 area,
const IPv4Net net,
const bool &  advertise 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add area range.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_area_range_add ( const IPv4 area,
const IPv4Net net,
const bool &  advertise 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add area range.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_area_range_change_state ( const IPv4 area,
const IPv4Net net,
const bool &  advertise 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Change the advertised state of this area.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_area_range_change_state ( const IPv4 area,
const IPv4Net net,
const bool &  advertise 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Change the advertised state of this area.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_area_range_delete ( const IPv4 area,
const IPv4Net net 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete area range.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_area_range_delete ( const IPv4 area,
const IPv4Net net 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete area range.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_change_area_router_type ( const IPv4 area,
const string &  type 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Change area type.

Parameters:
areaid of the area
typeof area "border", "stub", "nssa"

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_change_area_router_type ( const IPv4 area,
const string &  type 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Change area type.

Parameters:
areaid of the area
typeof area "border", "stub", "nssa"

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_clear_database ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Clear the OSPF database.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_clear_database ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Clear the OSPF database.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_create_area_router ( const IPv4 area,
const string &  type 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create an area.

Parameters:
areaid of the area
typeof area "border", "stub", "nssa"

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_create_area_router ( const IPv4 area,
const string &  type 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create an area.

Parameters:
areaid of the area
typeof area "border", "stub", "nssa"

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_create_peer ( const string &  ifname,
const string &  vifname,
const IPv4 addr,
const string &  type,
const IPv4 area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a binding to an interface.

Parameters:
ifnamethe interface that owns vif that has address.
vifnamevirtual interface owning address.
addrthe address to be added.
typeof link "p2p", "broadcast", "nbma", "p2m", "vlink"

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_create_peer ( const string &  ifname,
const string &  vifname,
const IPv4 addr,
const string &  type,
const IPv4 area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a binding to an interface.

Parameters:
ifnamethe interface that owns vif that has address.
vifnamevirtual interface owning address.
addrthe address to be added.
typeof link "p2p", "broadcast", "nbma", "p2m", "vlink"

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_create_virtual_link ( const IPv4 neighbour_id,
const IPv4 area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a virtual link.

Parameters:
neighbour_idthe router ID of the other end of the link.
areain which an attempt has been made to configure a virtual link it has to be the backbone. Its just being passed in so it can be checked by the protocol.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_create_virtual_link ( const IPv4 neighbour_id,
const IPv4 area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a virtual link.

Parameters:
neighbour_idthe router ID of the other end of the link.
areain which an attempt has been made to configure a virtual link it has to be the backbone. Its just being passed in so it can be checked by the protocol.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_md5_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  key_id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete MD5 authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.
key_idthe key ID (must be an integer in the interval [0, 255]).

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_md5_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  key_id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete MD5 authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.
key_idthe key ID (must be an integer in the interval [0, 255]).

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_peer ( const string &  ifname,
const string &  vifname 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete peer.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_peer ( const string &  ifname,
const string &  vifname 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete peer.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_simple_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete simple password authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_simple_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete simple password authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_virtual_link ( const IPv4 neighbour_id) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete virtual link

Parameters:
neighbour_idthe router ID of the other end of the link.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_delete_virtual_link ( const IPv4 neighbour_id) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete virtual link

Parameters:
neighbour_idthe router ID of the other end of the link.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_destroy_area_router ( const IPv4 area) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Destroy area.

Parameters:
areaid of the area

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_destroy_area_router ( const IPv4 area) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Destroy area.

Parameters:
areaid of the area

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_area_list ( XrlAtomList areas) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get a list of all the configured areas. Return a list of u32 type values. Each value is an area ID.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_area_list ( XrlAtomList areas) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get a list of all the configured areas. Return a list of u32 type values. Each value is an area ID.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_lsa ( const IPv4 area,
const uint32_t &  index,
bool &  valid,
bool &  toohigh,
bool &  self,
vector< uint8_t > &  lsa 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get a single lsa from an area. A stateless mechanism to get LSAs. The client of this interface should start from zero and continue to request LSAs (incrementing index) until toohigh becomes true.

Parameters:
areadatabase that is being searched.
indexinto database starting from 0.
validtrue if a LSA has been returned. Some index values do not contain LSAs. This should not be considered an error.
toohightrue if no more LSA exist after this index.
selfif true this LSA was originated by this router.
lsaif valid is true the LSA at index.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_lsa ( const IPv4 area,
const uint32_t &  index,
bool &  valid,
bool &  toohigh,
bool &  self,
vector< uint8_t > &  lsa 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get a single lsa from an area. A stateless mechanism to get LSAs. The client of this interface should start from zero and continue to request LSAs (incrementing index) until toohigh becomes true.

Parameters:
areadatabase that is being searched.
indexinto database starting from 0.
validtrue if a LSA has been returned. Some index values do not contain LSAs. This should not be considered an error.
toohightrue if no more LSA exist after this index.
selfif true this LSA was originated by this router.
lsaif valid is true the LSA at index.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_neighbour_info ( const uint32_t &  nid,
string &  address,
string &  interface,
string &  state,
IPv4 rid,
uint32_t &  priority,
uint32_t &  deadtime,
IPv4 area,
uint32_t &  opt,
IPv4 dr,
IPv4 bdr,
uint32_t &  up,
uint32_t &  adjacent 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get information on a neighbour.

Parameters:
nidneighbour ID returned by the get_neighbour_list.
addressof neighbour in txt to allow IPv4 and IPv6.
interfacewith which the neighbour forms the adjacency.
stateof the adjacency.
ridrouter ID of the neighbour.
priorityof the neighbour (used for DR election).
deadtimetime until neighbour is considered dead.
areathe neighbour is in.
optvalue in the neighbours hello packet.
drdesignated router.
bdrbackup designated router.
uptime in seconds that the neigbour has been up.
adjacenttime in seconds that there has been an adjacency.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_neighbour_info ( const uint32_t &  nid,
string &  address,
string &  interface,
string &  state,
IPv4 rid,
uint32_t &  priority,
uint32_t &  deadtime,
IPv4 area,
uint32_t &  opt,
IPv4 dr,
IPv4 bdr,
uint32_t &  up,
uint32_t &  adjacent 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get information on a neighbour.

Parameters:
nidneighbour ID returned by the get_neighbour_list.
addressof neighbour in txt to allow IPv4 and IPv6.
interfacewith which the neighbour forms the adjacency.
stateof the adjacency.
ridrouter ID of the neighbour.
priorityof the neighbour (used for DR election).
deadtimetime until neighbour is considered dead.
areathe neighbour is in.
optvalue in the neighbours hello packet.
drdesignated router.
bdrbackup designated router.
uptime in seconds that the neigbour has been up.
adjacenttime in seconds that there has been an adjacency.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_neighbour_list ( XrlAtomList areas) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the list of neighbours. Return a list of u32 type values. Each value is an internal identifier that can be used with the get_neighbour_info XRL.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_get_neighbour_list ( XrlAtomList areas) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the list of neighbours. Return a list of u32 type values. Each value is an internal identifier that can be used with the get_neighbour_info XRL.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_originate_default_route ( const IPv4 area,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

If this is a "stub" or "nssa" area toggle the sending of a default route.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_originate_default_route ( const IPv4 area,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

If this is a "stub" or "nssa" area toggle the sending of a default route.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_remove_neighbour ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const IPv4 neighbour_address,
const IPv4 neighbour_id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove a neighbour from the peer.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_remove_neighbour ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const IPv4 neighbour_address,
const IPv4 neighbour_id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Remove a neighbour from the peer.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_hello_interval ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  interval 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The interval between hello messages.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_hello_interval ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  interval 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The interval between hello messages.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_inftransdelay ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  delay 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The estimated number of seconds it takes to transmit a Link State Update Packet over this interface. LSAs contained in the Link State Update packet will have their age incremented by this amount before transmission. This value should take into account transmission and propagation delays; it must be greater than zero.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_inftransdelay ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  delay 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The estimated number of seconds it takes to transmit a Link State Update Packet over this interface. LSAs contained in the Link State Update packet will have their age incremented by this amount before transmission. This value should take into account transmission and propagation delays; it must be greater than zero.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_interface_cost ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  cost 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The edge cost of this interface.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_interface_cost ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  cost 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The edge cost of this interface.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_ip_router_alert ( const bool &  ip_router_alert) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the router alert in the IP options.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_ip_router_alert ( const bool &  ip_router_alert) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the router alert in the IP options.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_md5_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  key_id,
const string &  password,
const string &  start_time,
const string &  end_time,
const uint32_t &  max_time_drift 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set MD5 authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.
key_idthe key ID (must be an integer in the interval [0, 255]).
passwordthe authentication password.
start_timethe authentication start time (YYYY-MM-DD.HH:MM).
end_timethe authentication end time (YYYY-MM-DD.HH:MM).
max_time_driftthe maximum time drift (in seconds) among all routers. Allowed values are [0--65534] seconds or 65535 for unlimited time drift.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_md5_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  key_id,
const string &  password,
const string &  start_time,
const string &  end_time,
const uint32_t &  max_time_drift 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set MD5 authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.
key_idthe key ID (must be an integer in the interval [0, 255]).
passwordthe authentication password.
start_timethe authentication start time (YYYY-MM-DD.HH:MM).
end_timethe authentication end time (YYYY-MM-DD.HH:MM).
max_time_driftthe maximum time drift (in seconds) among all routers. Allowed values are [0--65534] seconds or 65535 for unlimited time drift.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_passive ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const bool &  passive,
const bool &  host 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Toggle the passive status of an interface.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_passive ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const bool &  passive,
const bool &  host 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Toggle the passive status of an interface.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_peer_state ( const string &  ifname,
const string &  vifname,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the peer state up or down.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_peer_state ( const string &  ifname,
const string &  vifname,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the peer state up or down.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_retransmit_interval ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  interval 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

RxmtInterval The number of seconds between LSA retransmissions, for adjacencies belonging to this interface. Also used when retransmitting Database Description and Link State Request Packets. This should be well over the expected round-trip delay between any two routers on the attached network. The setting of this value should be conservative or needless retransmissions will result. Sample value for a local area network: 5 seconds.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_retransmit_interval ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  interval 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

RxmtInterval The number of seconds between LSA retransmissions, for adjacencies belonging to this interface. Also used when retransmitting Database Description and Link State Request Packets. This should be well over the expected round-trip delay between any two routers on the attached network. The setting of this value should be conservative or needless retransmissions will result. Sample value for a local area network: 5 seconds.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_rfc1583_compatibility ( const bool &  compatibility) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set RFC 1583 compatibility.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_rfc1583_compatibility ( const bool &  compatibility) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set RFC 1583 compatibility.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_router_dead_interval ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  interval 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The period to wait before considering a router dead.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_router_dead_interval ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  interval 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The period to wait before considering a router dead.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_router_id ( const IPv4 id) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set router id

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_router_id ( const IPv4 id) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set router id

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_router_priority ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  priority 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Used in the designated router election.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_router_priority ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const uint32_t &  priority 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Used in the designated router election.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_simple_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const string &  password 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set simple password authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.
passwordthe authentication password.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_set_simple_authentication_key ( const string &  ifname,
const string &  vifname,
const IPv4 area,
const string &  password 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set simple password authentication key.

Parameters:
ifnamethe interface name.
vifnamethe vif name.
areathe area ID.
passwordthe authentication password.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_stub_default_cost ( const IPv4 area,
const uint32_t &  cost 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the StubDefaultCost, the default cost sent in a default route in a "stub" or "nssa" area.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_stub_default_cost ( const IPv4 area,
const uint32_t &  cost 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set the StubDefaultCost, the default cost sent in a default route in a "stub" or "nssa" area.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_summaries ( const IPv4 area,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Toggle the sending of summaries into "stub" or "nssa" areas.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_summaries ( const IPv4 area,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Toggle the sending of summaries into "stub" or "nssa" areas.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_trace ( const string &  tvar,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/Disable tracing.

Parameters:
tvartrace variable.
enableset to true to enable false to disable.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_trace ( const string &  tvar,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/Disable tracing.

Parameters:
tvartrace variable.
enableset to true to enable false to disable.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_transit_area_virtual_link ( const IPv4 neighbour_id,
const IPv4 transit_area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The area through which the virtual link transits.

Parameters:
neighbour_idthe router ID of the other end of the link.
transit_areathat the virtual link transits.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::ospfv2_0_1_transit_area_virtual_link ( const IPv4 neighbour_id,
const IPv4 transit_area 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

The area through which the virtual link transits.

Parameters:
neighbour_idthe router ID of the other end of the link.
transit_areathat the virtual link transits.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_backend_0_1_configure ( const uint32_t &  filter,
const string &  conf 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Configure a policy filter.

Parameters:
filterthe identifier of the filter to configure.
confthe configuration of the filter.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_backend_0_1_configure ( const uint32_t &  filter,
const string &  conf 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Configure a policy filter.

Parameters:
filterthe identifier of the filter to configure.
confthe configuration of the filter.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_backend_0_1_push_routes ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Push all available routes through all filters for re-filtering.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_backend_0_1_push_routes ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Push all available routes through all filters for re-filtering.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_backend_0_1_reset ( const uint32_t &  filter) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Reset a policy filter.

Parameters:
filterthe identifier of the filter to reset.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_backend_0_1_reset ( const uint32_t &  filter) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Reset a policy filter.

Parameters:
filterthe identifier of the filter to reset.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_redist4_0_1_add_route4 ( const IPv4Net network,
const bool &  unicast,
const bool &  multicast,
const IPv4 nexthop,
const uint32_t &  metric,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Start route redistribution for an IPv4 route.

Parameters:
networkthe route to advertise.
unicastwhether the route is unicast.
multicastwhether the route is multicast.
nexthopthe nexthop of the route.
metricthe metric of the route.
policytagsthe set of policy-tags associated with the route.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_redist4_0_1_add_route4 ( const IPv4Net network,
const bool &  unicast,
const bool &  multicast,
const IPv4 nexthop,
const uint32_t &  metric,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Start route redistribution for an IPv4 route.

Parameters:
networkthe route to advertise.
unicastwhether the route is unicast.
multicastwhether the route is multicast.
nexthopthe nexthop of the route.
metricthe metric of the route.
policytagsthe set of policy-tags associated with the route.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_redist4_0_1_delete_route4 ( const IPv4Net network,
const bool &  unicast,
const bool &  multicast 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Terminate route redistribution for an IPv4 route.

Parameters:
networkthe route for which advertisements should cease.
unicastwhether the route is unicast.
multicastwhether the route is multicast.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::policy_redist4_0_1_delete_route4 ( const IPv4Net network,
const bool &  unicast,
const bool &  multicast 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Terminate route redistribution for an IPv4 route.

Parameters:
networkthe route for which advertisements should cease.
unicastwhether the route is unicast.
multicastwhether the route is multicast.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::raw_packet4_client_0_1_recv ( const string &  if_name,
const string &  vif_name,
const IPv4 src_address,
const IPv4 dst_address,
const uint32_t &  ip_protocol,
const int32_t &  ip_ttl,
const int32_t &  ip_tos,
const bool &  ip_router_alert,
const bool &  ip_internet_control,
const vector< uint8_t > &  payload 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Receive an IPv4 packet from a raw socket.

Parameters:
if_namethe interface name the packet arrived on.
vif_namethe vif name the packet arrived on.
src_addressthe IP source address.
dst_addressthe IP destination address.
ip_protocolthe IP protocol number.
ip_ttlthe IP TTL (hop-limit). If it has a negative value, then the received value is unknown.
ip_tosthe Type of Service (Diffserv/ECN bits for IPv4). If it has a negative value, then the received value is unknown.
ip_router_alertif true, the IP Router Alert option was included in the IP packet.
ip_internet_controlif true, then this is IP control traffic.
payloadthe payload, everything after the IP header and options.

Implemented in XrlOspfV2Target.

virtual XrlCmdError XrlOspfv2TargetBase::raw_packet4_client_0_1_recv ( const string &  if_name,
const string &  vif_name,
const IPv4 src_address,
const IPv4 dst_address,
const uint32_t &  ip_protocol,
const int32_t &  ip_ttl,
const int32_t &  ip_tos,
const bool &  ip_router_alert,
const bool &  ip_internet_control,
const vector< uint8_t > &  payload 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Receive an IPv4 packet from a raw socket.

Parameters:
if_namethe interface name the packet arrived on.
vif_namethe vif name the packet arrived on.
src_addressthe IP source address.
dst_addressthe IP destination address.
ip_protocolthe IP protocol number.
ip_ttlthe IP TTL (hop-limit). If it has a negative value, then the received value is unknown.
ip_tosthe Type of Service (Diffserv/ECN bits for IPv4). If it has a negative value, then the received value is unknown.
ip_router_alertif true, the IP Router Alert option was included in the IP packet.
ip_internet_controlif true, then this is IP control traffic.
payloadthe payload, everything after the IP header and options.

Implemented in XrlOspfV2Target.

bool XrlOspfv2TargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.
Returns:
true on success, false if cmds is null or a command map has already been supplied.
bool XrlOspfv2TargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.
Returns:
true on success, false if cmds is null or a command map has already been supplied.

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations