XrlCmdMap* _cmds | _cmds |
[protected]
XrlPimTargetBase (XrlCmdMap* cmds = 0)
| XrlPimTargetBase |
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. |
~XrlPimTargetBase ()
| ~XrlPimTargetBase |
[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 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 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,
const uint32_t& mtu)
| 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. |
mtu | the MTU of the vif. |
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_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 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 mld6igmp_client_0_1_add_membership4 (
const string& xrl_sender_name,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& source,
const IPv4& group)
| mld6igmp_client_0_1_add_membership4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete membership information.
Parameters:
xrl_sender_name | the XRL name of the originator of this XRL. |
vif_name | the name of the new vif. |
vif_index | the index of the new vif. |
source | the source address that has been joined/left. |
group | the group address that has been joined/left. |
XrlCmdError mld6igmp_client_0_1_add_membership6 (
const string& xrl_sender_name,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& source,
const IPv6& group)
| mld6igmp_client_0_1_add_membership6 |
[protected pure virtual]
XrlCmdError mld6igmp_client_0_1_delete_membership4 (
const string& xrl_sender_name,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& source,
const IPv4& group)
| mld6igmp_client_0_1_delete_membership4 |
[protected pure virtual]
XrlCmdError mld6igmp_client_0_1_delete_membership6 (
const string& xrl_sender_name,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& source,
const IPv6& group)
| mld6igmp_client_0_1_delete_membership6 |
[protected pure virtual]
XrlCmdError pim_0_1_enable_vif (
const string& vif_name,
const bool& enable)
| pim_0_1_enable_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop a PIM 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 pim_0_1_start_vif (
const string& vif_name)
| pim_0_1_start_vif |
[protected pure virtual]
XrlCmdError pim_0_1_stop_vif (
const string& vif_name)
| pim_0_1_stop_vif |
[protected pure virtual]
XrlCmdError pim_0_1_enable_all_vifs (
const bool& enable)
| pim_0_1_enable_all_vifs |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop all PIM vif interfaces.
Parameters:
enable | if true, then enable the vifs, otherwise disable them. |
XrlCmdError pim_0_1_start_all_vifs ()
| pim_0_1_start_all_vifs |
[protected pure virtual]
XrlCmdError pim_0_1_stop_all_vifs ()
| pim_0_1_stop_all_vifs |
[protected pure virtual]
XrlCmdError pim_0_1_enable_pim (
const bool& enable)
| pim_0_1_enable_pim |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop the PIM protocol.
Parameters:
enable | if true, then enable the PIM protocol, otherwise disable it. |
XrlCmdError pim_0_1_start_pim ()
| pim_0_1_start_pim |
[protected pure virtual]
XrlCmdError pim_0_1_stop_pim ()
| pim_0_1_stop_pim |
[protected pure virtual]
XrlCmdError pim_0_1_enable_cli (
const bool& enable)
| pim_0_1_enable_cli |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop the PIM CLI access.
Parameters:
enable | if true, then enable the PIM CLI access, otherwise disable it. |
XrlCmdError pim_0_1_start_cli ()
| pim_0_1_start_cli |
[protected pure virtual]
XrlCmdError pim_0_1_stop_cli ()
| pim_0_1_stop_cli |
[protected pure virtual]
XrlCmdError pim_0_1_enable_bsr (
const bool& enable)
| pim_0_1_enable_bsr |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop BSR.
Parameters:
enable | if true, then enable the BSR, otherwise disable it. |
XrlCmdError pim_0_1_start_bsr ()
| pim_0_1_start_bsr |
[protected pure virtual]
XrlCmdError pim_0_1_stop_bsr ()
| pim_0_1_stop_bsr |
[protected pure virtual]
XrlCmdError pim_0_1_add_config_scope_zone_by_vif_name4 (
const IPv4Net& scope_zone_id,
const string& vif_name)
| pim_0_1_add_config_scope_zone_by_vif_name4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete scope zone.
Parameters:
scope_zone_id | the ID of the configured zone. |
vif_name | the name of the vif to use as a bondary of the scope zone. |
XrlCmdError pim_0_1_add_config_scope_zone_by_vif_name6 (
const IPv6Net& scope_zone_id,
const string& vif_name)
| pim_0_1_add_config_scope_zone_by_vif_name6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_config_scope_zone_by_vif_addr4 (
const IPv4Net& scope_zone_id,
const IPv4& vif_addr)
| pim_0_1_add_config_scope_zone_by_vif_addr4 |
[protected pure virtual]
XrlCmdError pim_0_1_add_config_scope_zone_by_vif_addr6 (
const IPv6Net& scope_zone_id,
const IPv6& vif_addr)
| pim_0_1_add_config_scope_zone_by_vif_addr6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_scope_zone_by_vif_name4 (
const IPv4Net& scope_zone_id,
const string& vif_name)
| pim_0_1_delete_config_scope_zone_by_vif_name4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_scope_zone_by_vif_name6 (
const IPv6Net& scope_zone_id,
const string& vif_name)
| pim_0_1_delete_config_scope_zone_by_vif_name6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_scope_zone_by_vif_addr4 (
const IPv4Net& scope_zone_id,
const IPv4& vif_addr)
| pim_0_1_delete_config_scope_zone_by_vif_addr4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_scope_zone_by_vif_addr6 (
const IPv6Net& scope_zone_id,
const IPv6& vif_addr)
| pim_0_1_delete_config_scope_zone_by_vif_addr6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_config_cand_bsr4 (
const IPv4Net& scope_zone_id,
const bool& is_scope_zone,
const string& vif_name,
const IPv4& vif_addr,
const uint32_t& bsr_priority,
const uint32_t& hash_mask_len)
| pim_0_1_add_config_cand_bsr4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete candidate-BSR configuration.
Parameters:
scope_zone_id | the ID of the configured zone. |
is_scope_zone | true if configuring administratively scoped zone. |
vif_name | the name of the vif to use its address as a candidate-BSR. |
vif_addr | the address of the vif to use as a candidate-BSR. |
bsr_priority | the BSR priority (larger is better). |
hash_mask_len | the hash mask length. |
XrlCmdError pim_0_1_add_config_cand_bsr6 (
const IPv6Net& scope_zone_id,
const bool& is_scope_zone,
const string& vif_name,
const IPv6& vif_addr,
const uint32_t& bsr_priority,
const uint32_t& hash_mask_len)
| pim_0_1_add_config_cand_bsr6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_cand_bsr4 (
const IPv4Net& scope_zone_id,
const bool& is_scope_zone)
| pim_0_1_delete_config_cand_bsr4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_cand_bsr6 (
const IPv6Net& scope_zone_id,
const bool& is_scope_zone)
| pim_0_1_delete_config_cand_bsr6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_config_cand_rp4 (
const IPv4Net& group_prefix,
const bool& is_scope_zone,
const string& vif_name,
const IPv4& vif_addr,
const uint32_t& rp_priority,
const uint32_t& rp_holdtime)
| pim_0_1_add_config_cand_rp4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete Candidate-RP configuration.
Parameters:
group_prefix | the group prefix of the configured zone. |
is_scope_zone | true if configuring administratively scoped zone. |
vif_name | the name of the vif to use its address as a candidate-RP. |
vif_addr | the address of the vif to use as a candidate-RP. |
rp_priority | the Cand-RP priority (smaller is better). |
rp_holdtime | the Cand-RP holdtime (in seconds). |
XrlCmdError pim_0_1_add_config_cand_rp6 (
const IPv6Net& group_prefix,
const bool& is_scope_zone,
const string& vif_name,
const IPv6& vif_addr,
const uint32_t& rp_priority,
const uint32_t& rp_holdtime)
| pim_0_1_add_config_cand_rp6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_cand_rp4 (
const IPv4Net& group_prefix,
const bool& is_scope_zone,
const string& vif_name,
const IPv4& vif_addr)
| pim_0_1_delete_config_cand_rp4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_cand_rp6 (
const IPv6Net& group_prefix,
const bool& is_scope_zone,
const string& vif_name,
const IPv6& vif_addr)
| pim_0_1_delete_config_cand_rp6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_config_static_rp4 (
const IPv4Net& group_prefix,
const IPv4& rp_addr,
const uint32_t& rp_priority,
const uint32_t& hash_mask_len)
| pim_0_1_add_config_static_rp4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete/complete static RP configuration.
Parameters:
group_prefix | the group prefix for the RP. |
rp_addr | the RP address. |
rp_priority | the RP priority (smaller is better). |
hash_mask_len | the hash mask length used in computing an RP for a group. It should be same across all RPs. If set to zero, the default one will be used. |
XrlCmdError pim_0_1_add_config_static_rp6 (
const IPv6Net& group_prefix,
const IPv6& rp_addr,
const uint32_t& rp_priority,
const uint32_t& hash_mask_len)
| pim_0_1_add_config_static_rp6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_static_rp4 (
const IPv4Net& group_prefix,
const IPv4& rp_addr)
| pim_0_1_delete_config_static_rp4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_static_rp6 (
const IPv6Net& group_prefix,
const IPv6& rp_addr)
| pim_0_1_delete_config_static_rp6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_all_static_group_prefixes_rp4 (
const IPv4& rp_addr)
| pim_0_1_delete_config_all_static_group_prefixes_rp4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_all_static_group_prefixes_rp6 (
const IPv6& rp_addr)
| pim_0_1_delete_config_all_static_group_prefixes_rp6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_config_all_static_rps ()
| pim_0_1_delete_config_all_static_rps |
[protected pure virtual]
XrlCmdError pim_0_1_config_static_rp_done ()
| pim_0_1_config_static_rp_done |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_proto_version (
const string& vif_name,
uint32_t& proto_version)
| pim_0_1_get_vif_proto_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the configured protocol version per interface.
Parameters:
vif_name | the name of the vif to apply to. |
proto_version | the protocol version. |
XrlCmdError pim_0_1_set_vif_proto_version (
const string& vif_name,
const uint32_t& proto_version)
| pim_0_1_set_vif_proto_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the protocol version per interface.
Parameters:
vif_name | the name of the vif to apply to. |
proto_version | the protocol version. |
XrlCmdError pim_0_1_reset_vif_proto_version (
const string& vif_name)
| pim_0_1_reset_vif_proto_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Reset the protocol version per interface to its default value.
Parameters:
vif_name | the name of the vif to apply to. |
XrlCmdError pim_0_1_get_vif_ip_router_alert_option_check (
const string& vif_name,
bool& enabled)
| pim_0_1_get_vif_ip_router_alert_option_check |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the IP Router Alert option check per interface for received packets.
Parameters:
vif_name | the name of the vif to apply to. |
enabled | if true, then the IP Router Alert option check was enabled, otherwise it was disabled. |
XrlCmdError pim_0_1_set_vif_ip_router_alert_option_check (
const string& vif_name,
const bool& enable)
| pim_0_1_set_vif_ip_router_alert_option_check |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the IP Router Alert option check per interface for received packets.
Parameters:
vif_name | the name of the vif to apply to. |
enable | if true, then enable the IP Router Alert option check, otherwise disable it. |
XrlCmdError pim_0_1_reset_vif_ip_router_alert_option_check (
const string& vif_name)
| pim_0_1_reset_vif_ip_router_alert_option_check |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Reset the IP Router Alert option check per interface for received packets to its default value.
Parameters:
vif_name | the name of the vif to apply to. |
XrlCmdError pim_0_1_get_vif_hello_triggered_delay (
const string& vif_name,
uint32_t& hello_triggered_delay)
| pim_0_1_get_vif_hello_triggered_delay |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Configure PIM Hello-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. |
hello_triggered_delay | the Triggered_Hello_Delay (in seconds). |
XrlCmdError pim_0_1_set_vif_hello_triggered_delay (
const string& vif_name,
const uint32_t& hello_triggered_delay)
| pim_0_1_set_vif_hello_triggered_delay |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_hello_triggered_delay (
const string& vif_name)
| pim_0_1_reset_vif_hello_triggered_delay |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_hello_period (
const string& vif_name,
uint32_t& hello_period)
| pim_0_1_get_vif_hello_period |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_hello_period (
const string& vif_name,
const uint32_t& hello_period)
| pim_0_1_set_vif_hello_period |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_hello_period (
const string& vif_name)
| pim_0_1_reset_vif_hello_period |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_hello_holdtime (
const string& vif_name,
uint32_t& hello_holdtime)
| pim_0_1_get_vif_hello_holdtime |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_hello_holdtime (
const string& vif_name,
const uint32_t& hello_holdtime)
| pim_0_1_set_vif_hello_holdtime |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_hello_holdtime (
const string& vif_name)
| pim_0_1_reset_vif_hello_holdtime |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_dr_priority (
const string& vif_name,
uint32_t& dr_priority)
| pim_0_1_get_vif_dr_priority |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_dr_priority (
const string& vif_name,
const uint32_t& dr_priority)
| pim_0_1_set_vif_dr_priority |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_dr_priority (
const string& vif_name)
| pim_0_1_reset_vif_dr_priority |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_propagation_delay (
const string& vif_name,
uint32_t& propagation_delay)
| pim_0_1_get_vif_propagation_delay |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_propagation_delay (
const string& vif_name,
const uint32_t& propagation_delay)
| pim_0_1_set_vif_propagation_delay |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_propagation_delay (
const string& vif_name)
| pim_0_1_reset_vif_propagation_delay |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_override_interval (
const string& vif_name,
uint32_t& override_interval)
| pim_0_1_get_vif_override_interval |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_override_interval (
const string& vif_name,
const uint32_t& override_interval)
| pim_0_1_set_vif_override_interval |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_override_interval (
const string& vif_name)
| pim_0_1_reset_vif_override_interval |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_is_tracking_support_disabled (
const string& vif_name,
bool& is_tracking_support_disabled)
| pim_0_1_get_vif_is_tracking_support_disabled |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_is_tracking_support_disabled (
const string& vif_name,
const bool& is_tracking_support_disabled)
| pim_0_1_set_vif_is_tracking_support_disabled |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_is_tracking_support_disabled (
const string& vif_name)
| pim_0_1_reset_vif_is_tracking_support_disabled |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_accept_nohello_neighbors (
const string& vif_name,
bool& accept_nohello_neighbors)
| pim_0_1_get_vif_accept_nohello_neighbors |
[protected pure virtual]
XrlCmdError pim_0_1_set_vif_accept_nohello_neighbors (
const string& vif_name,
const bool& accept_nohello_neighbors)
| pim_0_1_set_vif_accept_nohello_neighbors |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_accept_nohello_neighbors (
const string& vif_name)
| pim_0_1_reset_vif_accept_nohello_neighbors |
[protected pure virtual]
XrlCmdError pim_0_1_get_vif_join_prune_period (
const string& vif_name,
uint32_t& join_prune_period)
| pim_0_1_get_vif_join_prune_period |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Configure PIM Join/Prune-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. |
join_prune_period | the period between Join/Prune messages. |
XrlCmdError pim_0_1_set_vif_join_prune_period (
const string& vif_name,
const uint32_t& join_prune_period)
| pim_0_1_set_vif_join_prune_period |
[protected pure virtual]
XrlCmdError pim_0_1_reset_vif_join_prune_period (
const string& vif_name)
| pim_0_1_reset_vif_join_prune_period |
[protected pure virtual]
XrlCmdError pim_0_1_get_switch_to_spt_threshold (
bool& is_enabled,
uint32_t& interval_sec,
uint32_t& bytes)
| pim_0_1_get_switch_to_spt_threshold |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Configure SPT-switch threshold. The 'set_foo' XRLs set the particular values. The 'reset_foo' XRLs reset the metrics to their default values.
Parameters:
is_enabled | if true, enable SPT-switch, otherwise disable it. |
interval_sec | if the SPT-switch is enabled, the interval (in number of seconds) to measure the bandwidth to consider whether to switch to the SPT. |
XrlCmdError pim_0_1_set_switch_to_spt_threshold (
const bool& is_enabled,
const uint32_t& interval_sec,
const uint32_t& bytes)
| pim_0_1_set_switch_to_spt_threshold |
[protected pure virtual]
XrlCmdError pim_0_1_reset_switch_to_spt_threshold ()
| pim_0_1_reset_switch_to_spt_threshold |
[protected pure virtual]
XrlCmdError pim_0_1_add_alternative_subnet4 (
const string& vif_name,
const IPv4Net& subnet)
| pim_0_1_add_alternative_subnet4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add or delete an alternative subnet on a PIM vif. An alternative subnet is used to make incoming traffic with a non-local source address appear as it is coming from a local subnet. Note: add alternative subnets with extreme care, only if you know what you are really doing!
Parameters:
vif_name | the name of the vif to add or delete an alternative subnet. |
subnet | the subnet address to add or delete. |
XrlCmdError pim_0_1_add_alternative_subnet6 (
const string& vif_name,
const IPv6Net& subnet)
| pim_0_1_add_alternative_subnet6 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_alternative_subnet4 (
const string& vif_name,
const IPv4Net& subnet)
| pim_0_1_delete_alternative_subnet4 |
[protected pure virtual]
XrlCmdError pim_0_1_delete_alternative_subnet6 (
const string& vif_name,
const IPv6Net& subnet)
| pim_0_1_delete_alternative_subnet6 |
[protected pure virtual]
XrlCmdError pim_0_1_remove_all_alternative_subnets (
const string& vif_name)
| pim_0_1_remove_all_alternative_subnets |
[protected pure virtual]
XrlCmdError pim_0_1_log_trace_all (
const bool& enable)
| pim_0_1_log_trace_all |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable the PIM trace log for all operations.
Parameters:
enable | if true, then enable the trace log, otherwise disable it. |
XrlCmdError pim_0_1_add_test_jp_entry4 (
const IPv4& source_addr,
const IPv4& group_addr,
const uint32_t& group_mask_len,
const string& mrt_entry_type,
const string& action_jp,
const uint32_t& holdtime,
const bool& is_new_group)
| pim_0_1_add_test_jp_entry4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test-related methods: add Join/Prune entries, and send them to a neighbor.
XrlCmdError pim_0_1_add_test_jp_entry6 (
const IPv6& source_addr,
const IPv6& group_addr,
const uint32_t& group_mask_len,
const string& mrt_entry_type,
const string& action_jp,
const uint32_t& holdtime,
const bool& is_new_group)
| pim_0_1_add_test_jp_entry6 |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_jp_entry4 (
const string& vif_name,
const IPv4& nbr_addr)
| pim_0_1_send_test_jp_entry4 |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_jp_entry6 (
const string& vif_name,
const IPv6& nbr_addr)
| pim_0_1_send_test_jp_entry6 |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_assert4 (
const string& vif_name,
const IPv4& source_addr,
const IPv4& group_addr,
const bool& rpt_bit,
const uint32_t& metric_preference,
const uint32_t& metric)
| pim_0_1_send_test_assert4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test-related methods: send an Assert message on an interface.
Parameters:
vif_name | the name of the vif to send the Assert on. |
source_addr | the source address inside the Assert message. |
group_addr | the group address inside the Assert message. |
rpt_bit | the RPT-bit inside the Assert message. |
metric_preference | the metric preference inside the Assert message. |
metric | the metric inside the Assert message. |
XrlCmdError pim_0_1_send_test_assert6 (
const string& vif_name,
const IPv6& source_addr,
const IPv6& group_addr,
const bool& rpt_bit,
const uint32_t& metric_preference,
const uint32_t& metric)
| pim_0_1_send_test_assert6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_test_bsr_zone4 (
const IPv4Net& zone_id_scope_zone_prefix,
const bool& zone_id_is_scope_zone,
const IPv4& bsr_addr,
const uint32_t& bsr_priority,
const uint32_t& hash_mask_len,
const uint32_t& fragment_tag)
| pim_0_1_add_test_bsr_zone4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Test-related methods: send Bootstrap and Cand-RP-Adv messages.
Parameters:
zone_id_scope_zone_prefix | the zone prefix of the zone ID. |
zone_id_is_scope_zone | true if the zone is scoped. |
bsr_addr | the address of the Bootstrap router. |
bsr_priority | the priority of the Bootstrap router. |
hash_mask_len | the hash mask length inside the Bootstrap messages. |
fragment_tag | the fragment tag inside the Bootstrap messages. |
XrlCmdError pim_0_1_add_test_bsr_zone6 (
const IPv6Net& zone_id_scope_zone_prefix,
const bool& zone_id_is_scope_zone,
const IPv6& bsr_addr,
const uint32_t& bsr_priority,
const uint32_t& hash_mask_len,
const uint32_t& fragment_tag)
| pim_0_1_add_test_bsr_zone6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_test_bsr_group_prefix4 (
const IPv4Net& zone_id_scope_zone_prefix,
const bool& zone_id_is_scope_zone,
const IPv4Net& group_prefix,
const bool& is_scope_zone,
const uint32_t& expected_rp_count)
| pim_0_1_add_test_bsr_group_prefix4 |
[protected pure virtual]
XrlCmdError pim_0_1_add_test_bsr_group_prefix6 (
const IPv6Net& zone_id_scope_zone_prefix,
const bool& zone_id_is_scope_zone,
const IPv6Net& group_prefix,
const bool& is_scope_zone,
const uint32_t& expected_rp_count)
| pim_0_1_add_test_bsr_group_prefix6 |
[protected pure virtual]
XrlCmdError pim_0_1_add_test_bsr_rp4 (
const IPv4Net& zone_id_scope_zone_prefix,
const bool& zone_id_is_scope_zone,
const IPv4Net& group_prefix,
const IPv4& rp_addr,
const uint32_t& rp_priority,
const uint32_t& rp_holdtime)
| pim_0_1_add_test_bsr_rp4 |
[protected pure virtual]
XrlCmdError pim_0_1_add_test_bsr_rp6 (
const IPv6Net& zone_id_scope_zone_prefix,
const bool& zone_id_is_scope_zone,
const IPv6Net& group_prefix,
const IPv6& rp_addr,
const uint32_t& rp_priority,
const uint32_t& rp_holdtime)
| pim_0_1_add_test_bsr_rp6 |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_bootstrap (
const string& vif_name)
| pim_0_1_send_test_bootstrap |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_bootstrap_by_dest4 (
const string& vif_name,
const IPv4& dest_addr)
| pim_0_1_send_test_bootstrap_by_dest4 |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_bootstrap_by_dest6 (
const string& vif_name,
const IPv6& dest_addr)
| pim_0_1_send_test_bootstrap_by_dest6 |
[protected pure virtual]
XrlCmdError pim_0_1_send_test_cand_rp_adv ()
| pim_0_1_send_test_cand_rp_adv |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_neighbors4 (
uint32_t& nbrs_number,
XrlAtomList& vifs,
XrlAtomList& addresses,
XrlAtomList& pim_versions,
XrlAtomList& dr_priorities,
XrlAtomList& holdtimes,
XrlAtomList& timeouts,
XrlAtomList& uptimes)
| pim_0_1_pimstat_neighbors4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Retrieve information about all PIM neighbors.
Parameters:
nbrs_number | the number of PIM neighbors |
vifs | the list of vif names for all neighbors (one vif name per neighbor). |
pim_versions | the list of PIM protocol versions for all neighbors (one number per neighbor). |
dr_priorities | the list of DR priorities of all neighbors (one number per neighbor). |
holdtimes | the list of configured holdtimes (in seconds) of all neighbors (one number per neighbor). |
timeouts | the list of timeout values (in seconds) of all neighbors (one number per neighbor). |
uptimes | the list of uptime values (in seconds) of all neighbors (one number per neighbor). |
XrlCmdError pim_0_1_pimstat_neighbors6 (
uint32_t& nbrs_number,
XrlAtomList& vifs,
XrlAtomList& addresses,
XrlAtomList& pim_versions,
XrlAtomList& dr_priorities,
XrlAtomList& holdtimes,
XrlAtomList& timeouts,
XrlAtomList& uptimes)
| pim_0_1_pimstat_neighbors6 |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_interface4 (
const string& vif_name,
uint32_t& pim_version,
bool& is_dr,
uint32_t& dr_priority,
IPv4& dr_address,
uint32_t& pim_nbrs_number)
| pim_0_1_pimstat_interface4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Retrieve information about PIM interfaces.
Parameters:
vif_name | the name of the vif to retrieve information about. |
pim_version | the PIM protocol version on that vif. |
is_dr | true if this router is the DR for the subnet the vif is connected to. |
dr_priority | the DR priority configured on that vif. |
dr_address | the address of the DR for the subnet the vif is connected to. |
pim_nbrs_number | the number of PIM neighbors on the subnet the vif is connected to. |
XrlCmdError pim_0_1_pimstat_interface6 (
const string& vif_name,
uint32_t& pim_version,
bool& is_dr,
uint32_t& dr_priority,
IPv6& dr_address,
uint32_t& pim_nbrs_number)
| pim_0_1_pimstat_interface6 |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rps4 (
uint32_t& rps_number,
XrlAtomList& addresses,
XrlAtomList& types,
XrlAtomList& priorities,
XrlAtomList& holdtimes,
XrlAtomList& timeouts,
XrlAtomList& group_prefixes)
| pim_0_1_pimstat_rps4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Retrieve information about the RP-Set.
Parameters:
rps_number | the number of RPs in the RP-Set. |
addresses | the list of addresses of all RPs (one IPv4 or IPv6 address per RP). |
types | the list of textual description about the origin of each RP (one keyword per RP: "bootstrap", "static" or "unknown"). |
priorities | the list of RP priorities of all RPs (one number per RP). |
holdtimes | the list of configured holdtimes (in seconds) of all RPs (one number per RP). |
timeouts | the list of timeout values (in seconds) of all RPs (one number per RP). |
group_prefixes | the list of all group prefixes (one network IPv4Net or IPv6Net address per RP). Note that if an RP is configured for more than one group prefixes, there will be a number of entries for that RP: one per group prefix. |
XrlCmdError pim_0_1_pimstat_rps6 (
uint32_t& rps_number,
XrlAtomList& addresses,
XrlAtomList& types,
XrlAtomList& priorities,
XrlAtomList& holdtimes,
XrlAtomList& timeouts,
XrlAtomList& group_prefixes)
| pim_0_1_pimstat_rps6 |
[protected pure virtual]
XrlCmdError pim_0_1_clear_pim_statistics ()
| pim_0_1_clear_pim_statistics |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
XrlCmdError pim_0_1_clear_pim_statistics_per_vif (
const string& vif_name)
| pim_0_1_clear_pim_statistics_per_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Clear all statistics on a specific interface.
Parameters:
vif_name | the interface to clear the statistics of. |
XrlCmdError pim_0_1_pimstat_hello_messages_received (
uint32_t& value)
| pim_0_1_pimstat_hello_messages_received |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Statistics-related counters and values
XrlCmdError pim_0_1_pimstat_hello_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_hello_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_hello_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_hello_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_messages_received (
uint32_t& value)
| pim_0_1_pimstat_register_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_register_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_register_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_stop_messages_received (
uint32_t& value)
| pim_0_1_pimstat_register_stop_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_stop_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_register_stop_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_stop_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_register_stop_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_join_prune_messages_received (
uint32_t& value)
| pim_0_1_pimstat_join_prune_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_join_prune_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_join_prune_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_join_prune_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_join_prune_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bootstrap_messages_received (
uint32_t& value)
| pim_0_1_pimstat_bootstrap_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bootstrap_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_bootstrap_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bootstrap_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_bootstrap_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_assert_messages_received (
uint32_t& value)
| pim_0_1_pimstat_assert_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_assert_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_assert_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_assert_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_assert_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_messages_received (
uint32_t& value)
| pim_0_1_pimstat_graft_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_graft_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_graft_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_ack_messages_received (
uint32_t& value)
| pim_0_1_pimstat_graft_ack_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_ack_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_graft_ack_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_ack_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_graft_ack_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_candidate_rp_messages_received (
uint32_t& value)
| pim_0_1_pimstat_candidate_rp_messages_received |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_candidate_rp_messages_sent (
uint32_t& value)
| pim_0_1_pimstat_candidate_rp_messages_sent |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_candidate_rp_messages_rx_errors (
uint32_t& value)
| pim_0_1_pimstat_candidate_rp_messages_rx_errors |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_unknown_type_messages (
uint32_t& value)
| pim_0_1_pimstat_unknown_type_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_unknown_version_messages (
uint32_t& value)
| pim_0_1_pimstat_unknown_version_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_neighbor_unknown_messages (
uint32_t& value)
| pim_0_1_pimstat_neighbor_unknown_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bad_length_messages (
uint32_t& value)
| pim_0_1_pimstat_bad_length_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bad_checksum_messages (
uint32_t& value)
| pim_0_1_pimstat_bad_checksum_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bad_receive_interface_messages (
uint32_t& value)
| pim_0_1_pimstat_bad_receive_interface_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_interface_disabled_messages (
uint32_t& value)
| pim_0_1_pimstat_rx_interface_disabled_messages |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_register_not_rp (
uint32_t& value)
| pim_0_1_pimstat_rx_register_not_rp |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rp_filtered_source (
uint32_t& value)
| pim_0_1_pimstat_rp_filtered_source |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_unknown_register_stop (
uint32_t& value)
| pim_0_1_pimstat_unknown_register_stop |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_prune_no_state (
uint32_t& value)
| pim_0_1_pimstat_rx_join_prune_no_state |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_graft_graft_ack_no_state (
uint32_t& value)
| pim_0_1_pimstat_rx_graft_graft_ack_no_state |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_graft_on_upstream_interface (
uint32_t& value)
| pim_0_1_pimstat_rx_graft_on_upstream_interface |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_candidate_rp_not_bsr (
uint32_t& value)
| pim_0_1_pimstat_rx_candidate_rp_not_bsr |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_bsr_when_bsr (
uint32_t& value)
| pim_0_1_pimstat_rx_bsr_when_bsr |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_bsr_not_rpf_interface (
uint32_t& value)
| pim_0_1_pimstat_rx_bsr_not_rpf_interface |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_unknown_hello_option (
uint32_t& value)
| pim_0_1_pimstat_rx_unknown_hello_option |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_data_no_state (
uint32_t& value)
| pim_0_1_pimstat_rx_data_no_state |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_rp_no_state (
uint32_t& value)
| pim_0_1_pimstat_rx_rp_no_state |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_aggregate (
uint32_t& value)
| pim_0_1_pimstat_rx_aggregate |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_malformed_packet (
uint32_t& value)
| pim_0_1_pimstat_rx_malformed_packet |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_no_rp (
uint32_t& value)
| pim_0_1_pimstat_no_rp |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_no_route_upstream (
uint32_t& value)
| pim_0_1_pimstat_no_route_upstream |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rp_mismatch (
uint32_t& value)
| pim_0_1_pimstat_rp_mismatch |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rpf_neighbor_unknown (
uint32_t& value)
| pim_0_1_pimstat_rpf_neighbor_unknown |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_rp (
uint32_t& value)
| pim_0_1_pimstat_rx_join_rp |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_rp (
uint32_t& value)
| pim_0_1_pimstat_rx_prune_rp |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_wc (
uint32_t& value)
| pim_0_1_pimstat_rx_join_wc |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_wc (
uint32_t& value)
| pim_0_1_pimstat_rx_prune_wc |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_sg (
uint32_t& value)
| pim_0_1_pimstat_rx_join_sg |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_sg (
uint32_t& value)
| pim_0_1_pimstat_rx_prune_sg |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_sg_rpt (
uint32_t& value)
| pim_0_1_pimstat_rx_join_sg_rpt |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_sg_rpt (
uint32_t& value)
| pim_0_1_pimstat_rx_prune_sg_rpt |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_hello_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_hello_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_hello_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_hello_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_hello_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_hello_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_register_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_register_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_register_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_stop_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_register_stop_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_stop_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_register_stop_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_register_stop_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_register_stop_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_join_prune_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_join_prune_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_join_prune_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_join_prune_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_join_prune_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_join_prune_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bootstrap_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_bootstrap_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bootstrap_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_bootstrap_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bootstrap_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_bootstrap_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_assert_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_assert_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_assert_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_assert_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_assert_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_assert_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_graft_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_graft_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_graft_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_ack_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_graft_ack_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_ack_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_graft_ack_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_graft_ack_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_graft_ack_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_candidate_rp_messages_received_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_candidate_rp_messages_received_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_candidate_rp_messages_sent_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_candidate_rp_messages_sent_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_candidate_rp_messages_rx_errors_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_candidate_rp_messages_rx_errors_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_unknown_type_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_unknown_type_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_unknown_version_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_unknown_version_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_neighbor_unknown_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_neighbor_unknown_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bad_length_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_bad_length_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bad_checksum_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_bad_checksum_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_bad_receive_interface_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_bad_receive_interface_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_interface_disabled_messages_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_interface_disabled_messages_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_register_not_rp_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_register_not_rp_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rp_filtered_source_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rp_filtered_source_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_unknown_register_stop_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_unknown_register_stop_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_prune_no_state_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_join_prune_no_state_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_graft_graft_ack_no_state_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_graft_graft_ack_no_state_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_graft_on_upstream_interface_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_graft_on_upstream_interface_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_candidate_rp_not_bsr_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_candidate_rp_not_bsr_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_bsr_when_bsr_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_bsr_when_bsr_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_bsr_not_rpf_interface_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_bsr_not_rpf_interface_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_unknown_hello_option_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_unknown_hello_option_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_data_no_state_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_data_no_state_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_rp_no_state_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_rp_no_state_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_aggregate_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_aggregate_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_malformed_packet_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_malformed_packet_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_no_rp_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_no_rp_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_no_route_upstream_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_no_route_upstream_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rp_mismatch_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rp_mismatch_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rpf_neighbor_unknown_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rpf_neighbor_unknown_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_rp_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_join_rp_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_rp_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_prune_rp_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_wc_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_join_wc_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_wc_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_prune_wc_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_sg_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_join_sg_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_sg_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_prune_sg_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_join_sg_rpt_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_join_sg_rpt_per_vif |
[protected pure virtual]
XrlCmdError pim_0_1_pimstat_rx_prune_sg_rpt_per_vif (
const string& vif_name,
uint32_t& value)
| pim_0_1_pimstat_rx_prune_sg_rpt_per_vif |
[protected pure virtual]