class XrlPimNode


Definition#include <xrl_pim_node.hh>
InheritsPimNode [public ], PimNodeCli [public ], XrlCliManagerV0p1Client (unknown) [public ], XrlCommonV0p1Client (unknown) [public ], XrlMfeaV0p1Client (unknown) [public ], XrlMld6igmpV0p1Client (unknown) [public ], XrlPimTargetBase (unknown) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

 XrlPimNode (int family, xorp_module_id module_id, EventLoop& eventloop, XrlRouter* xrl_router)

XrlPimNode

 ~XrlPimNode ()

~XrlPimNode

[virtual]

int  enable_cli ()

enable_cli

int  disable_cli ()

disable_cli

int  start_cli ()

start_cli

int  stop_cli ()

stop_cli

int  enable_pim ()

enable_pim

int  disable_pim ()

disable_pim

int  start_pim ()

start_pim

int  stop_pim ()

stop_pim

int  enable_bsr ()

enable_bsr

Reimplemented from PimNode.

int  disable_bsr ()

disable_bsr

Reimplemented from PimNode.

int  start_bsr ()

start_bsr

Reimplemented from PimNode.

int  stop_bsr ()

stop_bsr

Reimplemented from PimNode.

int  proto_send (const string& dst_module_instance_name, xorp_module_id dst_module_id, uint16_t vif_index, const IPvX& src, const IPvX& dst, int ip_ttl,int ip_tos, bool router_alert_bool, const uint8_t * sndbuf, size_t sndlen)

proto_send

[protected]

Reimplemented from ProtoNode.

void  xrl_result_send_protocol_message (const XrlError& xrl_error)

xrl_result_send_protocol_message

[protected]

int  start_protocol_kernel ()

start_protocol_kernel

[protected]

Reimplemented from PimNode.

void  xrl_result_add_protocol_mfea (const XrlError& xrl_error)

xrl_result_add_protocol_mfea

[protected]

void  xrl_result_allow_signal_messages (const XrlError& xrl_error)

xrl_result_allow_signal_messages

[protected]

void  xrl_result_allow_mrib_messages (const XrlError& xrl_error)

xrl_result_allow_mrib_messages

[protected]

int  stop_protocol_kernel ()

stop_protocol_kernel

[protected]

Reimplemented from PimNode.

void  xrl_result_delete_protocol_mfea (const XrlError& xrl_error)

xrl_result_delete_protocol_mfea

[protected]

int  start_protocol_kernel_vif (uint16_t vif_index)

start_protocol_kernel_vif

[protected]

Reimplemented from PimNode.

void  xrl_result_start_protocol_kernel_vif (const XrlError& xrl_error)

xrl_result_start_protocol_kernel_vif

[protected]

int  stop_protocol_kernel_vif (uint16_t vif_index)

stop_protocol_kernel_vif

[protected]

Reimplemented from PimNode.

void  xrl_result_stop_protocol_kernel_vif (const XrlError& xrl_error)

xrl_result_stop_protocol_kernel_vif

[protected]

int  join_multicast_group (uint16_t vif_index, const IPvX& multicast_group)

join_multicast_group

[protected]

Reimplemented from PimNode.

void  xrl_result_join_multicast_group (const XrlError& xrl_error)

xrl_result_join_multicast_group

[protected]

int  leave_multicast_group (uint16_t vif_index, const IPvX& multicast_group)

leave_multicast_group

[protected]

Reimplemented from PimNode.

void  xrl_result_leave_multicast_group (const XrlError& xrl_error)

xrl_result_leave_multicast_group

[protected]

int  add_mfc_to_kernel (const PimMfc& pim_mfc)

add_mfc_to_kernel

[protected]

Reimplemented from PimNode.

void  xrl_result_add_mfc_to_kernel (const XrlError& xrl_error)

xrl_result_add_mfc_to_kernel

[protected]

int  delete_mfc_from_kernel (const PimMfc& pim_mfc)

delete_mfc_from_kernel

[protected]

Reimplemented from PimNode.

void  xrl_result_delete_mfc_from_kernel (const XrlError& xrl_error)

xrl_result_delete_mfc_from_kernel

[protected]

int  add_dataflow_monitor (const IPvX& source_addr, const IPvX& group_addr, uint32_t threshold_interval_sec, uint32_t threshold_interval_usec, uint32_t threshold_packets, uint32_t threshold_bytes, bool is_threshold_in_packets, bool is_threshold_in_bytes, bool is_geq_upcall, bool is_leq_upcall)

add_dataflow_monitor

[protected]

Reimplemented from PimNode.

void  xrl_result_add_dataflow_monitor (const XrlError& xrl_error)

xrl_result_add_dataflow_monitor

[protected]

int  delete_dataflow_monitor (const IPvX& source_addr, const IPvX& group_addr, uint32_t threshold_interval_sec, uint32_t threshold_interval_usec, uint32_t threshold_packets, uint32_t threshold_bytes, bool is_threshold_in_packets, bool is_threshold_in_bytes, bool is_geq_upcall, bool is_leq_upcall)

delete_dataflow_monitor

[protected]

Reimplemented from PimNode.

void  xrl_result_delete_dataflow_monitor (const XrlError& xrl_error)

xrl_result_delete_dataflow_monitor

[protected]

int  delete_all_dataflow_monitor (const IPvX& source_addr, const IPvX& group_addr)

delete_all_dataflow_monitor

[protected]

Reimplemented from PimNode.

void  xrl_result_delete_all_dataflow_monitor (const XrlError& xrl_error)

xrl_result_delete_all_dataflow_monitor

[protected]

int  add_protocol_mld6igmp (uint16_t vif_index)

add_protocol_mld6igmp

[protected]

Reimplemented from PimNode.

void  xrl_result_add_protocol_mld6igmp (const XrlError& xrl_error)

xrl_result_add_protocol_mld6igmp

[protected]

int  delete_protocol_mld6igmp (uint16_t vif_index)

delete_protocol_mld6igmp

[protected]

Reimplemented from PimNode.

void  xrl_result_delete_protocol_mld6igmp (const XrlError& xrl_error)

xrl_result_delete_protocol_mld6igmp

[protected]

int  add_cli_command_to_cli_manager (const char *command_name, const char *command_help, bool is_command_cd, const char *command_cd_prompt, bool is_command_processor)

add_cli_command_to_cli_manager

[protected]

Reimplemented from ProtoNodeCli.

void  xrl_result_add_cli_command (const XrlError& xrl_error)

xrl_result_add_cli_command

[protected]

int  delete_cli_command_from_cli_manager (const char *command_name)

delete_cli_command_from_cli_manager

[protected]

Reimplemented from ProtoNodeCli.

void  xrl_result_delete_cli_command (const XrlError& xrl_error)

xrl_result_delete_cli_command

[protected]

XrlCmdError  common_0_1_get_target_name ( string& name)

common_0_1_get_target_name

[protected]

Get name of Xrl Target

XrlCmdError  common_0_1_get_version ( string& version)

common_0_1_get_version

[protected]

Get version string from Xrl Target

XrlCmdError  common_0_1_get_status ( uint32_t& status, string& reason)

common_0_1_get_status

[protected]

Get status from Xrl Target

XrlCmdError  common_0_1_shutdown ()

common_0_1_shutdown

[protected]

shutdown cleanly

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]

Process a CLI command.

Parameters:
processor_namethe processor name for this command.
cli_term_namethe terminal name the command was entered from.
cli_session_idthe CLI session ID the command was entered from.
command_namethe command name to process.
command_argsthe command arguments to process.
ret_processor_namethe processor name to return back to the CLI.
ret_cli_term_namethe terminal name to return back.
ret_cli_session_idthe CLI session ID to return back.
ret_command_outputthe 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]

Add a new vif.

Parameters:
vif_namethe name of the new vif.
vif_indexthe index of the new vif.

XrlCmdError  mfea_client_0_1_delete_vif ( const string& vif_name)

mfea_client_0_1_delete_vif

[protected]

Delete an existing vif.

Parameters:
vif_namethe 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]

Add an address to a vif.

Parameters:
vif_namethe name of the vif.
addrthe unicast address to add.
subnetthe subnet address to add.
broadcastthe broadcast address (when applicable).
peerthe 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]

XrlCmdError  mfea_client_0_1_delete_vif_addr4 ( const string& vif_name, const IPv4& addr)

mfea_client_0_1_delete_vif_addr4

[protected]

Delete an address from a vif.

Parameters:
vif_namethe name of the vif.
addrthe 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]

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]

Set flags to a vif.

Parameters:
vif_namethe name of the vif.
is_pim_registertrue if this is a PIM Register vif.
is_p2ptrue if this is a point-to-point vif.
is_loopbacktrue if this is a loopback interface.
is_multicasttrue if the vif is multicast-capable.
is_broadcasttrue if the vif is broadcast-capable.
is_uptrue 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]

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]

Test if the vif setup is completed.

Parameters:
is_completedif 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]

Receive a protocol message from the MFEA.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
protocol_namethe name of the protocol that sends a message.
protocol_idthe ID of the protocol that sends a message (both sides must agree on the particular values).
vif_namethe name of the vif the message was received on.
vif_indexthe index of the vif the message was received on.
source_addressthe address of the sender.
dest_addressthe destination address.
ip_ttlthe TTL of the received IP packet. If it has a negative value, it should be ignored.
ip_tosthe TOS of the received IP packet. If it has a negative value, it should be ignored.
is_router_alertif true, the IP Router Alert option in the IP packet was set (when applicable).
protocol_messagethe 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]

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]

Receive a kernel signal message from the MFEA.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
protocol_namethe name of the protocol that sends a message.
protocol_idthe ID of the protocol that sends a message (both sides must agree on the particular values).
message_typethe type of the kernel signal message (TODO: integer for now: the particular types are well-known by both sides).
vif_namethe name of the vif the message was received on.
vif_indexthe index of the vif the message was received on.
source_addressthe address of the sender.
dest_addressthe destination address.
protocol_messagethe 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]

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]

Add Multicast Routing Information Base information.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
dest_prefixthe destination prefix to add.
next_hop_router_addrthe address of the next-hop router toward the destination prefix.
next_hop_vif_namethe name of the vif toward the destination prefix.
next_hop_vif_indexthe index of the vif toward the destination prefix.
metric_preferencethe metric preference for this entry.
metricthe 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]

XrlCmdError  mfea_client_0_1_delete_mrib4 ( const string& xrl_sender_name, const IPv4Net& dest_prefix)

mfea_client_0_1_delete_mrib4

[protected]

Delete Multicast Routing Information Base information.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
dest_prefixthe 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]

XrlCmdError  mfea_client_0_1_set_mrib_done ( const string& xrl_sender_name)

mfea_client_0_1_set_mrib_done

[protected]

Complete a transaction with MRIB information.

Parameters:
xrl_sender_namethe 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]

A signal that a dataflow-related pre-condition is true.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
source_addressthe source address of the dataflow.
group_addressthe group address of the dataflow.
threshold_interval_secthe number of seconds in the interval requested for measurement.
threshold_interval_usecthe number of microseconds in the interval requested for measurement.
measured_interval_secthe number of seconds in the last measured interval that has triggered the signal.
measured_interval_usecthe number of microseconds in the last measured interval that has triggered the signal.
threshold_packetsthe threshold value to trigger a signal (in number of packets).
threshold_bytesthe threshold value to trigger a signal (in bytes).
measured_packetsthe number of packets measured within the measured interval.
measured_bytesthe number of bytes measured within the measured interval.
is_threshold_in_packetsif true, threshold_packets is valid.
is_threshold_in_bytesif true, threshold_bytes is valid.
is_geq_upcallif true, the operation for comparison is ">=".
is_leq_upcallif 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]

XrlCmdError  fti_0_2_start_transaction ( uint32_t& tid)

fti_0_2_start_transaction

[protected]

Start transaction.

Parameters:
tidthe transaction ID to use for this transaction.

XrlCmdError  fti_0_2_commit_transaction ( const uint32_t& tid)

fti_0_2_commit_transaction

[protected virtual]

Commit transaction.

Parameters:
tidthe transaction ID of this transaction.

XrlCmdError  fti_0_2_abort_transaction ( const uint32_t& tid)

fti_0_2_abort_transaction

[protected]

Abort transaction.

Parameters:
tidthe transaction ID of this transaction.

XrlCmdError  fti_0_2_add_entry4 ( const uint32_t& tid, const IPv4Net& dst, const IPv4& gateway, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin)

fti_0_2_add_entry4

[protected]

Add a routing entry.

Parameters:
tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.

XrlCmdError  fti_0_2_add_entry6 ( const uint32_t& tid, const IPv6Net& dst, const IPv6& gateway, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin)

fti_0_2_add_entry6

[protected]

Add a routing entry.

Parameters:
tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.

XrlCmdError  fti_0_2_delete_entry4 ( const uint32_t& tid, const IPv4Net& dst)

fti_0_2_delete_entry4

[protected]

Delete a routing entry.

Parameters:
tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.

XrlCmdError  fti_0_2_delete_entry6 ( const uint32_t& tid, const IPv6Net& dst)

fti_0_2_delete_entry6

[protected]

Delete a routing entry.

Parameters:
tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.

XrlCmdError  fti_0_2_delete_all_entries ( const uint32_t& tid)

fti_0_2_delete_all_entries

[protected]

Delete all routing entries for all address families.

Parameters:
tidthe transaction ID of this transaction.

XrlCmdError  fti_0_2_delete_all_entries4 ( const uint32_t& tid)

fti_0_2_delete_all_entries4

[protected]

Delete all routing entries for the IPv4 address family.

Parameters:
tidthe transaction ID of this transaction.

XrlCmdError  fti_0_2_delete_all_entries6 ( const uint32_t& tid)

fti_0_2_delete_all_entries6

[protected]

Delete all routing entries for the IPv6 address family.

Parameters:
tidthe transaction ID of this transaction.

XrlCmdError  fti_0_2_lookup_route4 ( const IPv4& dst, IPv4Net& netmask, IPv4& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_route4

[protected]

Lookup a route for a destination host address.

Parameters:
dstthe destination host address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.

XrlCmdError  fti_0_2_lookup_route6 ( const IPv6& dst, IPv6Net& netmask, IPv6& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_route6

[protected]

Lookup a route for a destination host address.

Parameters:
dstthe destination host address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.

XrlCmdError  fti_0_2_lookup_entry4 ( const IPv4Net& dst, IPv4& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_entry4

[protected]

Lookup a route for a destination subnet address.

Parameters:
dstthe destination subnet address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.

XrlCmdError  fti_0_2_lookup_entry6 ( const IPv6Net& dst, IPv6& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_entry6

[protected]

Lookup a route for a destination subnet address.

Parameters:
dstthe destination subnet address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.

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]

Add/delete membership information.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
vif_namethe name of the new vif.
vif_indexthe index of the new vif.
sourcethe source address that has been joined/left.
groupthe 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]

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]

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]

XrlCmdError  pim_0_1_enable_vif ( const string& vif_name)

pim_0_1_enable_vif

[protected]

Enable/disable/start/stop a PIM vif interface.

Parameters:
vif_namethe name of the vif to enable/disable/start/stop.

XrlCmdError  pim_0_1_disable_vif ( const string& vif_name)

pim_0_1_disable_vif

[protected]

XrlCmdError  pim_0_1_start_vif ( const string& vif_name)

pim_0_1_start_vif

[protected]

XrlCmdError  pim_0_1_stop_vif ( const string& vif_name)

pim_0_1_stop_vif

[protected]

XrlCmdError  pim_0_1_enable_all_vifs ()

pim_0_1_enable_all_vifs

[protected]

Enable/disable/start/stop all PIM vif interfaces.

XrlCmdError  pim_0_1_disable_all_vifs ()

pim_0_1_disable_all_vifs

[protected]

XrlCmdError  pim_0_1_start_all_vifs ()

pim_0_1_start_all_vifs

[protected]

XrlCmdError  pim_0_1_stop_all_vifs ()

pim_0_1_stop_all_vifs

[protected]

XrlCmdError  pim_0_1_enable_pim ()

pim_0_1_enable_pim

[protected]

Enable/disable/start/stop PIM protocol and PIM CLI access.

XrlCmdError  pim_0_1_disable_pim ()

pim_0_1_disable_pim

[protected]

XrlCmdError  pim_0_1_enable_cli ()

pim_0_1_enable_cli

[protected]

XrlCmdError  pim_0_1_disable_cli ()

pim_0_1_disable_cli

[protected]

XrlCmdError  pim_0_1_start_pim ()

pim_0_1_start_pim

[protected]

XrlCmdError  pim_0_1_stop_pim ()

pim_0_1_stop_pim

[protected]

XrlCmdError  pim_0_1_start_cli ()

pim_0_1_start_cli

[protected]

XrlCmdError  pim_0_1_stop_cli ()

pim_0_1_stop_cli

[protected]

XrlCmdError  pim_0_1_enable_bsr ()

pim_0_1_enable_bsr

[protected]

Enable/disable/start/stop BSR.

XrlCmdError  pim_0_1_disable_bsr ()

pim_0_1_disable_bsr

[protected]

XrlCmdError  pim_0_1_start_bsr ()

pim_0_1_start_bsr

[protected]

XrlCmdError  pim_0_1_stop_bsr ()

pim_0_1_stop_bsr

[protected]

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]

Add/delete scope zone.

Parameters:
scope_zone_idthe ID of the configured zone.
vif_namethe 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]

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]

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]

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]

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]

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]

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]

XrlCmdError  pim_0_1_add_config_cand_bsr_by_vif_name4 ( const IPv4Net& scope_zone_id, const bool& is_scope_zone, const string& vif_name, const uint32_t& bsr_priority, const uint32_t& hash_masklen)

pim_0_1_add_config_cand_bsr_by_vif_name4

[protected]

Add/delete candidate-BSR configuration.

Parameters:
scope_zone_idthe ID of the configured zone.
is_scope_zonetrue if configuring administratively scoped zone.
vif_namethe name of the vif to use its address as a candidate-BSR.
bsr_prioritythe BSR priority (larger is better).
hash_masklenthe hash mask length.

XrlCmdError  pim_0_1_add_config_cand_bsr_by_vif_name6 ( const IPv6Net& scope_zone_id, const bool& is_scope_zone, const string& vif_name, const uint32_t& bsr_priority, const uint32_t& hash_masklen)

pim_0_1_add_config_cand_bsr_by_vif_name6

[protected]

XrlCmdError  pim_0_1_add_config_cand_bsr_by_addr4 ( const IPv4Net& scope_zone_id, const bool& is_scope_zone, const IPv4& cand_bsr_addr, const uint32_t& bsr_priority, const uint32_t& hash_masklen)

pim_0_1_add_config_cand_bsr_by_addr4

[protected]

XrlCmdError  pim_0_1_add_config_cand_bsr_by_addr6 ( const IPv6Net& scope_zone_id, const bool& is_scope_zone, const IPv6& cand_bsr_addr, const uint32_t& bsr_priority, const uint32_t& hash_masklen)

pim_0_1_add_config_cand_bsr_by_addr6

[protected]

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]

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]

XrlCmdError  pim_0_1_add_config_cand_rp_by_vif_name4 ( const IPv4Net& group_prefix, const bool& is_scope_zone, const string& vif_name, const uint32_t& rp_priority, const uint32_t& rp_holdtime)

pim_0_1_add_config_cand_rp_by_vif_name4

[protected]

Add/delete Candidate-RP configuration.

Parameters:
group_prefixthe group prefix of the configured zone.
is_scope_zonetrue if configuring administratively scoped zone.
vif_namethe name of the vif to use its address as a candidate-RP.
rp_prioritythe Cand-RP priority (smaller is better).
rp_holdtimethe Cand-RP holdtime (in seconds).

XrlCmdError  pim_0_1_add_config_cand_rp_by_vif_name6 ( const IPv6Net& group_prefix, const bool& is_scope_zone, const string& vif_name, const uint32_t& rp_priority, const uint32_t& rp_holdtime)

pim_0_1_add_config_cand_rp_by_vif_name6

[protected]

XrlCmdError  pim_0_1_add_config_cand_rp_by_addr4 ( const IPv4Net& group_prefix, const bool& is_scope_zone, const IPv4& cand_rp_addr, const uint32_t& rp_priority, const uint32_t& rp_holdtime)

pim_0_1_add_config_cand_rp_by_addr4

[protected]

XrlCmdError  pim_0_1_add_config_cand_rp_by_addr6 ( const IPv6Net& group_prefix, const bool& is_scope_zone, const IPv6& cand_rp_addr, const uint32_t& rp_priority, const uint32_t& rp_holdtime)

pim_0_1_add_config_cand_rp_by_addr6

[protected]

XrlCmdError  pim_0_1_delete_config_cand_rp_by_vif_name4 ( const IPv4Net& group_prefix, const bool& is_scope_zone, const string& vif_name)

pim_0_1_delete_config_cand_rp_by_vif_name4

[protected]

XrlCmdError  pim_0_1_delete_config_cand_rp_by_vif_name6 ( const IPv6Net& group_prefix, const bool& is_scope_zone, const string& vif_name)

pim_0_1_delete_config_cand_rp_by_vif_name6

[protected]

XrlCmdError  pim_0_1_delete_config_cand_rp_by_addr4 ( const IPv4Net& group_prefix, const bool& is_scope_zone, const IPv4& cand_rp_addr)

pim_0_1_delete_config_cand_rp_by_addr4

[protected]

XrlCmdError  pim_0_1_delete_config_cand_rp_by_addr6 ( const IPv6Net& group_prefix, const bool& is_scope_zone, const IPv6& cand_rp_addr)

pim_0_1_delete_config_cand_rp_by_addr6

[protected]

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_masklen)

pim_0_1_add_config_static_rp4

[protected]

Add/delete/complete static RP configuration.

Parameters:
group_prefixthe group prefix for the RP.
rp_addrthe RP address.
rp_prioritythe RP priority (smaller is better).
hash_masklenthe hash masklen 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_masklen)

pim_0_1_add_config_static_rp6

[protected]

XrlCmdError  pim_0_1_delete_config_static_rp4 ( const IPv4Net& group_prefix, const IPv4& rp_addr)

pim_0_1_delete_config_static_rp4

[protected]

XrlCmdError  pim_0_1_delete_config_static_rp6 ( const IPv6Net& group_prefix, const IPv6& rp_addr)

pim_0_1_delete_confi