xorp

XrlRibTargetBase Class Reference

Inheritance diagram for XrlRibTargetBase:
XrlRibTarget

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlRibTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlRibTargetBase ()
 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.
 XrlRibTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlRibTargetBase ()
 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 finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=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 rib_0_1_enable_rib ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_disable_rib ()=0
virtual XrlCmdError rib_0_1_start_rib ()=0
virtual XrlCmdError rib_0_1_stop_rib ()=0
virtual XrlCmdError rib_0_1_make_errors_fatal ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_get_registered_protocols (const bool &ipv4, const bool &ipv6, const bool &unicast, const bool &multicast, XrlAtomList &ipv4_unicast_protocols, XrlAtomList &ipv6_unicast_protocols, XrlAtomList &ipv4_multicast_protocols, XrlAtomList &ipv6_multicast_protocols)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_igp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_delete_igp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_egp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_delete_egp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_replace_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_delete_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network)=0
virtual XrlCmdError rib_0_1_add_interface_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_replace_interface_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_lookup_route_by_dest4 (const IPv4 &addr, const bool &unicast, const bool &multicast, IPv4 &nexthop)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_new_vif (const string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_vif_addr4 (const string &name, const IPv4 &addr, const IPv4Net &subnet)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_enable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv4Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_disable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_enable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv4Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_disable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_register_interest4 (const string &target, const IPv4 &addr, bool &resolves, IPv4 &base_addr, uint32_t &prefix_len, uint32_t &real_prefix_len, IPv4 &nexthop, uint32_t &metric)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_deregister_interest4 (const string &target, const IPv4 &addr, const uint32_t &prefix_len)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_insert_policy_redist_tags (const string &protocol, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_reset_policy_redist_tags ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_get_protocol_admin_distances (const bool &ipv4, const bool &unicast, XrlAtomList &protocols, XrlAtomList &admin_distances)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_get_protocol_admin_distance (const string &protocol, const bool &ipv4, const bool &unicast, uint32_t &admin_distance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_set_protocol_admin_distance (const string &protocol, const bool &ipv4, const bool &ipv6, const bool &unicast, const bool &multicast, const uint32_t &admin_distance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_igp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_delete_igp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_egp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_delete_egp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_replace_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_delete_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network)=0
virtual XrlCmdError rib_0_1_add_interface_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_replace_interface_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_lookup_route_by_dest6 (const IPv6 &addr, const bool &unicast, const bool &multicast, IPv6 &nexthop)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_vif_addr6 (const string &name, const IPv6 &addr, const IPv6Net &subnet)=0
virtual XrlCmdError rib_0_1_redist_enable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv6Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_disable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_enable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv6Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_disable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_register_interest6 (const string &target, const IPv6 &addr, bool &resolves, IPv6 &base_addr, uint32_t &prefix_len, uint32_t &real_prefix_len, IPv6 &nexthop, uint32_t &metric)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_deregister_interest6 (const string &target, const IPv6 &addr, const uint32_t &prefix_len)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_enable (const string &pname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_disable (const string &pname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_get_entries (const string &pname, const string &instance_name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_clear (const string &pname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_list (string &info)=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 finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=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 rib_0_1_enable_rib ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_disable_rib ()=0
virtual XrlCmdError rib_0_1_start_rib ()=0
virtual XrlCmdError rib_0_1_stop_rib ()=0
virtual XrlCmdError rib_0_1_make_errors_fatal ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_get_registered_protocols (const bool &ipv4, const bool &ipv6, const bool &unicast, const bool &multicast, XrlAtomList &ipv4_unicast_protocols, XrlAtomList &ipv6_unicast_protocols, XrlAtomList &ipv4_multicast_protocols, XrlAtomList &ipv6_multicast_protocols)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_igp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_delete_igp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_egp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_delete_egp_table4 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_replace_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_delete_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network)=0
virtual XrlCmdError rib_0_1_add_interface_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_replace_interface_route4 (const string &protocol, const bool &unicast, const bool &multicast, const IPv4Net &network, const IPv4 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_lookup_route_by_dest4 (const IPv4 &addr, const bool &unicast, const bool &multicast, IPv4 &nexthop)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_new_vif (const string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_vif_addr4 (const string &name, const IPv4 &addr, const IPv4Net &subnet)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_enable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv4Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_disable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_enable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv4Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_disable4 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_register_interest4 (const string &target, const IPv4 &addr, bool &resolves, IPv4 &base_addr, uint32_t &prefix_len, uint32_t &real_prefix_len, IPv4 &nexthop, uint32_t &metric)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_deregister_interest4 (const string &target, const IPv4 &addr, const uint32_t &prefix_len)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_insert_policy_redist_tags (const string &protocol, const XrlAtomList &policytags)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_reset_policy_redist_tags ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_get_protocol_admin_distances (const bool &ipv4, const bool &unicast, XrlAtomList &protocols, XrlAtomList &admin_distances)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_get_protocol_admin_distance (const string &protocol, const bool &ipv4, const bool &unicast, uint32_t &admin_distance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_set_protocol_admin_distance (const string &protocol, const bool &ipv4, const bool &ipv6, const bool &unicast, const bool &multicast, const uint32_t &admin_distance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_igp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_delete_igp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_egp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_delete_egp_table6 (const string &protocol, const string &target_class, const string &target_instance, const bool &unicast, const bool &multicast)=0
virtual XrlCmdError rib_0_1_add_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_replace_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_delete_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network)=0
virtual XrlCmdError rib_0_1_add_interface_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_replace_interface_route6 (const string &protocol, const bool &unicast, const bool &multicast, const IPv6Net &network, const IPv6 &nexthop, const string &ifname, const string &vifname, const uint32_t &metric, const XrlAtomList &policytags)=0
virtual XrlCmdError rib_0_1_lookup_route_by_dest6 (const IPv6 &addr, const bool &unicast, const bool &multicast, IPv6 &nexthop)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_add_vif_addr6 (const string &name, const IPv6 &addr, const IPv6Net &subnet)=0
virtual XrlCmdError rib_0_1_redist_enable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv6Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_disable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_enable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const IPv6Net &network_prefix, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_redist_transaction_disable6 (const string &to_xrl_target, const string &from_protocol, const bool &unicast, const bool &multicast, const string &cookie)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_register_interest6 (const string &target, const IPv6 &addr, bool &resolves, IPv6 &base_addr, uint32_t &prefix_len, uint32_t &real_prefix_len, IPv6 &nexthop, uint32_t &metric)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError rib_0_1_deregister_interest6 (const string &target, const IPv6 &addr, const uint32_t &prefix_len)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_enable (const string &pname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_disable (const string &pname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_get_entries (const string &pname, const string &instance_name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_clear (const string &pname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError profile_0_1_list (string &info)=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_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (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_rib_0_1_enable_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_disable_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_start_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_stop_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_make_errors_fatal (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_get_registered_protocols (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_igp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_igp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_egp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_egp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_interface_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_interface_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_lookup_route_by_dest4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_new_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_vif_addr4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_enable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_disable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_enable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_disable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_register_interest4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_deregister_interest4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_insert_policy_redist_tags (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_reset_policy_redist_tags (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_get_protocol_admin_distances (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_get_protocol_admin_distance (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_set_protocol_admin_distance (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_igp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_igp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_egp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_egp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_interface_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_interface_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_lookup_route_by_dest6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_vif_addr6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_enable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_disable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_enable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_disable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_register_interest6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_deregister_interest6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_enable (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_disable (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_get_entries (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_clear (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_list (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_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (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_rib_0_1_enable_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_disable_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_start_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_stop_rib (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_make_errors_fatal (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_get_registered_protocols (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_igp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_igp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_egp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_egp_table4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_interface_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_interface_route4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_lookup_route_by_dest4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_new_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_vif_addr4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_enable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_disable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_enable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_disable4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_register_interest4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_deregister_interest4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_insert_policy_redist_tags (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_reset_policy_redist_tags (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_get_protocol_admin_distances (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_get_protocol_admin_distance (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_set_protocol_admin_distance (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_igp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_igp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_egp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_egp_table6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_delete_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_interface_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_replace_interface_route6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_lookup_route_by_dest6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_add_vif_addr6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_enable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_disable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_enable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_redist_transaction_disable6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_register_interest6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_rib_0_1_deregister_interest6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_enable (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_disable (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_get_entries (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_clear (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_profile_0_1_list (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(XrlRibTargetBase::handlers) / sizeof(XrlRibTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlRibTargetBase::XrlRibTargetBase ( 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.
XrlRibTargetBase::~XrlRibTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlRibTargetBase::XrlRibTargetBase ( 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 XrlRibTargetBase::~XrlRibTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlRibTarget.

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

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlRibTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlRibTarget.

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

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::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 XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_clear ( const string &  pname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Clear the profiling entries

Parameters:
pnameprofile variable

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_clear ( const string &  pname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Clear the profiling entries

Parameters:
pnameprofile variable

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_disable ( const string &  pname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable profiling

Parameters:
pnameprofile variable

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_disable ( const string &  pname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable profiling

Parameters:
pnameprofile variable

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_enable ( const string &  pname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable profiling

Parameters:
pnameprofile variable

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_enable ( const string &  pname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable profiling

Parameters:
pnameprofile variable

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_get_entries ( const string &  pname,
const string &  instance_name 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get log entries.

Parameters:
pnameprofile variable
instance_nameto send the profiling info to.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_get_entries ( const string &  pname,
const string &  instance_name 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get log entries.

Parameters:
pnameprofile variable
instance_nameto send the profiling info to.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_list ( string &  info) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

List all the profiling variables registered with this target.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::profile_0_1_list ( string &  info) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

List all the profiling variables registered with this target.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_igp_table4 ( const string &  protocol,
const string &  target_class,
const string &  target_instance,
const bool &  unicast,
const bool &  multicast 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete an IGP or EGP table.

Parameters:
protocolthe name of the protocol.
target_classthe target class of the protocol.
target_instancethe target instance of the protocol.
unicasttrue if the table is for the unicast RIB.
multicasttrue if the table is for the multicast RIB.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_igp_table4 ( const string &  protocol,
const string &  target_class,
const string &  target_instance,
const bool &  unicast,
const bool &  multicast 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete an IGP or EGP table.

Parameters:
protocolthe name of the protocol.
target_classthe target class of the protocol.
target_instancethe target instance of the protocol.
unicasttrue if the table is for the unicast RIB.
multicasttrue if the table is for the multicast RIB.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_interface_route4 ( const string &  protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network,
const IPv4 nexthop,
const string &  ifname,
const string &  vifname,
const uint32_t &  metric,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/replace a route by explicitly specifying the network interface toward the destination.

Parameters:
protocolthe name of the protocol this route comes from.
unicasttrue if the route is for the unicast RIB.
multicasttrue if the route is for the multicast RIB.
networkthe network address prefix of the route.
nexthopthe address of the next-hop router toward the destination.
ifnameof the name of the physical interface toward the destination.
vifnameof the name of the virtual interface toward the destination.
metricthe routing metric.
policytagsa set of policy tags used for redistribution.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_interface_route4 ( const string &  protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network,
const IPv4 nexthop,
const string &  ifname,
const string &  vifname,
const uint32_t &  metric,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/replace a route by explicitly specifying the network interface toward the destination.

Parameters:
protocolthe name of the protocol this route comes from.
unicasttrue if the route is for the unicast RIB.
multicasttrue if the route is for the multicast RIB.
networkthe network address prefix of the route.
nexthopthe address of the next-hop router toward the destination.
ifnameof the name of the physical interface toward the destination.
vifnameof the name of the virtual interface toward the destination.
metricthe routing metric.
policytagsa set of policy tags used for redistribution.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_route4 ( const string &  protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network,
const IPv4 nexthop,
const uint32_t &  metric,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/replace/delete a route.

Parameters:
protocolthe name of the protocol this route comes from.
unicasttrue if the route is for the unicast RIB.
multicasttrue if the route is for the multicast RIB.
networkthe network address prefix of the route.
nexthopthe address of the next-hop router toward the destination.
metricthe routing metric.
policytagsa set of policy tags used for redistribution.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_route4 ( const string &  protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network,
const IPv4 nexthop,
const uint32_t &  metric,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/replace/delete a route.

Parameters:
protocolthe name of the protocol this route comes from.
unicasttrue if the route is for the unicast RIB.
multicasttrue if the route is for the multicast RIB.
networkthe network address prefix of the route.
nexthopthe address of the next-hop router toward the destination.
metricthe routing metric.
policytagsa set of policy tags used for redistribution.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_vif_addr4 ( const string &  name,
const IPv4 addr,
const IPv4Net subnet 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a vif address to the RIB. This interface should be used only for testing purpose.

Parameters:
namethe name of the vif.
addrthe address to add.
subnetthe subnet address to add.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_add_vif_addr4 ( const string &  name,
const IPv4 addr,
const IPv4Net subnet 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a vif address to the RIB. This interface should be used only for testing purpose.

Parameters:
namethe name of the vif.
addrthe address to add.
subnetthe subnet address to add.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_deregister_interest4 ( const string &  target,
const IPv4 addr,
const uint32_t &  prefix_len 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

De-register an interest in a route.

Parameters:
targetthe name of the XRL module that registered the interest.
addrthe address of the previous registered interest. addr should be the base address of the add/prefix_len subnet.
prefix_lenthe prefix length of the registered interest, as given in the response from register_interest.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_deregister_interest4 ( const string &  target,
const IPv4 addr,
const uint32_t &  prefix_len 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

De-register an interest in a route.

Parameters:
targetthe name of the XRL module that registered the interest.
addrthe address of the previous registered interest. addr should be the base address of the add/prefix_len subnet.
prefix_lenthe prefix length of the registered interest, as given in the response from register_interest.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_deregister_interest6 ( const string &  target,
const IPv6 addr,
const uint32_t &  prefix_len 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

De-register an interest in a route.

Parameters:
targetthe name of the XRL module that registered the interest.
addrthe address of the previous registered interest. addr should be the base address of the add/prefix_len subnet.
prefix_lenthe prefix length of the registered interest, as given in the response from register_interest.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_deregister_interest6 ( const string &  target,
const IPv6 addr,
const uint32_t &  prefix_len 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

De-register an interest in a route.

Parameters:
targetthe name of the XRL module that registered the interest.
addrthe address of the previous registered interest. addr should be the base address of the add/prefix_len subnet.
prefix_lenthe prefix length of the registered interest, as given in the response from register_interest.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_enable_rib ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop RIB.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_enable_rib ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop RIB.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_get_protocol_admin_distance ( const string &  protocol,
const bool &  ipv4,
const bool &  unicast,
uint32_t &  admin_distance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get administrative distance for an individual protocol in a selected RIB.

Parameters:
protocolthe name of the protocol.
ipv4true if getting admin distance from IPv4 RIB; false if getting admin distance from IPv6 RIB.
unicasttrue if getting admin distance from unicast RIB; false if getting admin distance from multicast RIB.
admin_distancethe administrative distance (1-255)

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_get_protocol_admin_distance ( const string &  protocol,
const bool &  ipv4,
const bool &  unicast,
uint32_t &  admin_distance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get administrative distance for an individual protocol in a selected RIB.

Parameters:
protocolthe name of the protocol.
ipv4true if getting admin distance from IPv4 RIB; false if getting admin distance from IPv6 RIB.
unicasttrue if getting admin distance from unicast RIB; false if getting admin distance from multicast RIB.
admin_distancethe administrative distance (1-255)

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_get_protocol_admin_distances ( const bool &  ipv4,
const bool &  unicast,
XrlAtomList protocols,
XrlAtomList admin_distances 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get administrative distance for all protocols registered as having an admin distance in a selected RIB.

Parameters:
ipv4true if getting admin distances from IPv4 RIB; false if getting admin distances from IPv6 RIB.
unicasttrue if getting admin distances from unicast RIB; false if getting admin distances from multicast RIB.
protocolsthe list of protocols registered as having an admin distance in the selected RIB.

protocols list.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_get_protocol_admin_distances ( const bool &  ipv4,
const bool &  unicast,
XrlAtomList protocols,
XrlAtomList admin_distances 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get administrative distance for all protocols registered as having an admin distance in a selected RIB.

Parameters:
ipv4true if getting admin distances from IPv4 RIB; false if getting admin distances from IPv6 RIB.
unicasttrue if getting admin distances from unicast RIB; false if getting admin distances from multicast RIB.
protocolsthe list of protocols registered as having an admin distance in the selected RIB.

protocols list.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_get_registered_protocols ( const bool &  ipv4,
const bool &  ipv6,
const bool &  unicast,
const bool &  multicast,
XrlAtomList ipv4_unicast_protocols,
XrlAtomList ipv6_unicast_protocols,
XrlAtomList ipv4_multicast_protocols,
XrlAtomList ipv6_multicast_protocols 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the list of registered protocols.

Parameters:
ipv4if true, then include the IPv4 protocols.
ipv6if true, then include the IPv6 protocols.
unicastif true, then include the protocols registered with the unicast RIB.
multicastif true, then include the protocols registered with the multicast RIB.
ipv4_unicast_protocolsthe list of IPv4 protocols registered with the unicast RIB.
ipv6_unicast_protocolsthe list of IPv6 protocols registered with the unicast RIB.
ipv4_multicast_protocolsthe list of IPv4 protocols registered with the multicast RIB.
ipv6_multicast_protocolsthe list of IPv6 protocols registered with the multicast RIB.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_get_registered_protocols ( const bool &  ipv4,
const bool &  ipv6,
const bool &  unicast,
const bool &  multicast,
XrlAtomList ipv4_unicast_protocols,
XrlAtomList ipv6_unicast_protocols,
XrlAtomList ipv4_multicast_protocols,
XrlAtomList ipv6_multicast_protocols 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get the list of registered protocols.

Parameters:
ipv4if true, then include the IPv4 protocols.
ipv6if true, then include the IPv6 protocols.
unicastif true, then include the protocols registered with the unicast RIB.
multicastif true, then include the protocols registered with the multicast RIB.
ipv4_unicast_protocolsthe list of IPv4 protocols registered with the unicast RIB.
ipv6_unicast_protocolsthe list of IPv6 protocols registered with the unicast RIB.
ipv4_multicast_protocolsthe list of IPv4 protocols registered with the multicast RIB.
ipv6_multicast_protocolsthe list of IPv6 protocols registered with the multicast RIB.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_insert_policy_redist_tags ( const string &  protocol,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add policy tags for a specific protcol in the redistribution map.

Parameters:
protocolThe destination protocol of the redistribution.
policytagsThe set of policytags of interest for the protocol.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_insert_policy_redist_tags ( const string &  protocol,
const XrlAtomList policytags 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add policy tags for a specific protcol in the redistribution map.

Parameters:
protocolThe destination protocol of the redistribution.
policytagsThe set of policytags of interest for the protocol.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_lookup_route_by_dest4 ( const IPv4 addr,
const bool &  unicast,
const bool &  multicast,
IPv4 nexthop 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup nexthop.

Parameters:
addraddress to lookup.
unicastlook in unicast RIB.
multicastlook in multicast RIB.
nexthopcontains the resolved nexthop if successful, IPv4::ZERO otherwise. It is an error for the unicast and multicast fields to both be true or both false.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_lookup_route_by_dest4 ( const IPv4 addr,
const bool &  unicast,
const bool &  multicast,
IPv4 nexthop 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup nexthop.

Parameters:
addraddress to lookup.
unicastlook in unicast RIB.
multicastlook in multicast RIB.
nexthopcontains the resolved nexthop if successful, IPv4::ZERO otherwise. It is an error for the unicast and multicast fields to both be true or both false.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_lookup_route_by_dest6 ( const IPv6 addr,
const bool &  unicast,
const bool &  multicast,
IPv6 nexthop 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup nexthop.

Parameters:
addraddress to lookup.
unicastlook in unicast RIB.
multicastlook in multicast RIB.
nexthopcontains the resolved nexthop if successful, IPv6::ZERO otherwise. It is an error for the unicast and multicast fields to both be true or both false.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_lookup_route_by_dest6 ( const IPv6 addr,
const bool &  unicast,
const bool &  multicast,
IPv6 nexthop 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup nexthop.

Parameters:
addraddress to lookup.
unicastlook in unicast RIB.
multicastlook in multicast RIB.
nexthopcontains the resolved nexthop if successful, IPv6::ZERO otherwise. It is an error for the unicast and multicast fields to both be true or both false.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_make_errors_fatal ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Make errors fatal; used to detect errors we'd normally mask

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_make_errors_fatal ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Make errors fatal; used to detect errors we'd normally mask

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_new_vif ( const string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a vif or a vif address to the RIB. This interface should be used only for testing purpose.

Parameters:
namethe name of the vif.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_new_vif ( const string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a vif or a vif address to the RIB. This interface should be used only for testing purpose.

Parameters:
namethe name of the vif.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_disable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist4/0.1 and previously called redist_enable4.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_disable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist4/0.1 and previously called redist_enable4.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_disable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist6/0.1 and previously called redist_enable6.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_disable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist6/0.1 and previously called redist_enable6.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_enable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist4/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_enable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist4/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_enable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv6Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist6/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_enable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv6Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist6/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_disable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction4/0.1 and previously called redist_transaction_enable4.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_disable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction4/0.1 and previously called redist_transaction_enable4.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_disable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction6/0.1 and previously called redist_transaction_enable6.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_disable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Disable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction6/0.1 and previously called redist_transaction_enable6.
unicastdisable for unicast RIBs matching from and to.
multicastdisable for multicast RIBs matching from and to.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_enable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction4/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_enable4 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv4Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction4/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction4/0.1 interface.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_enable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv6Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction6/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_redist_transaction_enable6 ( const string &  to_xrl_target,
const string &  from_protocol,
const bool &  unicast,
const bool &  multicast,
const IPv6Net network_prefix,
const string &  cookie 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable transaction-based route redistribution from one routing protocol to another.

Parameters:
to_xrl_targetthe XRL Target instance name of the caller. The caller must implement redist_transaction6/0.1.
from_protocolthe name of the routing process routes are to be redistributed from.
unicastenable for unicast RIBs matching from and to.
multicastenable for multicast RIBs matching from and to.
network_prefixredistribite only the routes that fall into this prefix address.
cookiea text value passed back to creator in each call from the RIB. This allows creators to identity the source of updates it receives through the redist_transaction6/0.1 interface.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_register_interest4 ( const string &  target,
const IPv4 addr,
bool &  resolves,
IPv4 base_addr,
uint32_t &  prefix_len,
uint32_t &  real_prefix_len,
IPv4 nexthop,
uint32_t &  metric 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register an interest in a route.

Parameters:
targetthe name of the XRL module to notify when the information returned by this call becomes invalid.
addraddress of interest.
resolvesreturns whether or not the address resolves to a route that can be used for forwarding.
base_addrreturns the address of interest (actually the base address of the subnet covered by addr/prefix_len).
prefix_lenreturns the prefix length that the registration covers. This response applies to all addresses in addr/prefix_len.
real_prefix_lenreturns the actual prefix length of the route that will be used to route addr. If real_prefix_len is not the same as prefix_len, this is because there are some more specific routes that overlap addr/real_prefix_len. real_prefix_len is primarily given for debugging reasons.
nexthopreturns the address of the next hop for packets sent to addr.
metricreturns the IGP metric for this route.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_register_interest4 ( const string &  target,
const IPv4 addr,
bool &  resolves,
IPv4 base_addr,
uint32_t &  prefix_len,
uint32_t &  real_prefix_len,
IPv4 nexthop,
uint32_t &  metric 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register an interest in a route.

Parameters:
targetthe name of the XRL module to notify when the information returned by this call becomes invalid.
addraddress of interest.
resolvesreturns whether or not the address resolves to a route that can be used for forwarding.
base_addrreturns the address of interest (actually the base address of the subnet covered by addr/prefix_len).
prefix_lenreturns the prefix length that the registration covers. This response applies to all addresses in addr/prefix_len.
real_prefix_lenreturns the actual prefix length of the route that will be used to route addr. If real_prefix_len is not the same as prefix_len, this is because there are some more specific routes that overlap addr/real_prefix_len. real_prefix_len is primarily given for debugging reasons.
nexthopreturns the address of the next hop for packets sent to addr.
metricreturns the IGP metric for this route.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_register_interest6 ( const string &  target,
const IPv6 addr,
bool &  resolves,
IPv6 base_addr,
uint32_t &  prefix_len,
uint32_t &  real_prefix_len,
IPv6 nexthop,
uint32_t &  metric 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register an interest in a route.

Parameters:
targetthe name of the XRL module to notify when the information returned by this call becomes invalid.
addraddress of interest.
resolvesreturns whether or not the address resolves to a route that can be used for forwarding.
base_addrreturns the address of interest (actually the base address of the subnet covered by addr/prefix_len).
prefix_lenreturns the prefix length that the registration covers. This response applies to all addresses in addr/prefix_len.
real_prefix_lenreturns the actual prefix length of the route that will be used to route addr. If real_prefix_len is not the same as prefix_len, this is because there are some more specific routes that overlap addr/real_prefix_len. real_prefix_len is primarily given for debugging reasons.
nexthopreturns the address of the next hop for packets sent to addr.
metricreturns the IGP metric for this route.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_register_interest6 ( const string &  target,
const IPv6 addr,
bool &  resolves,
IPv6 base_addr,
uint32_t &  prefix_len,
uint32_t &  real_prefix_len,
IPv6 nexthop,
uint32_t &  metric 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register an interest in a route.

Parameters:
targetthe name of the XRL module to notify when the information returned by this call becomes invalid.
addraddress of interest.
resolvesreturns whether or not the address resolves to a route that can be used for forwarding.
base_addrreturns the address of interest (actually the base address of the subnet covered by addr/prefix_len).
prefix_lenreturns the prefix length that the registration covers. This response applies to all addresses in addr/prefix_len.
real_prefix_lenreturns the actual prefix length of the route that will be used to route addr. If real_prefix_len is not the same as prefix_len, this is because there are some more specific routes that overlap addr/real_prefix_len. real_prefix_len is primarily given for debugging reasons.
nexthopreturns the address of the next hop for packets sent to addr.
metricreturns the IGP metric for this route.
virtual XrlCmdError XrlRibTargetBase::rib_0_1_reset_policy_redist_tags ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the policy redistribution map. No policy based route redistribution will be available at this point.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_reset_policy_redist_tags ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the policy redistribution map. No policy based route redistribution will be available at this point.

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_set_protocol_admin_distance ( const string &  protocol,
const bool &  ipv4,
const bool &  ipv6,
const bool &  unicast,
const bool &  multicast,
const uint32_t &  admin_distance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set administrative distance for an individual protocol.

Parameters:
protocolthe name of the protocol.
ipv4true if setting admin distance for IPv4 RIB.
ipv6true if setting admin distance for IPv6 RIB.
unicasttrue if setting admin distance for unicast RIB.
multicasttrue if setting admin distance for multicast RIB.
admin_distancethe administrative distance (1-255)

Implemented in XrlRibTarget.

virtual XrlCmdError XrlRibTargetBase::rib_0_1_set_protocol_admin_distance ( const string &  protocol,
const bool &  ipv4,
const bool &  ipv6,
const bool &  unicast,
const bool &  multicast,
const uint32_t &  admin_distance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Set administrative distance for an individual protocol.

Parameters:
protocolthe name of the protocol.
ipv4true if setting admin distance for IPv4 RIB.
ipv6true if setting admin distance for IPv6 RIB.
unicasttrue if setting admin distance for unicast RIB.
multicasttrue if setting admin distance for multicast RIB.
admin_distancethe administrative distance (1-255)

Implemented in XrlRibTarget.

bool XrlRibTargetBase::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 XrlRibTargetBase::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