xorp

XrlMfeaTargetBase Class Reference

Inheritance diagram for XrlMfeaTargetBase:
XrlMfeaNode

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlMfeaTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlMfeaTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.
 XrlMfeaTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlMfeaTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.

Protected Member Functions

virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ifmgr_replicator_0_1_register_ifmgr_mirror (const string &clientname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ifmgr_replicator_0_1_unregister_ifmgr_mirror (const string &clientname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_have_multicast_routing4 (bool &result)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_register_protocol4 (const string &xrl_sender_name, const string &if_name, const string &vif_name, const uint32_t &ip_protocol)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_unregister_protocol4 (const string &xrl_sender_name, const string &if_name, const string &vif_name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_add_mfc4 (const string &xrl_sender_name, const IPv4 &source_address, const IPv4 &group_address, const uint32_t &iif_vif_index, const vector< uint8_t > &oiflist, const vector< uint8_t > &oiflist_disable_wrongvif, const uint32_t &max_vifs_oiflist, const IPv4 &rp_address)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_delete_mfc4 (const string &xrl_sender_name, const IPv4 &source_address, const IPv4 &group_address)=0
virtual XrlCmdError mfea_0_1_add_dataflow_monitor4 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_delete_dataflow_monitor4 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
virtual XrlCmdError mfea_0_1_delete_all_dataflow_monitor4 (const string &xrl_sender_name, const IPv4 &source_address, const IPv4 &group_address)=0
virtual XrlCmdError mfea_0_1_enable_vif (const string &vif_name, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_vif (const string &vif_name)=0
virtual XrlCmdError mfea_0_1_stop_vif (const string &vif_name)=0
virtual XrlCmdError mfea_0_1_enable_all_vifs (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_all_vifs ()=0
virtual XrlCmdError mfea_0_1_stop_all_vifs ()=0
virtual XrlCmdError mfea_0_1_enable_mfea (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_mfea ()=0
virtual XrlCmdError mfea_0_1_stop_mfea ()=0
virtual XrlCmdError mfea_0_1_enable_cli (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_cli ()=0
virtual XrlCmdError mfea_0_1_stop_cli ()=0
virtual XrlCmdError mfea_0_1_log_trace_all (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_have_multicast_routing6 (bool &result)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_register_protocol6 (const string &xrl_sender_name, const string &if_name, const string &vif_name, const uint32_t &ip_protocol)=0
virtual XrlCmdError mfea_0_1_unregister_protocol6 (const string &xrl_sender_name, const string &if_name, const string &vif_name)=0
virtual XrlCmdError mfea_0_1_add_mfc6 (const string &xrl_sender_name, const IPv6 &source_address, const IPv6 &group_address, const uint32_t &iif_vif_index, const vector< uint8_t > &oiflist, const vector< uint8_t > &oiflist_disable_wrongvif, const uint32_t &max_vifs_oiflist, const IPv6 &rp_address)=0
virtual XrlCmdError mfea_0_1_delete_mfc6 (const string &xrl_sender_name, const IPv6 &source_address, const IPv6 &group_address)=0
virtual XrlCmdError mfea_0_1_add_dataflow_monitor6 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
virtual XrlCmdError mfea_0_1_delete_dataflow_monitor6 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
virtual XrlCmdError mfea_0_1_delete_all_dataflow_monitor6 (const string &xrl_sender_name, const IPv6 &source_address, const IPv6 &group_address)=0
virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual 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)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ifmgr_replicator_0_1_register_ifmgr_mirror (const string &clientname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError ifmgr_replicator_0_1_unregister_ifmgr_mirror (const string &clientname)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_have_multicast_routing4 (bool &result)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_register_protocol4 (const string &xrl_sender_name, const string &if_name, const string &vif_name, const uint32_t &ip_protocol)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_unregister_protocol4 (const string &xrl_sender_name, const string &if_name, const string &vif_name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_add_mfc4 (const string &xrl_sender_name, const IPv4 &source_address, const IPv4 &group_address, const uint32_t &iif_vif_index, const vector< uint8_t > &oiflist, const vector< uint8_t > &oiflist_disable_wrongvif, const uint32_t &max_vifs_oiflist, const IPv4 &rp_address)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_delete_mfc4 (const string &xrl_sender_name, const IPv4 &source_address, const IPv4 &group_address)=0
virtual XrlCmdError mfea_0_1_add_dataflow_monitor4 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_delete_dataflow_monitor4 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
virtual XrlCmdError mfea_0_1_delete_all_dataflow_monitor4 (const string &xrl_sender_name, const IPv4 &source_address, const IPv4 &group_address)=0
virtual XrlCmdError mfea_0_1_enable_vif (const string &vif_name, const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_vif (const string &vif_name)=0
virtual XrlCmdError mfea_0_1_stop_vif (const string &vif_name)=0
virtual XrlCmdError mfea_0_1_enable_all_vifs (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_all_vifs ()=0
virtual XrlCmdError mfea_0_1_stop_all_vifs ()=0
virtual XrlCmdError mfea_0_1_enable_mfea (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_mfea ()=0
virtual XrlCmdError mfea_0_1_stop_mfea ()=0
virtual XrlCmdError mfea_0_1_enable_cli (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_start_cli ()=0
virtual XrlCmdError mfea_0_1_stop_cli ()=0
virtual XrlCmdError mfea_0_1_log_trace_all (const bool &enable)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_have_multicast_routing6 (bool &result)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError mfea_0_1_register_protocol6 (const string &xrl_sender_name, const string &if_name, const string &vif_name, const uint32_t &ip_protocol)=0
virtual XrlCmdError mfea_0_1_unregister_protocol6 (const string &xrl_sender_name, const string &if_name, const string &vif_name)=0
virtual XrlCmdError mfea_0_1_add_mfc6 (const string &xrl_sender_name, const IPv6 &source_address, const IPv6 &group_address, const uint32_t &iif_vif_index, const vector< uint8_t > &oiflist, const vector< uint8_t > &oiflist_disable_wrongvif, const uint32_t &max_vifs_oiflist, const IPv6 &rp_address)=0
virtual XrlCmdError mfea_0_1_delete_mfc6 (const string &xrl_sender_name, const IPv6 &source_address, const IPv6 &group_address)=0
virtual XrlCmdError mfea_0_1_add_dataflow_monitor6 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
virtual XrlCmdError mfea_0_1_delete_dataflow_monitor6 (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 &threshold_packets, const uint32_t &threshold_bytes, const bool &is_threshold_in_packets, const bool &is_threshold_in_bytes, const bool &is_geq_upcall, const bool &is_leq_upcall)=0
virtual XrlCmdError mfea_0_1_delete_all_dataflow_monitor6 (const string &xrl_sender_name, const IPv6 &source_address, const IPv6 &group_address)=0

Protected Attributes

XrlCmdMap_cmds

Private Member Functions

XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_cli_processor_0_1_process_command (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ifmgr_replicator_0_1_register_ifmgr_mirror (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ifmgr_replicator_0_1_unregister_ifmgr_mirror (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_have_multicast_routing4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_register_protocol4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_unregister_protocol4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_mfc4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_mfc4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_dataflow_monitor4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_dataflow_monitor4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_all_dataflow_monitor4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_all_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_all_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_all_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_mfea (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_mfea (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_mfea (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_cli (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_cli (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_cli (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_log_trace_all (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_have_multicast_routing6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_register_protocol6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_unregister_protocol6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_mfc6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_mfc6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_dataflow_monitor6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_dataflow_monitor6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_all_dataflow_monitor6 (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()
XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_cli_processor_0_1_process_command (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ifmgr_replicator_0_1_register_ifmgr_mirror (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_ifmgr_replicator_0_1_unregister_ifmgr_mirror (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_have_multicast_routing4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_register_protocol4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_unregister_protocol4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_mfc4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_mfc4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_dataflow_monitor4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_dataflow_monitor4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_all_dataflow_monitor4 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_vif (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_all_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_all_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_all_vifs (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_mfea (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_mfea (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_mfea (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_enable_cli (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_start_cli (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_stop_cli (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_log_trace_all (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_have_multicast_routing6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_register_protocol6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_unregister_protocol6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_mfc6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_mfc6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_add_dataflow_monitor6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_dataflow_monitor6 (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_mfea_0_1_delete_all_dataflow_monitor6 (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()

Static Private Attributes

static struct handler_table handlers []
static const size_t num_handlers = (sizeof(XrlMfeaTargetBase::handlers) / sizeof(XrlMfeaTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlMfeaTargetBase::XrlMfeaTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
XrlMfeaTargetBase::~XrlMfeaTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlMfeaTargetBase::XrlMfeaTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
virtual XrlMfeaTargetBase::~XrlMfeaTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlMfeaTargetBase::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 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::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 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::ifmgr_replicator_0_1_register_ifmgr_mirror ( const string &  clientname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register remote mirror of interface state.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::ifmgr_replicator_0_1_register_ifmgr_mirror ( const string &  clientname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register remote mirror of interface state.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::ifmgr_replicator_0_1_unregister_ifmgr_mirror ( const string &  clientname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register remote mirror of interface state.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::ifmgr_replicator_0_1_unregister_ifmgr_mirror ( const string &  clientname) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register remote mirror of interface state.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_add_dataflow_monitor4 ( 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 &  threshold_packets,
const uint32_t &  threshold_bytes,
const bool &  is_threshold_in_packets,
const bool &  is_threshold_in_bytes,
const bool &  is_geq_upcall,
const bool &  is_leq_upcall 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a dataflow monitor with the MFEA.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
source_addressthe source address of the dataflow to start/stop monitoring.
group_addressthe group address of the dataflow to start/stop monitoring.
threshold_interval_secthe number of seconds in the interval to measure.
threshold_interval_usecthe number of microseconds in the interval to measure.
threshold_packetsthe threshold (in number of packets) to compare against.
threshold_bytesthe threshold (in number of bytes) to compare against.
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 "<=".

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_add_dataflow_monitor4 ( 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 &  threshold_packets,
const uint32_t &  threshold_bytes,
const bool &  is_threshold_in_packets,
const bool &  is_threshold_in_bytes,
const bool &  is_geq_upcall,
const bool &  is_leq_upcall 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a dataflow monitor with the MFEA.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
source_addressthe source address of the dataflow to start/stop monitoring.
group_addressthe group address of the dataflow to start/stop monitoring.
threshold_interval_secthe number of seconds in the interval to measure.
threshold_interval_usecthe number of microseconds in the interval to measure.
threshold_packetsthe threshold (in number of packets) to compare against.
threshold_bytesthe threshold (in number of bytes) to compare against.
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 "<=".

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_add_mfc4 ( const string &  xrl_sender_name,
const IPv4 source_address,
const IPv4 group_address,
const uint32_t &  iif_vif_index,
const vector< uint8_t > &  oiflist,
const vector< uint8_t > &  oiflist_disable_wrongvif,
const uint32_t &  max_vifs_oiflist,
const IPv4 rp_address 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a Multicast Forwarding Cache with the kernel.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
source_addressthe source address of the MFC to add/delete.
group_addressthe group address of the MFC to add/delete.
iif_vif_indexthe index of the vif that is the incoming interface.
oiflistthe bit-vector with the set of outgoing interfaces.
oiflist_disable_wrongvifthe bit-vector with the set of outgoing interfaces to disable WRONGVIF kernel signal.
max_vifs_oiflistthe number of vifs covered by oiflist or oiflist_disable_wrongvif .
rp_addressthe RP address of the MFC to add.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_add_mfc4 ( const string &  xrl_sender_name,
const IPv4 source_address,
const IPv4 group_address,
const uint32_t &  iif_vif_index,
const vector< uint8_t > &  oiflist,
const vector< uint8_t > &  oiflist_disable_wrongvif,
const uint32_t &  max_vifs_oiflist,
const IPv4 rp_address 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a Multicast Forwarding Cache with the kernel.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
source_addressthe source address of the MFC to add/delete.
group_addressthe group address of the MFC to add/delete.
iif_vif_indexthe index of the vif that is the incoming interface.
oiflistthe bit-vector with the set of outgoing interfaces.
oiflist_disable_wrongvifthe bit-vector with the set of outgoing interfaces to disable WRONGVIF kernel signal.
max_vifs_oiflistthe number of vifs covered by oiflist or oiflist_disable_wrongvif .
rp_addressthe RP address of the MFC to add.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_all_vifs ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:
enableif true, then enable the vifs, otherwise disable them.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_all_vifs ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:
enableif true, then enable the vifs, otherwise disable them.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_cli ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop the MFEA CLI access.

Parameters:
enableif true, then enable the MFEA CLI access, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_cli ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop the MFEA CLI access.

Parameters:
enableif true, then enable the MFEA CLI access, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_mfea ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop the MFEA.

Parameters:
enableif true, then enable the MFEA, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_mfea ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop the MFEA.

Parameters:
enableif true, then enable the MFEA, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_vif ( const string &  vif_name,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:
vif_namethe name of the vif to enable/disable/start/stop.
enableif true, then enable the vif, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_enable_vif ( const string &  vif_name,
const bool &  enable 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:
vif_namethe name of the vif to enable/disable/start/stop.
enableif true, then enable the vif, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_have_multicast_routing4 ( bool &  result) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Test if the underlying system supports IPv4 multicast routing.

Parameters:
resulttrue if the underlying system supports IPv4 multicast routing, otherwise false.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_have_multicast_routing4 ( bool &  result) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Test if the underlying system supports IPv4 multicast routing.

Parameters:
resulttrue if the underlying system supports IPv4 multicast routing, otherwise false.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_have_multicast_routing6 ( bool &  result) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Test if the underlying system supports IPv6 multicast routing.

Parameters:
resulttrue if the underlying system supports IPv6 multicast routing, otherwise false.
virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_have_multicast_routing6 ( bool &  result) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Test if the underlying system supports IPv6 multicast routing.

Parameters:
resulttrue if the underlying system supports IPv6 multicast routing, otherwise false.
virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_log_trace_all ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable the MFEA trace log for all operations.

Parameters:
enableif true, then enable the trace log, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_log_trace_all ( const bool &  enable) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable the MFEA trace log for all operations.

Parameters:
enableif true, then enable the trace log, otherwise disable it.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_register_protocol4 ( const string &  xrl_sender_name,
const string &  if_name,
const string &  vif_name,
const uint32_t &  ip_protocol 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register a protocol on an interface in the Multicast FEA. There could be only one registered protocol per interface/vif.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
if_namethe name of the interface to register for the particular protocol.
vif_namethe name of the vif to register for the particular protocol.
ip_protocolthe IP protocol number. It must be between 1 and 255.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_register_protocol4 ( const string &  xrl_sender_name,
const string &  if_name,
const string &  vif_name,
const uint32_t &  ip_protocol 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Register a protocol on an interface in the Multicast FEA. There could be only one registered protocol per interface/vif.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
if_namethe name of the interface to register for the particular protocol.
vif_namethe name of the vif to register for the particular protocol.
ip_protocolthe IP protocol number. It must be between 1 and 255.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_unregister_protocol4 ( const string &  xrl_sender_name,
const string &  if_name,
const string &  vif_name 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Unregister a protocol on an interface in the Multicast FEA. There could be only one registered protocol per interface/vif.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
if_namethe name of the interface to unregister for the particular protocol.
vif_namethe name of the vif to unregister for the particular protocol.

Implemented in XrlMfeaNode.

virtual XrlCmdError XrlMfeaTargetBase::mfea_0_1_unregister_protocol4 ( const string &  xrl_sender_name,
const string &  if_name,
const string &  vif_name 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Unregister a protocol on an interface in the Multicast FEA. There could be only one registered protocol per interface/vif.

Parameters:
xrl_sender_namethe XRL name of the originator of this XRL.
if_namethe name of the interface to unregister for the particular protocol.
vif_namethe name of the vif to unregister for the particular protocol.

Implemented in XrlMfeaNode.

bool XrlMfeaTargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer 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.
bool XrlMfeaTargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer 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.

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations