|
| ||||||||||||||||
| 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.
| const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| 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 finder_event_observer_0_1_xrl_target_birth (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_birth |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target birth to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError finder_event_observer_0_1_xrl_target_death (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_death |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target death to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError fea_click_0_1_load_click ()
| fea_click_0_1_load_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError fea_click_0_1_unload_click ()
| fea_click_0_1_unload_click |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| 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& client_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:
| client_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& client_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& client_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:
| client_target_name | the target name of the FIB client to delete. |
| XrlCmdError fea_fib_0_1_delete_fib_client6 (
const string& client_target_name)
| fea_fib_0_1_delete_fib_client6 |
[protected pure virtual]
| XrlCmdError fea_firewall_0_1_start_transaction (
uint32_t& tid)
| fea_firewall_0_1_start_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Start firewall configuration transaction.
Parameters:
| tid | the transaction ID returned by this operation. |
| XrlCmdError fea_firewall_0_1_commit_transaction (
const uint32_t& tid)
| fea_firewall_0_1_commit_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Commit firewall configuration transaction.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_abort_transaction (
const uint32_t& tid)
| fea_firewall_0_1_abort_transaction |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Abort firewall configuration transaction.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_add_entry4 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv4Net& src_network,
const IPv4Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_add_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add an IPv4 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_replace_entry4 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv4Net& src_network,
const IPv4Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_replace_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Replace an IPv4 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_delete_entry4 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv4Net& src_network,
const IPv4Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end)
| fea_firewall_0_1_delete_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete an IPv4 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be deleted. |
| vifname | the name of the vif where this filter is to be deleted. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| XrlCmdError fea_firewall_0_1_delete_all_entries4 (
const uint32_t& tid)
| fea_firewall_0_1_delete_all_entries4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete all IPv4 firewall entries.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_get_entry_list_start4 (
uint32_t& token,
bool& more)
| fea_firewall_0_1_get_entry_list_start4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get a token for a list of IPv4 firewall entries.
Parameters:
| token | to be provided when calling get_entry_list_next4. |
| more | true if the list is not empty. |
| XrlCmdError fea_firewall_0_1_get_entry_list_next4 (
const uint32_t& token,
uint32_t& rule_number,
string& ifname,
string& vifname,
IPv4Net& src_network,
IPv4Net& dst_network,
uint32_t& ip_protocol,
uint32_t& src_port_begin,
uint32_t& src_port_end,
uint32_t& dst_port_begin,
uint32_t& dst_port_end,
string& action,
bool& more)
| fea_firewall_0_1_get_entry_list_next4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the next item in a list of IPv4 firewall entries.
Parameters:
| token | returned by a previous call to get_entry_list_start4. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter exists. |
| vifname | the name of the vif where this filter exists. |
| src_network | the source IPv4 network address prefix. |
| dst_network | the destination IPv4 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| more | true if the list has more items remaining. |
| XrlCmdError fea_firewall_0_1_add_entry6 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv6Net& src_network,
const IPv6Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_add_entry6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add an IPv6 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_replace_entry6 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv6Net& src_network,
const IPv6Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end,
const string& action)
| fea_firewall_0_1_replace_entry6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Replace an IPv6 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be applied. |
| vifname | the name of the vif where this filter is to be applied. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action to be taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| XrlCmdError fea_firewall_0_1_delete_entry6 (
const uint32_t& tid,
const uint32_t& rule_number,
const string& ifname,
const string& vifname,
const IPv6Net& src_network,
const IPv6Net& dst_network,
const uint32_t& ip_protocol,
const uint32_t& src_port_begin,
const uint32_t& src_port_end,
const uint32_t& dst_port_begin,
const uint32_t& dst_port_end)
| fea_firewall_0_1_delete_entry6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete an IPv6 firewall entry.
Parameters:
| tid | the transaction ID for this operation. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter is to be deleted. |
| vifname | the name of the vif where this filter is to be deleted. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| XrlCmdError fea_firewall_0_1_delete_all_entries6 (
const uint32_t& tid)
| fea_firewall_0_1_delete_all_entries6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete all IPv6 firewall entries.
Parameters:
| tid | the transaction ID for this operation. |
| XrlCmdError fea_firewall_0_1_get_entry_list_start6 (
uint32_t& token,
bool& more)
| fea_firewall_0_1_get_entry_list_start6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get a token for a list of IPv6 firewall entries.
Parameters:
| token | to be provided when calling get_entry_list_next6. |
| more | true if the list is not empty. |
| XrlCmdError fea_firewall_0_1_get_entry_list_next6 (
const uint32_t& token,
uint32_t& rule_number,
string& ifname,
string& vifname,
IPv6Net& src_network,
IPv6Net& dst_network,
uint32_t& ip_protocol,
uint32_t& src_port_begin,
uint32_t& src_port_end,
uint32_t& dst_port_begin,
uint32_t& dst_port_end,
string& action,
bool& more)
| fea_firewall_0_1_get_entry_list_next6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the next item in a list of IPv6 firewall entries.
Parameters:
| token | returned by a previous call to get_entry_list_start6. |
| rule_number | the rule number for this entry. |
| ifname | the name of the interface where this filter exists. |
| vifname | the name of the vif where this filter exists. |
| src_network | the source IPv6 network address prefix. |
| dst_network | the destination IPv6 network address prefix. |
| ip_protocol | the IP protocol number (1-255, or 0 if wildcard). |
| src_port_begin | the source TCP/UDP begin port (0-65535). |
| src_port_end | the source TCP/UDP end port (0-65535). |
| dst_port_begin | the destination TCP/UDP begin port (0-65535). |
| dst_port_end | the destination TCP/UDP end port (0-65535). |
| action | the action taken when this filter is matched. It is one of the following keywords: "none", "pass", "drop", "reject". |
| more | true if the list has more items remaining. |
| XrlCmdError ifmgr_0_1_set_restore_original_config_on_shutdown (
const bool& enable)
| ifmgr_0_1_set_restore_original_config_on_shutdown |
[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_interface_unreachable (
const string& ifname,
bool& unreachable)
| ifmgr_0_1_get_configured_interface_unreachable |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_interface_management (
const string& ifname,
bool& management)
| ifmgr_0_1_get_configured_interface_management |
[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_no_carrier (
const string& ifname,
bool& no_carrier)
| ifmgr_0_1_get_configured_no_carrier |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_get_configured_baudrate (
const string& ifname,
uint64_t& baudrate)
| ifmgr_0_1_get_configured_baudrate |
[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_all_interfaces_from_system (
const uint32_t& tid,
const bool& enable)
| ifmgr_0_1_configure_all_interfaces_from_system |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Implicitly configure all interfaces within the FEA by using information from the underlying system.
Parameters:
| tid | the transaction ID. |
| enable | if true, then enable the implicit configuration, otherwise disable it. |
| XrlCmdError ifmgr_0_1_configure_interface_from_system (
const uint32_t& tid,
const string& ifname,
const bool& enable)
| 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. |
| enable | if true, then enable the implicit configuration, otherwise disable it. |
| 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_interface_unreachable (
const uint32_t& tid,
const string& ifname,
const bool& unreachable)
| ifmgr_0_1_set_interface_unreachable |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_set_interface_management (
const uint32_t& tid,
const string& ifname,
const bool& management)
| ifmgr_0_1_set_interface_management |
[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_create_mac (
const string& ifname,
const Mac& mac)
| ifmgr_0_1_create_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_delete_mac (
const string& ifname,
const Mac& mac)
| ifmgr_0_1_delete_mac |
[protected pure virtual]
| XrlCmdError ifmgr_0_1_restore_original_mac (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_restore_original_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_restore_original_mtu (
const uint32_t& tid,
const string& ifname)
| ifmgr_0_1_restore_original_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_set_vif_vlan (
const uint32_t& tid,
const string& ifname,
const string& vif,
const uint32_t& vlan_id)
| ifmgr_0_1_set_vif_vlan |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set VLAN vif.
Parameters:
| ifname | the name of the physical interface associated with the VLAN. |
| vif | the name of the VLAN. |
| vlan_id | the VLAN ID. It must be in the range 0 through 4095. |
| 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_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 fti_0_2_set_unicast_forwarding_entries_retain_on_startup4 (
const bool& retain)
| fti_0_2_set_unicast_forwarding_entries_retain_on_startup4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv4 unicast forwarding engine whether to retain existing XORP forwarding entries on startup.
Parameters:
| retain | if true, then retain the XORP forwarding entries, otherwise delete them. |
| XrlCmdError fti_0_2_set_unicast_forwarding_entries_retain_on_shutdown4 (
const bool& retain)
| fti_0_2_set_unicast_forwarding_entries_retain_on_shutdown4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv4 unicast forwarding engine whether to retain existing XORP forwarding entries on shutdown.
Parameters:
| retain | if true, then retain the XORP forwarding entries, otherwise delete them. |
| XrlCmdError fti_0_2_set_unicast_forwarding_entries_retain_on_startup6 (
const bool& retain)
| fti_0_2_set_unicast_forwarding_entries_retain_on_startup6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv6 unicast forwarding engine whether to retain existing XORP forwarding entries on startup.
Parameters:
| retain | if true, then retain the XORP forwarding entries, otherwise delete them. |
| XrlCmdError fti_0_2_set_unicast_forwarding_entries_retain_on_shutdown6 (
const bool& retain)
| fti_0_2_set_unicast_forwarding_entries_retain_on_shutdown6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv6 unicast forwarding engine whether to retain existing XORP forwarding entries on shutdown.
Parameters:
| retain | if true, then retain the XORP forwarding entries, otherwise delete them. |
| XrlCmdError fti_0_2_set_unicast_forwarding_table_id4 (
const bool& is_configured,
const uint32_t& table_id)
| fti_0_2_set_unicast_forwarding_table_id4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv4 unicast forwarding table ID to be used.
Parameters:
| is_configured | if true, the forwarding table ID is configured, otherwise the default table should be used. |
| table_id | the IPv4 unicast forwarding table ID to be used. |
| XrlCmdError fti_0_2_set_unicast_forwarding_table_id6 (
const bool& is_configured,
const uint32_t& table_id)
| fti_0_2_set_unicast_forwarding_table_id6 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IPv6 unicast forwarding table ID to be used.
Parameters:
| is_configured | if true, the forwarding table ID is configured, otherwise the default table should be used. |
| table_id | the IPv6 unicast forwarding table ID to be used. |
| 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& 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_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& 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_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_link_0_1_send (
const string& if_name,
const string& vif_name,
const Mac& src_address,
const Mac& dst_address,
const uint32_t& ether_type,
const vector<uint8_t>& payload)
| raw_link_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send a raw link-level packet on an interface.
Parameters:
| if_name | the interface to send the packet on. |
| vif_name | the vif to send the packet on. |
| src_address | the MAC source address. |
| dst_address | the MAC destination address. |
| ether_type | the EtherType protocol type or the Destination SAP. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP IEEE 802.2 LLC frames. |
| payload | the payload, everything after the MAC header. |
| XrlCmdError raw_link_0_1_register_receiver (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ether_type,
const string& filter_program,
const bool& enable_multicast_loopback)
| raw_link_0_1_register_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register to receive raw link-level packets. The receiver is expected to support raw_link_client/0.1 interface.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should be accepted. |
| vif_name | the vif through which packets should be accepted. |
| ether_type | the EtherType protocol number or the Destination SAP that the receiver is interested in. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP for IEEE 802.2 LLC frames. A protocol number of 0 is used to specify all protocols. |
| filter_program | the optional filter program to be applied on the received packets. The program uses tcpdump(1) style expression. |
| enable_multicast_loopback | if true then enable delivering of multicast datagrams back to this host (assuming the host is a member of the same multicast group). |
| XrlCmdError raw_link_0_1_unregister_receiver (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ether_type,
const string& filter_program)
| raw_link_0_1_unregister_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister to receive raw link-level packets.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should not be accepted. |
| vif_name | the vif through which packets should not be accepted. |
| ether_type | the EtherType protocol number or the Destination SAP that the receiver is not interested in anymore. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP for IEEE 802.2 LLC frames. A protocol number of 0 is used to specify all protocols. |
| filter_program | the filter program that was applied on the received packets. The program uses tcpdump(1) style expression. |
| XrlCmdError raw_link_0_1_join_multicast_group (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ether_type,
const string& filter_program,
const Mac& group_address)
| raw_link_0_1_join_multicast_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Join a MAC multicast group.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should be accepted. |
| vif_name | the vif through which packets should be accepted. |
| ether_type | the EtherType protocol number or the Destination SAP that the receiver is interested in. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP for IEEE 802.2 LLC frames. A protocol number of 0 is used to specify all protocols. |
| filter_program | the optional filter program to be applied on the received packets. The program uses tcpdump(1) style expression. |
| group_address | the multicast group address to join. |
| XrlCmdError raw_link_0_1_leave_multicast_group (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ether_type,
const string& filter_program,
const Mac& group_address)
| raw_link_0_1_leave_multicast_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Leave a MAC multicast group.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should not be accepted. |
| vif_name | the vif through which packets should not be accepted. |
| ether_type | the EtherType protocol number or the Destination SAP that the receiver is not interested in anymore. It must be between 1536 and 65535 to specify the EtherType, or between 1 and 255 to specify the Destination SAP for IEEE 802.2 LLC frames. A protocol number of 0 is used to specify all protocols. |
| filter_program | the filter program that was applied on the received packets. The program uses tcpdump(1) style expression. |
| group_address | the multicast group address to leave. |
| XrlCmdError raw_packet4_0_1_send (
const string& if_name,
const string& vif_name,
const IPv4& src_address,
const IPv4& dst_address,
const uint32_t& ip_protocol,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& ip_router_alert,
const bool& ip_internet_control,
const vector<uint8_t>& payload)
| raw_packet4_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send an IPv4 packet on a raw socket.
Parameters:
| if_name | the interface to send the packet on. It is essential for multicast. In the unicast case this field may be empty. |
| vif_name | the vif to send the packet on. It is essential for multicast. In the unicast case this field may be empty. |
| src_address | the IP source address. |
| dst_address | the IP destination address. |
| ip_protocol | the IP protocol number. It must be between 1 and 255. |
| ip_ttl | the IP TTL (hop-limit). If it has a negative value, the TTL will be set internally before transmission. |
| ip_tos | the Type Of Service (Diffserv/ECN bits for IPv4). If it has a negative value, the TOS will be set internally before transmission. |
| ip_router_alert | if true, then add the IP Router Alert option to the IP packet. |
| ip_internet_control | if true, then this is IP control traffic. |
| payload | the payload, everything after the IP header and options. |
| XrlCmdError raw_packet4_0_1_register_receiver (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol,
const bool& enable_multicast_loopback)
| raw_packet4_0_1_register_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register to receive IPv4 packets. The receiver is expected to support raw_packet4_client/0.1 interface.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should be accepted. |
| vif_name | the vif through which packets should be accepted. |
| ip_protocol | the IP protocol number that the receiver is interested in. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| enable_multicast_loopback | if true then enable delivering of multicast datagrams back to this host (assuming the host is a member of the same multicast group. |
| XrlCmdError raw_packet4_0_1_unregister_receiver (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol)
| raw_packet4_0_1_unregister_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister to receive IPv4 packets.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should not be accepted. |
| vif_name | the vif through which packets should not be accepted. |
| ip_protocol | the IP Protocol number that the receiver is not interested in anymore. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| XrlCmdError raw_packet4_0_1_join_multicast_group (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol,
const IPv4& group_address)
| raw_packet4_0_1_join_multicast_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Join an IPv4 multicast group.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should be accepted. |
| vif_name | the vif through which packets should be accepted. |
| ip_protocol | the IP protocol number that the receiver is interested in. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| group_address | the multicast group address to join. |
| XrlCmdError raw_packet4_0_1_leave_multicast_group (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol,
const IPv4& group_address)
| raw_packet4_0_1_leave_multicast_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Leave an IPv4 multicast group.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should not be accepted. |
| vif_name | the vif through which packets should not be accepted. |
| ip_protocol | the IP protocol number that the receiver is not interested in anymore. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| group_address | the multicast group address to leave. |
| XrlCmdError raw_packet6_0_1_send (
const string& if_name,
const string& vif_name,
const IPv6& src_address,
const IPv6& dst_address,
const uint32_t& ip_protocol,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& ip_router_alert,
const bool& ip_internet_control,
const XrlAtomList& ext_headers_type,
const XrlAtomList& ext_headers_payload,
const vector<uint8_t>& payload)
| raw_packet6_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send an IPv6 packet on a raw socket.
Parameters:
| if_name | the interface to send the packet on. It is essential for multicast. In the unicast case this field may be empty. |
| vif_name | the vif to send the packet on. It is essential for multicast. In the unicast case this field may be empty. |
| src_address | the IP source address. |
| dst_address | the IP destination address. |
| ip_protocol | the IP protocol number. It must be between 1 and 255. |
| ip_ttl | the IP TTL (hop-limit). If it has a negative value, the TTL will be set internally before transmission. |
| ip_tos | the Type Of Service (IP traffic class for IPv6). If it has a negative value, the TOS will be set internally before transmission. |
| ip_router_alert | if true, then add the IP Router Alert option to the IP packet. |
| ip_internet_control | if true, then this is IP control traffic. |
| ext_headers_type | a list of u32 integers with the types of the optional extention headers. |
| ext_headers_payload | a list of payload data, one for each optional extention header. The number of entries must match ext_headers_type. |
| payload | the payload, everything after the IP header and options. |
| XrlCmdError raw_packet6_0_1_register_receiver (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol,
const bool& enable_multicast_loopback)
| raw_packet6_0_1_register_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Register to receive IPv6 packets. The receiver is expected to support raw_packet6_client/0.1 interface.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should be accepted. |
| vif_name | the vif through which packets should be accepted. |
| ip_protocol | the IP protocol number that the receiver is interested in. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| enable_multicast_loopback | if true then enable delivering of multicast datagrams back to this host (assuming the host is a member of the same multicast group. |
| XrlCmdError raw_packet6_0_1_unregister_receiver (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol)
| raw_packet6_0_1_unregister_receiver |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Unregister to receive IPv6 packets.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should not be accepted. |
| vif_name | the vif through which packets should not be accepted. |
| ip_protocol | the IP Protocol number that the receiver is not interested in anymore. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| XrlCmdError raw_packet6_0_1_join_multicast_group (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol,
const IPv6& group_address)
| raw_packet6_0_1_join_multicast_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Join an IPv6 multicast group.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should be accepted. |
| vif_name | the vif through which packets should be accepted. |
| ip_protocol | the IP protocol number that the receiver is interested in. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| group_address | the multicast group address to join. |
| XrlCmdError raw_packet6_0_1_leave_multicast_group (
const string& xrl_target_instance_name,
const string& if_name,
const string& vif_name,
const uint32_t& ip_protocol,
const IPv6& group_address)
| raw_packet6_0_1_leave_multicast_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Leave an IPv6 multicast group.
Parameters:
| xrl_target_instance_name | the receiver's XRL target instance name. |
| if_name | the interface through which packets should not be accepted. |
| vif_name | the vif through which packets should not be accepted. |
| ip_protocol | the IP protocol number that the receiver is not interested in anymore. It must be between 0 and 255. A protocol number of 0 is used to specify all protocols. |
| group_address | the multicast group address to leave. |
| XrlCmdError socket4_0_1_tcp_open (
const string& creator,
string& sockid)
| socket4_0_1_tcp_open |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Open a TCP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_udp_open (
const string& creator,
string& sockid)
| socket4_0_1_udp_open |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Open an UDP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_tcp_open_and_bind (
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
string& sockid)
| socket4_0_1_tcp_open_and_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound TCP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_udp_open_and_bind (
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
string& sockid)
| socket4_0_1_udp_open_and_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound UDP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_udp_open_bind_join (
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& mcast_addr,
const uint32_t& ttl,
const bool& reuse,
string& sockid)
| socket4_0_1_udp_open_bind_join |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound UDP multicast socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| mcast_addr | the multicast group address to join. |
| ttl | the TTL to use for this multicast socket. |
| reuse | allow other sockets to bind to same multicast group. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_tcp_open_bind_connect (
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& remote_addr,
const uint32_t& remote_port,
string& sockid)
| socket4_0_1_tcp_open_bind_connect |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound and connected TCP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| remote_addr | the address to connect to. |
| remote_port | the remote port to connect to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_udp_open_bind_connect (
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& remote_addr,
const uint32_t& remote_port,
string& sockid)
| socket4_0_1_udp_open_bind_connect |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound and connected UDP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| remote_addr | the address to connect to. |
| remote_port | the remote port to connect to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_udp_open_bind_broadcast (
const string& creator,
const string& ifname,
const string& vifname,
const uint32_t& local_port,
const uint32_t& remote_port,
const bool& reuse,
const bool& limited,
const bool& connected,
string& sockid)
| socket4_0_1_udp_open_bind_broadcast |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound, and optionally connected, UDP broadcast socket. This socket may be used for sending and receiving IPv4 broadcasts on a named if/vif. The TTL is always set to 1 on creation. The creator must specify if this socket is to be used for limited broadcasts (255.255.255.255) as this is a special case on many platforms.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| ifname | the interface name to bind socket to. |
| vifname | the vif to bind socket to. |
| local_port | the port to bind socket to. |
| remote_port | the remote port to connect to. |
| reuse | allow other sockets to bind to same port. |
| limited | set the socket up for transmission to the limited broadcast address 255.255.255.255. |
| connected | connect the socket for use with send() not sendto(). |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket4_0_1_bind (
const string& sockid,
const IPv4& local_addr,
const uint32_t& local_port)
| socket4_0_1_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Bind a socket.
Parameters:
| sockid | the socket ID of the socket to bind. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| XrlCmdError socket4_0_1_udp_join_group (
const string& sockid,
const IPv4& mcast_addr,
const IPv4& join_if_addr)
| socket4_0_1_udp_join_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Join multicast group on already bound socket.
Parameters:
| sockid | unique socket ID. |
| mcast_addr | group to join. |
| join_if_addr | interface address to perform join on. |
| XrlCmdError socket4_0_1_udp_leave_group (
const string& sockid,
const IPv4& mcast_addr,
const IPv4& leave_if_addr)
| socket4_0_1_udp_leave_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Leave multicast group on already bound socket.
Parameters:
| sockid | unique socket ID. |
| mcast_addr | group to leave. |
| leave_if_addr | interface address to perform leave on. |
| XrlCmdError socket4_0_1_close (
const string& sockid)
| socket4_0_1_close |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Close socket.
Parameters:
| sockid | unique socket ID of socket to be closed. |
| XrlCmdError socket4_0_1_tcp_listen (
const string& sockid,
const uint32_t& backlog)
| socket4_0_1_tcp_listen |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Listen for inbound connections on socket. When a connection request received the socket creator will receive notification through socket4_user/0.1/inbound_connect_event.
Parameters:
| sockid | the unique socket ID of the socket to perform listen. |
| backlog | the maximum number of pending connections. |
| XrlCmdError socket4_0_1_udp_enable_recv (
const string& sockid)
| socket4_0_1_udp_enable_recv |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable a UDP socket for datagram reception. If a UDP socket has been created without using the usual convenience XRLs, it is necessary to hook up its FEA internal input path by calling this XRL. It is similar in intent to tcp_listen, but named differently as it never uses the listen() socket API.
Parameters:
| sockid | the unique socket ID of the socket to enable for datagram reception. |
| XrlCmdError socket4_0_1_send (
const string& sockid,
const vector<uint8_t>& data)
| socket4_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data on socket.
Parameters:
| sockid | unique socket ID. |
| data | block of data to be sent. |
| XrlCmdError socket4_0_1_send_to (
const string& sockid,
const IPv4& remote_addr,
const uint32_t& remote_port,
const vector<uint8_t>& data)
| socket4_0_1_send_to |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data on socket to a given destination. The packet is not routed as the forwarding engine sending the packet may not have access to the full routing table.
Parameters:
| sockid | unique socket ID. |
| remote_addr | destination address for data. |
| remote_port | destination port for data. |
| data | block of data to be sent. |
| XrlCmdError socket4_0_1_send_from_multicast_if (
const string& sockid,
const IPv4& group_addr,
const uint32_t& group_port,
const IPv4& ifaddr,
const vector<uint8_t>& data)
| socket4_0_1_send_from_multicast_if |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data on socket to a given multicast group from a given interface.
Parameters:
| sockid | unique socket ID. |
| group_addr | destination address for data. |
| group_port | destination port for data. |
| ifaddr | interface address |
| XrlCmdError socket4_0_1_set_socket_option (
const string& sockid,
const string& optname,
const uint32_t& optval)
| socket4_0_1_set_socket_option |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set a named socket option with an integer value. XXX: The "onesbcast" and "reuseport" options exist to work around an architectural issue in the BSD IPv4 stack. They SHOULD NOT be used for new code.
Parameters:
| sockid | unique socket ID. |
| optname | name of option to be set. Valid values are: "onesbcast" "receive_broadcast" "reuseport" "send_broadcast" "tos" "ttl" "multicast_loopback" "multicast_ttl" |
| optval | integer value of option to be set. If value is logically boolean, then zero represents 'false', and any non-zero value represents 'true'. |
| XrlCmdError socket4_0_1_set_socket_option_txt (
const string& sockid,
const string& optname,
const string& optval)
| socket4_0_1_set_socket_option_txt |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set a named socket option with a string value. XXX: The "bindtodevice" option exists to workaround an architectural issue in the Linux IPv4 stack. It SHOULD NOT be used for new code.
Parameters:
| sockid | unique socket ID. |
| optname | name of option to be set. Valid values are: "bindtodevice" |
| optval | value of option to be set. |
| XrlCmdError socket6_0_1_tcp_open (
const string& creator,
string& sockid)
| socket6_0_1_tcp_open |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Open a TCP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_udp_open (
const string& creator,
string& sockid)
| socket6_0_1_udp_open |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Open an UDP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_tcp_open_and_bind (
const string& creator,
const IPv6& local_addr,
const uint32_t& local_port,
string& sockid)
| socket6_0_1_tcp_open_and_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound TCP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket6_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_udp_open_and_bind (
const string& creator,
const IPv6& local_addr,
const uint32_t& local_port,
string& sockid)
| socket6_0_1_udp_open_and_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound UDP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket6_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_udp_open_bind_join (
const string& creator,
const IPv6& local_addr,
const uint32_t& local_port,
const IPv6& mcast_addr,
const uint32_t& ttl,
const bool& reuse,
string& sockid)
| socket6_0_1_udp_open_bind_join |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound UDP multicast socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket6_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| mcast_addr | the multicast group address to join. |
| ttl | the ttl to use for this multicast socket. |
| reuse | allow other sockets to bind to same multicast group. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_tcp_open_bind_connect (
const string& creator,
const IPv6& local_addr,
const uint32_t& local_port,
const IPv6& remote_addr,
const uint32_t& remote_port,
string& sockid)
| socket6_0_1_tcp_open_bind_connect |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound and connected TCP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket6_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| remote_addr | the address to connect to. |
| remote_port | the remote port to connect to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_udp_open_bind_connect (
const string& creator,
const IPv6& local_addr,
const uint32_t& local_port,
const IPv6& remote_addr,
const uint32_t& remote_port,
string& sockid)
| socket6_0_1_udp_open_bind_connect |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Create a bound and connected UDP socket.
Parameters:
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket6_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| remote_addr | the address to connect to. |
| remote_port | the remote port to connect to. |
| sockid | return parameter that contains unique socket ID when socket instantiation is successful. |
| XrlCmdError socket6_0_1_bind (
const string& sockid,
const IPv6& local_addr,
const uint32_t& local_port)
| socket6_0_1_bind |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Bind a socket.
Parameters:
| sockid | the socket ID of the socket to bind. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| XrlCmdError socket6_0_1_udp_join_group (
const string& sockid,
const IPv6& mcast_addr,
const IPv6& join_if_addr)
| socket6_0_1_udp_join_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Join multicast group on already bound socket.
Parameters:
| sockid | unique socket ID. |
| mcast_addr | group to join. |
| join_if_addr | interface address to perform join on. |
| XrlCmdError socket6_0_1_udp_leave_group (
const string& sockid,
const IPv6& mcast_addr,
const IPv6& leave_if_addr)
| socket6_0_1_udp_leave_group |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Leave multicast group on already bound socket.
Parameters:
| sockid | unique socket ID. |
| mcast_addr | group to leave. |
| leave_if_addr | interface address to perform leave on. |
| XrlCmdError socket6_0_1_close (
const string& sockid)
| socket6_0_1_close |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Close socket.
Parameters:
| sockid | unique socket ID of socket to be closed. |
| XrlCmdError socket6_0_1_tcp_listen (
const string& sockid,
const uint32_t& backlog)
| socket6_0_1_tcp_listen |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Listen for inbound connections on socket. When a connection request received the socket creator will receive notification through socket6_user/0.1/inbound_connect_event.
Parameters:
| sockid | the unique socket ID of the socket to perform listen. |
| backlog | the maximum number of pending connections. |
| XrlCmdError socket6_0_1_send (
const string& sockid,
const vector<uint8_t>& data)
| socket6_0_1_send |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data on socket.
Parameters:
| sockid | unique socket ID. |
| data | block of data to be sent. |
| XrlCmdError socket6_0_1_send_to (
const string& sockid,
const IPv6& remote_addr,
const uint32_t& remote_port,
const vector<uint8_t>& data)
| socket6_0_1_send_to |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data on socket to a given destination. The packet is not routed as the forwarding engine sending the packet may not have access to the full routing table.
Parameters:
| sockid | unique socket ID. |
| remote_addr | destination address for data. |
| remote_port | destination port for data. |
| data | block of data to be sent. |
| XrlCmdError socket6_0_1_send_from_multicast_if (
const string& sockid,
const IPv6& group_addr,
const uint32_t& group_port,
const IPv6& ifaddr,
const vector<uint8_t>& data)
| socket6_0_1_send_from_multicast_if |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Send data on socket to a given multicast group from a given interface.
Parameters:
| sockid | unique socket ID. |
| group_addr | destination address for data. |
| group_port | destination port for data. |
| ifaddr | interface address |
| XrlCmdError socket6_0_1_set_socket_option (
const string& sockid,
const string& optname,
const uint32_t& optval)
| socket6_0_1_set_socket_option |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set a named socket option with an integer value.
Parameters:
| sockid | unique socket ID. |
| optname | name of option to be set. Valid values are: "reuseport" "ttl" "multicast_loopback" "multicast_ttl" |
| optval | value of option to be set. If value is logically boolean then zero represents false and any non-zero value true. |
| 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.
