|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlMld6igmpTargetBase (XrlCmdMap* cmds = 0)
| XrlMld6igmpTargetBase |
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. |
| ~XrlMld6igmpTargetBase ()
| ~XrlMld6igmpTargetBase |
[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 cli_processor_0_1_process_command (
const string& processor_name,
const string& cli_term_name,
const uint32_t& cli_session_id,
const string& command_name,
const string& command_args,
string& ret_processor_name,
string& ret_cli_term_name,
uint32_t& ret_cli_session_id,
string& ret_command_output)
| cli_processor_0_1_process_command |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Process a CLI command.
Parameters:
| processor_name | the processor name for this command. |
| cli_term_name | the terminal name the command was entered from. |
| cli_session_id | the CLI session ID the command was entered from. |
| command_name | the command name to process. |
| command_args | the command arguments to process. |
| ret_processor_name | the processor name to return back to the CLI. |
| ret_cli_term_name | the terminal name to return back. |
| ret_cli_session_id | the CLI session ID to return back. |
| ret_command_output | the command output to return back. |
| XrlCmdError mfea_client_0_1_new_vif (
const string& vif_name,
const uint32_t& vif_index)
| mfea_client_0_1_new_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add a new vif.
Parameters:
| vif_name | the name of the new vif. |
| vif_index | the index of the new vif. |
| XrlCmdError mfea_client_0_1_delete_vif (
const string& vif_name)
| mfea_client_0_1_delete_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete an existing vif.
Parameters:
| vif_name | the name of the vif to delete. |
| XrlCmdError mfea_client_0_1_add_vif_addr4 (
const string& vif_name,
const IPv4& addr,
const IPv4Net& subnet,
const IPv4& broadcast,
const IPv4& peer)
| mfea_client_0_1_add_vif_addr4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add an address to a vif.
Parameters:
| vif_name | the name of the vif. |
| addr | the unicast address to add. |
| subnet | the subnet address to add. |
| broadcast | the broadcast address (when applicable). |
| peer | the peer address (when applicable). |
| XrlCmdError mfea_client_0_1_add_vif_addr6 (
const string& vif_name,
const IPv6& addr,
const IPv6Net& subnet,
const IPv6& broadcast,
const IPv6& peer)
| mfea_client_0_1_add_vif_addr6 |
[protected pure virtual]
| XrlCmdError mfea_client_0_1_delete_vif_addr4 (
const string& vif_name,
const IPv4& addr)
| mfea_client_0_1_delete_vif_addr4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete an address from a vif.
Parameters:
| vif_name | the name of the vif. |
| addr | the unicast address to delete. |
| XrlCmdError mfea_client_0_1_delete_vif_addr6 (
const string& vif_name,
const IPv6& addr)
| mfea_client_0_1_delete_vif_addr6 |
[protected pure virtual]
| XrlCmdError mfea_client_0_1_set_vif_flags (
const string& vif_name,
const bool& is_pim_register,
const bool& is_p2p,
const bool& is_loopback,
const bool& is_multicast,
const bool& is_broadcast,
const bool& is_up)
| mfea_client_0_1_set_vif_flags |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set flags to a vif.
Parameters:
| vif_name | the name of the vif. |
| is_pim_register | true if this is a PIM Register vif. |
| is_p2p | true if this is a point-to-point vif. |
| is_loopback | true if this is a loopback interface. |
| is_multicast | true if the vif is multicast-capable. |
| is_broadcast | true if the vif is broadcast-capable. |
| is_up | true if the vif is UP and running. |
| XrlCmdError mfea_client_0_1_set_all_vifs_done ()
| mfea_client_0_1_set_all_vifs_done |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Complete all transactions with vif information.
| XrlCmdError mfea_client_0_1_is_vif_setup_completed (
bool& is_completed)
| mfea_client_0_1_is_vif_setup_completed |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test if the vif setup is completed.
Parameters:
| is_completed | if true the vif setup is completed. |
| XrlCmdError mfea_client_0_1_recv_protocol_message4 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& source_address,
const IPv4& dest_address,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& is_router_alert,
const vector<uint8_t>& protocol_message)
| mfea_client_0_1_recv_protocol_message4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Receive a protocol message from the MFEA.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| protocol_name | the name of the protocol that sends a message. |
| protocol_id | the ID of the protocol that sends a message (both sides must agree on the particular values). |
| vif_name | the name of the vif the message was received on. |
| vif_index | the index of the vif the message was received on. |
| source_address | the address of the sender. |
| dest_address | the destination address. |
| ip_ttl | the TTL of the received IP packet. If it has a negative value, it should be ignored. |
| ip_tos | the TOS of the received IP packet. If it has a negative value, it should be ignored. |
| is_router_alert | if true, the IP Router Alert option in the IP packet was set (when applicable). |
| protocol_message | the protocol message. |
| XrlCmdError mfea_client_0_1_recv_protocol_message6 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& source_address,
const IPv6& dest_address,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& is_router_alert,
const vector<uint8_t>& protocol_message)
| mfea_client_0_1_recv_protocol_message6 |
[protected pure virtual]
| XrlCmdError mfea_client_0_1_recv_kernel_signal_message4 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const uint32_t& message_type,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& source_address,
const IPv4& dest_address,
const vector<uint8_t>& protocol_message)
| mfea_client_0_1_recv_kernel_signal_message4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Receive a kernel signal message from the MFEA.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| protocol_name | the name of the protocol that sends a message. |
| protocol_id | the ID of the protocol that sends a message (both sides must agree on the particular values). |
| message_type | the type of the kernel signal message (TODO: integer for now: the particular types are well-known by both sides). |
| vif_name | the name of the vif the message was received on. |
| vif_index | the index of the vif the message was received on. |
| source_address | the address of the sender. |
| dest_address | the destination address. |
| protocol_message | the protocol message. |
| XrlCmdError mfea_client_0_1_recv_kernel_signal_message6 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const uint32_t& message_type,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& source_address,
const IPv6& dest_address,
const vector<uint8_t>& protocol_message)
| mfea_client_0_1_recv_kernel_signal_message6 |
[protected pure virtual]
| XrlCmdError mfea_client_0_1_add_mrib4 (
const string& xrl_sender_name,
const IPv4Net& dest_prefix,
const IPv4& next_hop_router_addr,
const string& next_hop_vif_name,
const uint32_t& next_hop_vif_index,
const uint32_t& metric_preference,
const uint32_t& metric)
| mfea_client_0_1_add_mrib4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add Multicast Routing Information Base information.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| dest_prefix | the destination prefix to add. |
| next_hop_router_addr | the address of the next-hop router toward the destination prefix. |
| next_hop_vif_name | the name of the vif toward the destination prefix. |
| next_hop_vif_index | the index of the vif toward the destination prefix. |
| metric_preference | the metric preference for this entry. |
| metric | the metric for this entry. |
| XrlCmdError mfea_client_0_1_add_mrib6 (
const string& xrl_sender_name,
const IPv6Net& dest_prefix,
const IPv6& next_hop_router_addr,
const string& next_hop_vif_name,
const uint32_t& next_hop_vif_index,
const uint32_t& metric_preference,
const uint32_t& metric)
| mfea_client_0_1_add_mrib6 |
[protected pure virtual]
| XrlCmdError mfea_client_0_1_delete_mrib4 (
const string& xrl_sender_name,
const IPv4Net& dest_prefix)
| mfea_client_0_1_delete_mrib4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Delete Multicast Routing Information Base information.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| dest_prefix | the destination prefix to delete. |
| XrlCmdError mfea_client_0_1_delete_mrib6 (
const string& xrl_sender_name,
const IPv6Net& dest_prefix)
| mfea_client_0_1_delete_mrib6 |
[protected pure virtual]
| XrlCmdError mfea_client_0_1_set_mrib_done (
const string& xrl_sender_name)
| mfea_client_0_1_set_mrib_done |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Complete a transaction with MRIB information.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| XrlCmdError mfea_client_0_1_recv_dataflow_signal4 (
const string& xrl_sender_name,
const IPv4& source_address,
const IPv4& group_address,
const uint32_t& threshold_interval_sec,
const uint32_t& threshold_interval_usec,
const uint32_t& measured_interval_sec,
const uint32_t& measured_interval_usec,
const uint32_t& threshold_packets,
const uint32_t& threshold_bytes,
const uint32_t& measured_packets,
const uint32_t& measured_bytes,
const bool& is_threshold_in_packets,
const bool& is_threshold_in_bytes,
const bool& is_geq_upcall,
const bool& is_leq_upcall)
| mfea_client_0_1_recv_dataflow_signal4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
A signal that a dataflow-related pre-condition is true.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| source_address | the source address of the dataflow. |
| group_address | the group address of the dataflow. |
| threshold_interval_sec | the number of seconds in the interval requested for measurement. |
| threshold_interval_usec | the number of microseconds in the interval requested for measurement. |
| measured_interval_sec | the number of seconds in the last measured interval that has triggered the signal. |
| measured_interval_usec | the number of microseconds in the last measured interval that has triggered the signal. |
| threshold_packets | the threshold value to trigger a signal (in number of packets). |
| threshold_bytes | the threshold value to trigger a signal (in bytes). |
| measured_packets | the number of packets measured within the measured interval. |
| measured_bytes | the number of bytes measured within the measured interval. |
| is_threshold_in_packets | if true, threshold_packets is valid. |
| is_threshold_in_bytes | if true, threshold_bytes is valid. |
| is_geq_upcall | if true, the operation for comparison is ">=". |
| is_leq_upcall | if true, the operation for comparison is "<=". |
| XrlCmdError mfea_client_0_1_recv_dataflow_signal6 (
const string& xrl_sender_name,
const IPv6& source_address,
const IPv6& group_address,
const uint32_t& threshold_interval_sec,
const uint32_t& threshold_interval_usec,
const uint32_t& measured_interval_sec,
const uint32_t& measured_interval_usec,
const uint32_t& threshold_packets,
const uint32_t& threshold_bytes,
const uint32_t& measured_packets,
const uint32_t& measured_bytes,
const bool& is_threshold_in_packets,
const bool& is_threshold_in_bytes,
const bool& is_geq_upcall,
const bool& is_leq_upcall)
| mfea_client_0_1_recv_dataflow_signal6 |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_vif (
const string& vif_name,
const bool& enable)
| mld6igmp_0_1_enable_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop a MLD6IGMP vif interface.
Parameters:
| vif_name | the name of the vif to enable/disable/start/stop. |
| enable | if true, then enable the vif, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_start_vif (
const string& vif_name)
| mld6igmp_0_1_start_vif |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_vif (
const string& vif_name)
| mld6igmp_0_1_stop_vif |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_all_vifs (
const bool& enable)
| mld6igmp_0_1_enable_all_vifs |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop all MLD6IGMP vif interfaces.
Parameters:
| enable | if true, then enable the vifs, otherwise disable them. |
| XrlCmdError mld6igmp_0_1_start_all_vifs ()
| mld6igmp_0_1_start_all_vifs |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_all_vifs ()
| mld6igmp_0_1_stop_all_vifs |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_mld6igmp (
const bool& enable)
| mld6igmp_0_1_enable_mld6igmp |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop the MLD6IGMP protocol.
Parameters:
| enable | if true, then enable the MLD6IGMP protocol, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_start_mld6igmp ()
| mld6igmp_0_1_start_mld6igmp |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_mld6igmp ()
| mld6igmp_0_1_stop_mld6igmp |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_cli (
const bool& enable)
| mld6igmp_0_1_enable_cli |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop the MLD6IGMP CLI access.
Parameters:
| enable | if true, then enable the MLD6IGMP CLI access, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_start_cli ()
| mld6igmp_0_1_start_cli |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_cli ()
| mld6igmp_0_1_stop_cli |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_get_vif_proto_version (
const string& vif_name,
uint32_t& proto_version)
| mld6igmp_0_1_get_vif_proto_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Configure MLD6IGMP interface-related metrics. The 'set_foo' XRLs set the particular values. The 'reset_foo' XRLs reset the metrics to their default values.
Parameters:
| vif_name | the name of the vif to configure. |
| proto_version | the protocol version. |
| XrlCmdError mld6igmp_0_1_set_vif_proto_version (
const string& vif_name,
const uint32_t& proto_version)
| mld6igmp_0_1_set_vif_proto_version |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_reset_vif_proto_version (
const string& vif_name)
| mld6igmp_0_1_reset_vif_proto_version |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_log_trace_all (
const bool& enable)
| mld6igmp_0_1_log_trace_all |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable the MLD6IGMP trace log for all operations.
Parameters:
| enable | if true, then enable the trace log, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_add_protocol4 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_add_protocol4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete a client protocol in the MLD/IGMP protocol.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| protocol_name | the name of the protocol to add/delete. |
| protocol_id | the ID of the protocol to add/delete (both sides must agree on the particular values). |
| vif_name | the name of the vif the protocol add/delete to apply to. |
| vif_index | the index of the vif the protocol add/delete to apply to. The added protocol will receive Join/Leave membership information about same-LAN members for the particular vif. |
| XrlCmdError mld6igmp_0_1_add_protocol6 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_add_protocol6 |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_delete_protocol4 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_delete_protocol4 |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_delete_protocol6 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_delete_protocol6 |
[protected pure virtual]
