|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlFeaTargetBase (XrlCmdMap* cmds = 0)
| XrlFeaTargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlFeaTargetBase ()
| ~XrlFeaTargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer 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.
| inline const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| inline const char* version ()
| version |
[const]
Get version string of instance.
| XrlCmdError common_0_1_get_target_name (
string& name)
| common_0_1_get_target_name |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_get_version (
string& version)
| common_0_1_get_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get version string from Xrl Target
| XrlCmdError common_0_1_get_status (
uint32_t& status,
string& reason)
| common_0_1_get_status |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_shutdown ()
| common_0_1_shutdown |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Request clean shutdown of Xrl Target
| XrlCmdError fea_click_0_1_enable_click (
const bool& enable)
| fea_click_0_1_enable_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable Click FEA support.
Parameters:
| enable | if true, then enable the Click FEA support, otherwise disable it. |
| XrlCmdError fea_click_0_1_start_click ()
| fea_click_0_1_start_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_stop_click ()
| fea_click_0_1_stop_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_enable_duplicate_routes_to_kernel (
const bool& enable)
| fea_click_0_1_enable_duplicate_routes_to_kernel |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable duplicating the Click routes to the system kernel.
Parameters:
| enable | if true, then enable duplicating the Click routes to the system kernel, otherwise disable it. |
| XrlCmdError fea_click_0_1_enable_kernel_click (
const bool& enable)
| fea_click_0_1_enable_kernel_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable kernel-level Click FEA support.
Parameters:
| enable | if true, then enable the kernel-level Click FEA support, otherwise disable it. |
| XrlCmdError fea_click_0_1_enable_kernel_click_install_on_startup (
const bool& enable)
| fea_click_0_1_enable_kernel_click_install_on_startup |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable installing kernel-level Click on startup.
Parameters:
| enable | if true, then install kernel-level Click on startup. |
| XrlCmdError fea_click_0_1_set_kernel_click_modules (
const string& modules)
| fea_click_0_1_set_kernel_click_modules |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the list of kernel Click modules to load on startup if installing kernel-level Click on startup is enabled. The file names of the kernel modules are separated by colon.
Parameters:
| modules | the list of kernel Click modules (separated by colon) to load. |
| XrlCmdError fea_click_0_1_set_kernel_click_mount_directory (
const string& directory)
| fea_click_0_1_set_kernel_click_mount_directory |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the kernel-level Click mount directory.
Parameters:
| directory | the kernel-level Click mount directory. |
| XrlCmdError fea_click_0_1_set_kernel_click_config_generator_file (
const string& kernel_click_config_generator_file)
| fea_click_0_1_set_kernel_click_config_generator_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the external program to generate the kernel-level Click configuration.
Parameters:
| kernel_click_config_generator_file | the name of the external program to generate the kernel-level Click configuration. |
| XrlCmdError fea_click_0_1_enable_user_click (
const bool& enable)
| fea_click_0_1_enable_user_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable user-level Click FEA support.
Parameters:
| enable | if true, then enable the user-level Click FEA support, otherwise disable it. |
| XrlCmdError fea_click_0_1_set_user_click_command_file (
const string& user_click_command_file)
| fea_click_0_1_set_user_click_command_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the user-level Click command file.
Parameters:
| user_click_command_file | the name of the user-level Click command file. |
| XrlCmdError fea_click_0_1_set_user_click_command_extra_arguments (
const string& user_click_command_extra_arguments)
| fea_click_0_1_set_user_click_command_extra_arguments |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the extra arguments to the user-level Click command.
Parameters:
| user_click_command_extra_arguments | the extra arguments to the user-level Click command. |
| XrlCmdError fea_click_0_1_set_user_click_command_execute_on_startup (
const bool& user_click_command_execute_on_startup)
| fea_click_0_1_set_user_click_command_execute_on_startup |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify whether to execute on startup the user-level Click command.
Parameters:
| user_click_command_execute_on_startup | if true, then execute the user-level Click command on startup. |
| XrlCmdError fea_click_0_1_set_user_click_control_address (
const IPv4& user_click_control_address)
| fea_click_0_1_set_user_click_control_address |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the address to use for control access to the user-level Click.
Parameters:
| user_click_control_address | the address to use for control access to the user-level Click. |
| XrlCmdError fea_click_0_1_set_user_click_control_socket_port (
const uint32_t& user_click_control_socket_port)
| fea_click_0_1_set_user_click_control_socket_port |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the socket port to use for control access to the user-level Click.
Parameters:
| user_click_control_socket_port | the socket port to use for control access to the user-level Click. |
| XrlCmdError fea_click_0_1_set_user_click_startup_config_file (
const string& user_click_startup_config_file)
| fea_click_0_1_set_user_click_startup_config_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the configuration file to be used by user-level Click on startup.
Parameters:
| user_click_startup_config_file | the name of the configuration file to be used by user-level Click on startup. |
| XrlCmdError fea_click_0_1_set_user_click_config_generator_file (
const string& user_click_config_generator_file)
| fea_click_0_1_set_user_click_config_generator_file |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Specify the external program to generate the user-level Click configuration.
Parameters:
| user_click_config_generator_file | the name of the external program to generate the user-level Click configuration. |
| XrlCmdError fea_fib_0_1_add_fib_client4 (
const string& target_name,
const bool& send_updates,
const bool& send_resolves)
| fea_fib_0_1_add_fib_client4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add a FIB client.
Parameters:
| target_name | the target name of the FIB client to add. |
| send_updates | whether updates should be sent. |
| send_resolves | whether resolution requests should be sent. |
| XrlCmdError fea_fib_0_1_add_fib_client6 (
const string& target_name,
const bool& send_updates,
const bool& send_resolves)
| fea_fib_0_1_add_fib_client6 |
[protected pure virtual]
| XrlCmdError fea_fib_0_1_delete_fib_client4 (
const string& target_name)
| fea_fib_0_1_delete_fib_client4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete a FIB client.
Parameters:
| target_name | the target name of the FIB client to delete. |
| XrlCmdError fea_fib_0_1_delete_fib_client6 (
const string& target_name)
| fea_fib_0_1_delete_fib_client6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_names (
XrlAtomList& ifnames)
| ifmgr_0_1_get_configured_interface_names |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_names (
const string& ifname,
XrlAtomList& vifs)
| ifmgr_0_1_get_configured_vif_names |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_flags (
const string& ifname,
const string& vif,
bool& enabled,
bool& broadcast,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_configured_vif_flags |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_pif_index (
const string& ifname,
const string& vif,
uint32_t& pif_index)
| ifmgr_0_1_get_configured_vif_pif_index |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_addresses4 (
const string& ifname,
const string& vif,
XrlAtomList& addresses)
| ifmgr_0_1_get_configured_vif_addresses4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_addresses6 (
const string& ifname,
const string& vif,
XrlAtomList& addresses)
| ifmgr_0_1_get_configured_vif_addresses6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_flags4 (
const string& ifname,
const string& vif,
const IPv4& address,
bool& enabled,
bool& broadcast,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_configured_address_flags4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_flags6 (
const string& ifname,
const string& vif,
const IPv6& address,
bool& enabled,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_configured_address_flags6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_enabled (
const string& ifname,
bool& enabled)
| ifmgr_0_1_get_configured_interface_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_discard (
const string& ifname,
bool& discard)
| ifmgr_0_1_get_configured_interface_discard |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_mac (
const string& ifname,
Mac& mac)
| ifmgr_0_1_get_configured_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_mtu (
const string& ifname,
uint32_t& mtu)
| ifmgr_0_1_get_configured_mtu |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_vif_enabled (
const string& ifname,
const string& vif,
bool& enabled)
| ifmgr_0_1_get_configured_vif_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_prefix4 (
const string& ifname,
const string& vif,
const IPv4& address,
uint32_t& prefix_len)
| ifmgr_0_1_get_configured_prefix4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_broadcast4 (
const string& ifname,
const string& vif,
const IPv4& address,
IPv4& broadcast)
| ifmgr_0_1_get_configured_broadcast4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_endpoint4 (
const string& ifname,
const string& vif,
const IPv4& address,
IPv4& endpoint)
| ifmgr_0_1_get_configured_endpoint4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_prefix6 (
const string& ifname,
const string& vif,
const IPv6& address,
uint32_t& prefix_len)
| ifmgr_0_1_get_configured_prefix6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_endpoint6 (
const string& ifname,
const string& vif,
const IPv6& address,
IPv6& endpoint)
| ifmgr_0_1_get_configured_endpoint6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_start_transaction (
uint32_t& tid)
| ifmgr_0_1_start_transaction |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_commit_transaction (
const uint32_t& tid)
| ifmgr_0_1_commit_transaction |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_abort_transaction (
const uint32_t& tid)
| ifmgr_0_1_abort_transaction |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_interface (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_create_interface |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_interface (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_delete_interface |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_configure_interface_from_system (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_configure_interface_from_system |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Implicitly configure an interface within the FEA by using information from the underlying system.
Parameters:
| tid | the transaction ID. |
| ifname | the name of the interface to configure. |
| XrlCmdError ifmgr_0_1_set_interface_enabled (
const uint32_t& tid,
const string& ifname,
const bool& enabled)
| ifmgr_0_1_set_interface_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_interface_discard (
const uint32_t& tid,
const string& ifname,
const bool& discard)
| ifmgr_0_1_set_interface_discard |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_mac (
const uint32_t& tid,
const string& ifname,
const Mac& mac)
| ifmgr_0_1_set_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_mtu (
const uint32_t& tid,
const string& ifname,
const uint32_t& mtu)
| ifmgr_0_1_set_mtu |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_vif (
const uint32_t& tid,
const string& ifname,
const string& vif)
| ifmgr_0_1_create_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a vif
Parameters:
| ifname | the name of the physical interface associated with the new vif. |
| vif | name for new vif, must be unique across all the vifs in the system. |
| XrlCmdError ifmgr_0_1_delete_vif (
const uint32_t& tid,
const string& ifname,
const string& vif)
| ifmgr_0_1_delete_vif |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_vif_enabled (
const uint32_t& tid,
const string& ifname,
const string& vif,
const bool& enabled)
| ifmgr_0_1_set_vif_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_address4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address)
| ifmgr_0_1_create_address4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_address4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address)
| ifmgr_0_1_delete_address4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_address_enabled4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const bool& enabled)
| ifmgr_0_1_set_address_enabled4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_enabled4 (
const string& ifname,
const string& vif,
const IPv4& address,
bool& enabled)
| ifmgr_0_1_get_configured_address_enabled4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_prefix4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const uint32_t& prefix_len)
| ifmgr_0_1_set_prefix4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_broadcast4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const IPv4& broadcast)
| ifmgr_0_1_set_broadcast4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_endpoint4 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv4& address,
const IPv4& endpoint)
| ifmgr_0_1_set_endpoint4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_create_address6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address)
| ifmgr_0_1_create_address6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_address6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address)
| ifmgr_0_1_delete_address6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_address_enabled6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address,
const bool& enabled)
| ifmgr_0_1_set_address_enabled6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_address_enabled6 (
const string& ifname,
const string& vif,
const IPv6& address,
bool& enabled)
| ifmgr_0_1_get_configured_address_enabled6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_prefix6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address,
const uint32_t& prefix_len)
| ifmgr_0_1_set_prefix6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_endpoint6 (
const uint32_t& tid,
const string& ifname,
const string& vif,
const IPv6& address,
const IPv6& endpoint)
| ifmgr_0_1_set_endpoint6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_register_client (
const string& clientname)
| ifmgr_0_1_register_client |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register network interface observer for configured interfaces.
Parameters:
| clientname | name of xrl entity supporting fea_ifmgr_client.xif methods. |
| XrlCmdError ifmgr_0_1_unregister_client (
const string& clientname)
| ifmgr_0_1_unregister_client |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister network interface observer for configured interfaces. This method is not strictly necessary, the fea will remove the interface observer from its list of known observers if interface update XRLs fail.
| XrlCmdError ifmgr_0_1_get_system_interface_names (
XrlAtomList& ifnames)
| ifmgr_0_1_get_system_interface_names |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_vif_names (
const string& ifname,
XrlAtomList& vifs)
| ifmgr_0_1_get_system_vif_names |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_vif_flags (
const string& ifname,
const string& vif,
bool& enabled,
bool& broadcast,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_system_vif_flags |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_vif_pif_index (
const string& ifname,
const string& vif,
uint32_t& pif_index)
| ifmgr_0_1_get_system_vif_pif_index |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_vif_addresses4 (
const string& ifname,
const string& vif,
XrlAtomList& addresses)
| ifmgr_0_1_get_system_vif_addresses4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_address_flags4 (
const string& ifname,
const string& vif,
const IPv4& address,
bool& enabled,
bool& broadcast,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_system_address_flags4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_vif_addresses6 (
const string& ifname,
const string& vif,
XrlAtomList& addresses)
| ifmgr_0_1_get_system_vif_addresses6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_address_flags6 (
const string& ifname,
const string& vif,
const IPv6& address,
bool& enabled,
bool& loopback,
bool& point_to_point,
bool& multicast)
| ifmgr_0_1_get_system_address_flags6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_interface_enabled (
const string& ifname,
bool& enabled)
| ifmgr_0_1_get_system_interface_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_interface_discard (
const string& ifname,
bool& discard)
| ifmgr_0_1_get_system_interface_discard |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_mac (
const string& ifname,
Mac& mac)
| ifmgr_0_1_get_system_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_mtu (
const string& ifname,
uint32_t& mtu)
| ifmgr_0_1_get_system_mtu |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_vif_enabled (
const string& ifname,
const string& vif,
bool& enabled)
| ifmgr_0_1_get_system_vif_enabled |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_prefix4 (
const string& ifname,
const string& vif,
const IPv4& address,
uint32_t& prefix_len)
| ifmgr_0_1_get_system_prefix4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_broadcast4 (
const string& ifname,
const string& vif,
const IPv4& address,
IPv4& broadcast)
| ifmgr_0_1_get_system_broadcast4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_endpoint4 (
const string& ifname,
const string& vif,
const IPv4& address,
IPv4& endpoint)
| ifmgr_0_1_get_system_endpoint4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_prefix6 (
const string& ifname,
const string& vif,
const IPv6& address,
uint32_t& prefix_len)
| ifmgr_0_1_get_system_prefix6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_endpoint6 (
const string& ifname,
const string& vif,
const IPv6& address,
IPv6& endpoint)
| ifmgr_0_1_get_system_endpoint6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_address_enabled4 (
const string& ifname,
const string& vif,
const IPv4& address,
bool& enabled)
| ifmgr_0_1_get_system_address_enabled4 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_system_address_enabled6 (
const string& ifname,
const string& vif,
const IPv6& address,
bool& enabled)
| ifmgr_0_1_get_system_address_enabled6 |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_register_system_interfaces_client (
const string& clientname)
| ifmgr_0_1_register_system_interfaces_client |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register network interface observer for all system interfaces.
Parameters:
| clientname | name of xrl entity supporting fea_ifmgr_client.xif methods. |
| XrlCmdError ifmgr_0_1_unregister_system_interfaces_client (
const string& clientname)
| ifmgr_0_1_unregister_system_interfaces_client |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister network interface observer for all system interfaces. This method is not strictly necessary, the fea will remove the interface observer from its list of known observers if interface update XRLs fail.
| XrlCmdError ifmgr_replicator_0_1_register_ifmgr_mirror (
const string& clientname)
| ifmgr_replicator_0_1_register_ifmgr_mirror |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register remote mirror of interface state.
| XrlCmdError ifmgr_replicator_0_1_unregister_ifmgr_mirror (
const string& clientname)
| ifmgr_replicator_0_1_unregister_ifmgr_mirror |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register remote mirror of interface state.
| XrlCmdError fti_0_2_lookup_route_by_dest4 (
const IPv4& dst,
IPv4Net& netmask,
IPv4& nexthop,
string& ifname,
string& vifname,
uint32_t& metric,
uint32_t& admin_distance,
string& protocol_origin)
| fti_0_2_lookup_route_by_dest4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Lookup a route for a destination host address.
Parameters:
| dst | the destination host address to lookup. |
| nexthop | the address of the next-hop router toward dst. |
| ifname | the name of the physical interface toward dst. |
| vifname | the name of the virtual interface toward dst. |
| metric | the routing metric toward dst. |
| admin_distance | the administratively defined distance toward dst. |
| protocol_origin | the name of the protocol that originated this routing entry. |
| XrlCmdError fti_0_2_lookup_route_by_dest6 (
const IPv6& dst,
IPv6Net& netmask,
IPv6& nexthop,
string& ifname,
string& vifname,
uint32_t& metric,
uint32_t& admin_distance,
string& protocol_origin)
| fti_0_2_lookup_route_by_dest6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Lookup a route for a destination host address.
Parameters:
| dst | the destination host address to lookup. |
| nexthop | the address of the next-hop router toward dst. |
| ifname | the name of the physical interface toward dst. |
| vifname | the name of the virtual interface toward dst. |
| metric | the routing metric toward dst. |
| admin_distance | the administratively defined distance toward dst. |
| protocol_origin | the name of the protocol that originated this routing entry. |
| XrlCmdError fti_0_2_lookup_route_by_network4 (
const IPv4Net& dst,
IPv4& nexthop,
string& ifname,
string& vifname,
uint32_t& metric,
uint32_t& admin_distance,
string& protocol_origin)
| fti_0_2_lookup_route_by_network4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Lookup a route for a destination subnet address.
Parameters:
| dst | the destination subnet address to lookup. |
| nexthop | the address of the next-hop router toward dst. |
| ifname | the name of the physical interface toward dst. |
| vifname | the name of the virtual interface toward dst. |
| metric | the routing metric toward dst. |
| admin_distance | the administratively defined distance toward dst. |
| protocol_origin | the name of the protocol that originated this routing entry. |
| XrlCmdError fti_0_2_lookup_route_by_network6 (
const IPv6Net& dst,
IPv6& nexthop,
string& ifname,
string& vifname,
uint32_t& metric,
uint32_t& admin_distance,
string& protocol_origin)
| fti_0_2_lookup_route_by_network6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Lookup a route for a destination subnet address.
Parameters:
| dst | the destination subnet address to lookup. |
| nexthop | the address of the next-hop router toward dst. |
| ifname | the name of the physical interface toward dst. |
| vifname | the name of the virtual interface toward dst. |
| metric | the routing metric toward dst. |
| admin_distance | the administratively defined distance toward dst. |
| protocol_origin | the name of the protocol that originated this routing entry. |
| XrlCmdError fti_0_2_have_ipv4 (
bool& result)
| fti_0_2_have_ipv4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test if the underlying system supports IPv4.
Parameters:
| result | true if the underlying system supports IPv4, otherwise false. |
| XrlCmdError fti_0_2_have_ipv6 (
bool& result)
| fti_0_2_have_ipv6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test if the underlying system supports IPv6.
Parameters:
| result | true if the underlying system supports IPv4, otherwise false. |
| XrlCmdError fti_0_2_get_unicast_forwarding_enabled4 (
bool& enabled)
| fti_0_2_get_unicast_forwarding_enabled4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test whether the IPv4 unicast forwarding engine is enabled or disabled to forward packets.
Parameters:
| enabled | if true, then the IPv4 unicast forwarding is enabled, otherwise is disabled. |
| XrlCmdError fti_0_2_get_unicast_forwarding_enabled6 (
bool& enabled)
| fti_0_2_get_unicast_forwarding_enabled6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test whether the IPv6 unicast forwarding engine is enabled or disabled to forward packets.
Parameters:
| enabled | if true, then the IPv6 unicast forwarding is enabled, otherwise is disabled. |
| XrlCmdError fti_0_2_set_unicast_forwarding_enabled4 (
const bool& enabled)
| fti_0_2_set_unicast_forwarding_enabled4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv4 unicast forwarding engine to enable or disable forwarding of packets.
Parameters:
| enabled | if true, then enable IPv4 unicast forwarding, otherwise disable it. |
| XrlCmdError fti_0_2_set_unicast_forwarding_enabled6 (
const bool& enabled)
| fti_0_2_set_unicast_forwarding_enabled6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv6 unicast forwarding engine to enable or disable forwarding of packets.
Parameters:
| enabled | if true, then enable IPv6 unicast forwarding, otherwise disable it. |
| XrlCmdError redist_transaction4_0_1_start_transaction (
uint32_t& tid)
| redist_transaction4_0_1_start_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Start transaction.
Parameters:
| tid | the transaction ID to use for this transaction. |
| XrlCmdError redist_transaction4_0_1_commit_transaction (
const uint32_t& tid)
| redist_transaction4_0_1_commit_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Commit transaction.
Parameters:
| tid | the transaction ID of this transaction. |
| XrlCmdError redist_transaction4_0_1_abort_transaction (
const uint32_t& tid)
| redist_transaction4_0_1_abort_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Abort transaction.
Parameters:
| tid | the transaction ID of this transaction. |
| XrlCmdError redist_transaction4_0_1_add_route (
const uint32_t& tid,
const IPv4Net& dst,
const IPv4& nexthop,
const string& ifname,
const string& vifname,
const uint32_t& metric,
const uint32_t& admin_distance,
const string& cookie,
const string& protocol_origin)
| redist_transaction4_0_1_add_route |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete a routing entry.
Parameters:
| tid | the transaction ID of this transaction. |
| dst | destination network. |
| nexthop | nexthop router address. |
| ifname | interface name associated with nexthop. |
| vifname | virtual interface name with nexthop. |
| metric | origin routing protocol metric for route. |
| admin_distance | administrative distance of origin routing protocol. |
| cookie | value set by the requestor to identify redistribution source. Typical value is the originating protocol name. |
| protocol_origin | the name of the protocol that originated this routing entry. |
| XrlCmdError redist_transaction4_0_1_delete_route (
const uint32_t& tid,
const IPv4Net& network,
const string& cookie,
const string& protocol_origin)
| redist_transaction4_0_1_delete_route |
[protected pure virtual]
| XrlCmdError redist_transaction4_0_1_delete_all_routes (
const uint32_t& tid,
const string& cookie)
| redist_transaction4_0_1_delete_all_routes |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete all routing entries.
Parameters:
| tid | the transaction ID of this transaction. |
| cookie | value set by the requestor to identify redistribution source. Typical value is the originating protocol name. |
| XrlCmdError redist_transaction6_0_1_start_transaction (
uint32_t& tid)
| redist_transaction6_0_1_start_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Start transaction.
Parameters:
| tid | the transaction ID to use for this transaction. |
| XrlCmdError redist_transaction6_0_1_commit_transaction (
const uint32_t& tid)
| redist_transaction6_0_1_commit_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Commit transaction.
Parameters:
| tid | the transaction ID of this transaction. |
| XrlCmdError redist_transaction6_0_1_abort_transaction (
const uint32_t& tid)
| redist_transaction6_0_1_abort_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Abort transaction.
Parameters:
| tid | the transaction ID of this transaction. |
| XrlCmdError redist_transaction6_0_1_add_route (
const uint32_t& tid,
const IPv6Net& dst,
const IPv6& nexthop,
const string& ifname,
const string& vifname,
const uint32_t& metric,
const uint32_t& admin_distance,
const string& cookie,
const string& protocol_origin)
| redist_transaction6_0_1_add_route |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete a routing entry.
Parameters:
| tid | the transaction ID of this transaction. |
| dst | destination network. |
| nexthop | nexthop router address. |
| ifname | interface name associated with nexthop. |
| vifname | virtual interface name with nexthop. |
| metric | origin routing protocol metric for route. |
| admin_distance | administrative distance of origin routing protocol. |
| cookie | value set by the requestor to identify redistribution source. Typical value is the originating protocol name. |
| protocol_origin | the name of the protocol that originated this routing entry. |
| XrlCmdError redist_transaction6_0_1_delete_route (
const uint32_t& tid,
const IPv6Net& network,
const string& cookie,
const string& protocol_origin)
| redist_transaction6_0_1_delete_route |
[protected pure virtual]
| XrlCmdError redist_transaction6_0_1_delete_all_routes (
const uint32_t& tid,
const string& cookie)
| redist_transaction6_0_1_delete_all_routes |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete all routing entries.
Parameters:
| tid | the transaction ID of this transaction. |
| cookie | value set by the requestor to identify redistribution source. Typical value is the originating protocol name. |
| XrlCmdError raw_packet4_0_1_send (
const IPv4& src_address,
const IPv4& dst_address,
const string& vif_name,
const uint32_t& proto,
const uint32_t& ttl,
const uint32_t& tos,
const vector<uint8_t>& options,
const vector<uint8_t>& payload)
| raw_packet4_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send a packet on a raw socket.
| XrlCmdError raw_packet4_0_1_send_raw (
const string& vif_name,
const vector<uint8_t>& packet)
| raw_packet4_0_1_send_raw |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send raw packet. Checksum is computed and applied before transmission. All the fields within the IPv4 header must be in network order.
| XrlCmdError raw_packet4_0_1_register_vif_receiver (
const string& router_name,
const string& if_name,
const string& vif_name,
const uint32_t& proto)
| raw_packet4_0_1_register_vif_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register to receive packets. The receiver is expected to support raw_socket_client/0.1 interface.
| XrlCmdError raw_packet4_0_1_unregister_vif_receiver (
const string& router_name,
const string& if_name,
const string& vif_name,
const uint32_t& proto)
| raw_packet4_0_1_unregister_vif_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister stop receiving packets.
Parameters:
| proto | Protocol number that the receiver is interested in. |
| XrlCmdError raw_packet6_0_1_send_raw (
const IPv6& src_address,
const IPv6& dst_address,
const string& vif_name,
const uint32_t& proto,
const uint32_t& tclass,
const uint32_t& hoplimit,
const vector<uint8_t>& hopopts,
const vector<uint8_t>& packet)
| raw_packet6_0_1_send_raw |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send a raw IPv6 datagram, with packet info.
| XrlCmdError raw_packet6_0_1_register_vif_receiver (
const string& router_name,
const string& if_name,
const string& vif_name,
const uint32_t& proto)
| raw_packet6_0_1_register_vif_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register to receive IPv6 datagrams. The receiver is expected to support raw_packet6_client/0.1 interface.
| XrlCmdError raw_packet6_0_1_unregister_vif_receiver (
const string& router_name,
const string& if_name,
const string& vif_name,
const uint32_t& proto)
| raw_packet6_0_1_unregister_vif_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister stop receiving packets.
Parameters:
| proto | Protocol number that the receiver is interested in. |
| XrlCmdError socket4_locator_0_1_find_socket_server_for_addr (
const IPv4& local_addr,
string& xrl_target)
| socket4_locator_0_1_find_socket_server_for_addr |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Find suitable socket serving Xrl Target for a particular interface address.
| XrlCmdError socket6_locator_0_1_find_socket_server_for_addr (
const IPv6& local_addr,
string& xrl_target)
| socket6_locator_0_1_find_socket_server_for_addr |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Find suitable socket serving Xrl Target for a particular interface address.
| XrlCmdError profile_0_1_enable (
const string& pname)
| profile_0_1_enable |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable profiling
Parameters:
| pname | profile variable |
| XrlCmdError profile_0_1_disable (
const string& pname)
| profile_0_1_disable |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Disable profiling
Parameters:
| pname | profile variable |
| XrlCmdError profile_0_1_get_entries (
const string& pname,
const string& instance_name)
| profile_0_1_get_entries |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get log entries.
Parameters:
| pname | profile variable |
| instance_name | to send the profiling info to. |
| XrlCmdError profile_0_1_clear (
const string& pname)
| profile_0_1_clear |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Clear the profiling entries
Parameters:
| pname | profile variable |
| XrlCmdError profile_0_1_list (
string& info)
| profile_0_1_list |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
List all the profiling variables registered with this target.
