class XrlMld6igmpTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlMld6igmpTargetBase (XrlCmdMap* cmds = 0)

XrlMld6igmpTargetBase

Constructor.

Parameters:

cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
 ~XrlMld6igmpTargetBase ()

~XrlMld6igmpTargetBase

[virtual]

Destructor.

Dissociates instance commands from command map.

bool  set_command_map (XrlCmdMap* cmds)

set_command_map

Set command map.

Parameters:

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.

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:

Get name of Xrl Target

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:

Get status of Xrl Target

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_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  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_classthe target class name.
target_instancethe 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_classthe target class name.
target_instancethe 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_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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 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_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 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_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.
mtuthe 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_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 pure virtual]

Pure-virtual function that needs to be implemented to:

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 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_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 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_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 pure virtual]

XrlCmdError  mld6igmp_0_1_enable_vif ( const string& vif_name, const bool& enable)

mld6igmp_0_1_enable_vif

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

vif_namethe name of the vif to enable/disable/start/stop.
enableif true, then enable the vif, otherwise disable it.
XrlCmdError  mld6igmp_0_1_start_vif ( const string& vif_name)

mld6igmp_0_1_start_vif

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_stop_vif ( const string& vif_name)

mld6igmp_0_1_stop_vif

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_enable_all_vifs ( const bool& enable)

mld6igmp_0_1_enable_all_vifs

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

enableif true, then enable the vifs, otherwise disable them.
XrlCmdError  mld6igmp_0_1_start_all_vifs ()

mld6igmp_0_1_start_all_vifs

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_stop_all_vifs ()

mld6igmp_0_1_stop_all_vifs

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_enable_mld6igmp ( const bool& enable)

mld6igmp_0_1_enable_mld6igmp

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable/start/stop the MLD6IGMP protocol.

Parameters:

enableif true, then enable the MLD6IGMP protocol, otherwise disable it.
XrlCmdError  mld6igmp_0_1_start_mld6igmp ()

mld6igmp_0_1_start_mld6igmp

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_stop_mld6igmp ()

mld6igmp_0_1_stop_mld6igmp

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_enable_cli ( const bool& enable)

mld6igmp_0_1_enable_cli

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

enableif true, then enable the MLD6IGMP CLI access, otherwise disable it.
XrlCmdError  mld6igmp_0_1_start_cli ()

mld6igmp_0_1_start_cli

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_stop_cli ()

mld6igmp_0_1_stop_cli

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_get_vif_proto_version ( const string& vif_name, uint32_t& proto_version)

mld6igmp_0_1_get_vif_proto_version

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get the configured protocol version per interface.

Parameters:

vif_namethe name of the vif to apply to.
proto_versionthe protocol version.
XrlCmdError  mld6igmp_0_1_set_vif_proto_version ( const string& vif_name, const uint32_t& proto_version)

mld6igmp_0_1_set_vif_proto_version

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set the protocol version per interface.

Parameters:

vif_namethe name of the vif to apply to.
proto_versionthe protocol version.
XrlCmdError  mld6igmp_0_1_reset_vif_proto_version ( const string& vif_name)

mld6igmp_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_namethe name of the vif to apply to.
XrlCmdError  mld6igmp_0_1_get_vif_ip_router_alert_option_check ( const string& vif_name, bool& enabled)

mld6igmp_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_namethe name of the vif to apply to.
enabledif true, then the IP Router Alert option check was enabled, otherwise it was disabled.
XrlCmdError  mld6igmp_0_1_set_vif_ip_router_alert_option_check ( const string& vif_name, const bool& enable)

mld6igmp_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_namethe name of the vif to apply to.
enableif true, then enable the IP Router Alert option check, otherwise disable it.
XrlCmdError  mld6igmp_0_1_reset_vif_ip_router_alert_option_check ( const string& vif_name)

mld6igmp_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 for received packets per per interface to its default value.

Parameters:

vif_namethe name of the vif to apply to.
XrlCmdError  mld6igmp_0_1_get_vif_query_interval ( const string& vif_name, uint32_t& interval_sec, uint32_t& interval_usec)

mld6igmp_0_1_get_vif_query_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get the Query Interval per interface.

Parameters:

vif_namethe name of the vif to apply to.
interval_secthe number of seconds in the interval.
interval_usecthe number of microseconds (in addition to interval_sec) in the interval.
XrlCmdError  mld6igmp_0_1_set_vif_query_interval ( const string& vif_name, const uint32_t& interval_sec, const uint32_t& interval_usec)

mld6igmp_0_1_set_vif_query_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set the Query Interval per interface.

Parameters:

vif_namethe name of the vif to apply to.
interval_secthe number of seconds in the interval.
interval_usecthe number of microseconds (in addition to interval_sec) in the interval.
XrlCmdError  mld6igmp_0_1_reset_vif_query_interval ( const string& vif_name)

mld6igmp_0_1_reset_vif_query_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the Query Interval per interface to its default value.

Parameters:

vif_namethe name of the vif to apply to.
XrlCmdError  mld6igmp_0_1_get_vif_query_last_member_interval ( const string& vif_name, uint32_t& interval_sec, uint32_t& interval_usec)

mld6igmp_0_1_get_vif_query_last_member_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get the Last Member Query Interval per interface.

Parameters:

vif_namethe name of the vif to apply to.
interval_secthe number of seconds in the interval.
interval_usecthe number of microseconds (in addition to interval_sec) in the interval.
XrlCmdError  mld6igmp_0_1_set_vif_query_last_member_interval ( const string& vif_name, const uint32_t& interval_sec, const uint32_t& interval_usec)

mld6igmp_0_1_set_vif_query_last_member_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set the Last Member Query Interval per interface.

Parameters:

vif_namethe name of the vif to apply to.
interval_secthe number of seconds in the interval.
interval_usecthe number of microseconds (in addition to interval_sec) in the interval.
XrlCmdError  mld6igmp_0_1_reset_vif_query_last_member_interval ( const string& vif_name)

mld6igmp_0_1_reset_vif_query_last_member_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the Last Member Query Interval per interface to its default value.

Parameters:

vif_namethe name of the vif to apply to.
XrlCmdError  mld6igmp_0_1_get_vif_query_response_interval ( const string& vif_name, uint32_t& interval_sec, uint32_t& interval_usec)

mld6igmp_0_1_get_vif_query_response_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get the Query Response Interval per interface.

Parameters:

vif_namethe name of the vif to apply to.
interval_secthe number of seconds in the interval.
interval_usecthe number of microseconds (in addition to interval_sec) in the interval.
XrlCmdError  mld6igmp_0_1_set_vif_query_response_interval ( const string& vif_name, const uint32_t& interval_sec, const uint32_t& interval_usec)

mld6igmp_0_1_set_vif_query_response_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set the Query Response Interval per interface.

Parameters:

vif_namethe name of the vif to apply to.
interval_secthe number of seconds in the interval.
interval_usecthe number of microseconds (in addition to interval_sec) in the interval.
XrlCmdError  mld6igmp_0_1_reset_vif_query_response_interval ( const string& vif_name)

mld6igmp_0_1_reset_vif_query_response_interval

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the Query Response Interval per interface to its default value.

Parameters:

vif_namethe name of the vif to apply to.
XrlCmdError  mld6igmp_0_1_get_vif_robust_count ( const string& vif_name, uint32_t& robust_count)

mld6igmp_0_1_get_vif_robust_count

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get the Robustness Variable count per interface.

Parameters:

vif_namethe name of the vif to apply to.
robust_countthe count value.
XrlCmdError  mld6igmp_0_1_set_vif_robust_count ( const string& vif_name, const uint32_t& robust_count)

mld6igmp_0_1_set_vif_robust_count

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Set the Robustness Variable count per interface.

Parameters:

vif_namethe name of the vif to apply to.
robust_countthe count value.
XrlCmdError  mld6igmp_0_1_reset_vif_robust_count ( const string& vif_name)

mld6igmp_0_1_reset_vif_robust_count

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Reset the Robustness Variable count per interface to its default value.

Parameters:

vif_namethe name of the vif to apply to.
XrlCmdError  mld6igmp_0_1_log_trace_all ( const bool& enable)

mld6igmp_0_1_log_trace_all

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Enable/disable the MLD6IGMP trace log for all operations.

Parameters:

enableif true, then enable the trace log, otherwise disable it.
XrlCmdError  mld6igmp_0_1_add_protocol4 ( const string& xrl_sender_name, const string& protocol_name, const uint32_t& protocol_id, const string& vif_name, const uint32_t& vif_index)

mld6igmp_0_1_add_protocol4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a client protocol in the MLD/IGMP protocol.

Parameters:

xrl_sender_namethe XRL name of the originator of this XRL.
protocol_namethe name of the protocol to add/delete.
protocol_idthe ID of the protocol to add/delete (both sides must agree on the particular values).
vif_namethe name of the vif the protocol add/delete to apply to.
vif_indexthe index of the vif the protocol add/delete to apply to. The added protocol will receive Join/Leave membership information about same-LAN members for the particular vif.
XrlCmdError  mld6igmp_0_1_add_protocol6 ( const string& xrl_sender_name, const string& protocol_name, const uint32_t& protocol_id, const string& vif_name, const uint32_t& vif_index)

mld6igmp_0_1_add_protocol6

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_delete_protocol4 ( const string& xrl_sender_name, const string& protocol_name, const uint32_t& protocol_id, const string& vif_name, const uint32_t& vif_index)

mld6igmp_0_1_delete_protocol4

[protected pure virtual]

XrlCmdError  mld6igmp_0_1_delete_protocol6 ( const string& xrl_sender_name, const string& protocol_name, const uint32_t& protocol_id, const string& vif_name, const uint32_t& vif_index)

mld6igmp_0_1_delete_protocol6

[protected pure virtual]


Generated by: pavlin on possum.icir.org on Wed Mar 21 11:23:08 2007, using kdoc $.