|
| ||||||||||||||||
| XrlCmdMap* _cmds | _cmds |
[protected]
| XrlMld6igmpTargetBase (XrlCmdMap* cmds = 0)
| XrlMld6igmpTargetBase |
Constructor.
Parameters:
| cmds | an XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target. |
| ~XrlMld6igmpTargetBase ()
| ~XrlMld6igmpTargetBase |
[virtual]
Destructor.
Dissociates instance commands from command map.
| bool set_command_map (XrlCmdMap* cmds)
| set_command_map |
Set command map.
Parameters:
| cmds | pointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target. |
Returns: true on success, false if cmds is null or a command map has already been supplied.
| const string& name ()
| name |
[const]
Get Xrl instance name associated with command map.
| const char* version ()
| version |
[const]
Get version string of instance.
| XrlCmdError common_0_1_get_target_name (
string& name)
| common_0_1_get_target_name |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_get_version (
string& version)
| common_0_1_get_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get version string from Xrl Target
| XrlCmdError common_0_1_get_status (
uint32_t& status,
string& reason)
| common_0_1_get_status |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
| XrlCmdError common_0_1_shutdown ()
| common_0_1_shutdown |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Request clean shutdown of Xrl Target
| XrlCmdError cli_processor_0_1_process_command (
const string& processor_name,
const string& cli_term_name,
const uint32_t& cli_session_id,
const string& command_name,
const string& command_args,
string& ret_processor_name,
string& ret_cli_term_name,
uint32_t& ret_cli_session_id,
string& ret_command_output)
| cli_processor_0_1_process_command |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Process a CLI command.
Parameters:
| processor_name | the processor name for this command. |
| cli_term_name | the terminal name the command was entered from. |
| cli_session_id | the CLI session ID the command was entered from. |
| command_name | the command name to process. |
| command_args | the command arguments to process. |
| ret_processor_name | the processor name to return back to the CLI. |
| ret_cli_term_name | the terminal name to return back. |
| ret_cli_session_id | the CLI session ID to return back. |
| ret_command_output | the command output to return back. |
| XrlCmdError finder_event_observer_0_1_xrl_target_birth (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_birth |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target birth to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError finder_event_observer_0_1_xrl_target_death (
const string& target_class,
const string& target_instance)
| finder_event_observer_0_1_xrl_target_death |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Announce target death to observer.
Parameters:
| target_class | the target class name. |
| target_instance | the target instance name. |
| XrlCmdError raw_packet4_client_0_1_recv (
const string& if_name,
const string& vif_name,
const IPv4& src_address,
const IPv4& dst_address,
const uint32_t& ip_protocol,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& ip_router_alert,
const bool& ip_internet_control,
const vector<uint8_t>& payload)
| raw_packet4_client_0_1_recv |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Receive an IPv4 packet from a raw socket.
Parameters:
| if_name | the interface name the packet arrived on. |
| vif_name | the vif name the packet arrived on. |
| src_address | the IP source address. |
| dst_address | the IP destination address. |
| ip_protocol | the IP protocol number. |
| ip_ttl | the IP TTL (hop-limit). If it has a negative value, then the received value is unknown. |
| ip_tos | the Type of Service (Diffserv/ECN bits for IPv4). If it has a negative value, then the received value is unknown. |
| ip_router_alert | if true, the IP Router Alert option was included in the IP packet. |
| ip_internet_control | if true, then this is IP control traffic. |
| payload | the payload, everything after the IP header and options. |
| XrlCmdError raw_packet6_client_0_1_recv (
const string& if_name,
const string& vif_name,
const IPv6& src_address,
const IPv6& dst_address,
const uint32_t& ip_protocol,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& ip_router_alert,
const bool& ip_internet_control,
const XrlAtomList& ext_headers_type,
const XrlAtomList& ext_headers_payload,
const vector<uint8_t>& payload)
| raw_packet6_client_0_1_recv |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Receive an IPv6 packet from a raw socket.
Parameters:
| if_name | the interface name the packet arrived on. |
| vif_name | the vif name the packet arrived on. |
| src_address | the IP source address. |
| dst_address | the IP destination address. |
| ip_protocol | the IP protocol number. |
| ip_ttl | the IP TTL (hop-limit). If it has a negative value, then the received value is unknown. |
| ip_tos | the Type Of Service (IP traffic class for IPv4). If it has a negative value, then the received value is unknown. |
| ip_router_alert | if true, the IP Router Alert option was included in the IP packet. |
| ip_internet_control | if true, then this is IP control traffic. |
| ext_headers_type | a list of u32 integers with the types of the optional extention headers. |
| ext_headers_payload | a list of payload data, one for each optional extention header. The number of entries must match ext_headers_type. |
| payload | the payload, everything after the IP header and options. |
| XrlCmdError mld6igmp_0_1_enable_vif (
const string& vif_name,
const bool& enable)
| mld6igmp_0_1_enable_vif |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop a MLD6IGMP vif interface.
Parameters:
| vif_name | the name of the vif to enable/disable/start/stop. |
| enable | if true, then enable the vif, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_start_vif (
const string& vif_name)
| mld6igmp_0_1_start_vif |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_vif (
const string& vif_name)
| mld6igmp_0_1_stop_vif |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_all_vifs (
const bool& enable)
| mld6igmp_0_1_enable_all_vifs |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop all MLD6IGMP vif interfaces.
Parameters:
| enable | if true, then enable the vifs, otherwise disable them. |
| XrlCmdError mld6igmp_0_1_start_all_vifs ()
| mld6igmp_0_1_start_all_vifs |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_all_vifs ()
| mld6igmp_0_1_stop_all_vifs |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_mld6igmp (
const bool& enable)
| mld6igmp_0_1_enable_mld6igmp |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop the MLD6IGMP protocol.
Parameters:
| enable | if true, then enable the MLD6IGMP protocol, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_start_mld6igmp ()
| mld6igmp_0_1_start_mld6igmp |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_mld6igmp ()
| mld6igmp_0_1_stop_mld6igmp |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_enable_cli (
const bool& enable)
| mld6igmp_0_1_enable_cli |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Enable/disable/start/stop the MLD6IGMP CLI access.
Parameters:
| enable | if true, then enable the MLD6IGMP CLI access, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_start_cli ()
| mld6igmp_0_1_start_cli |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_stop_cli ()
| mld6igmp_0_1_stop_cli |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_get_vif_proto_version (
const string& vif_name,
uint32_t& proto_version)
| mld6igmp_0_1_get_vif_proto_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Get the configured protocol version per interface.
Parameters:
| vif_name | the name of the vif to apply to. |
| proto_version | the protocol version. |
| XrlCmdError mld6igmp_0_1_set_vif_proto_version (
const string& vif_name,
const uint32_t& proto_version)
| mld6igmp_0_1_set_vif_proto_version |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Set the protocol version per interface.
Parameters:
| vif_name | the name of the vif to apply to. |
| proto_version | the protocol version. |
| XrlCmdError 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_name | the 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_name | the name of the vif to apply to. |
| enabled | if true, then the IP Router Alert option check was enabled, otherwise it was disabled. |
| XrlCmdError 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_name | the name of the vif to apply to. |
| enable | if 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_name | the 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_name | the name of the vif to apply to. |
| interval_sec | the number of seconds in the interval. |
| interval_usec | the 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_name | the name of the vif to apply to. |
| interval_sec | the number of seconds in the interval. |
| interval_usec | the 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_name | the 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_name | the name of the vif to apply to. |
| interval_sec | the number of seconds in the interval. |
| interval_usec | the 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_name | the name of the vif to apply to. |
| interval_sec | the number of seconds in the interval. |
| interval_usec | the 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_name | the 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_name | the name of the vif to apply to. |
| interval_sec | the number of seconds in the interval. |
| interval_usec | the 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_name | the name of the vif to apply to. |
| interval_sec | the number of seconds in the interval. |
| interval_usec | the 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_name | the 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_name | the name of the vif to apply to. |
| robust_count | the 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_name | the name of the vif to apply to. |
| robust_count | the 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_name | the 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:
| enable | if true, then enable the trace log, otherwise disable it. |
| XrlCmdError mld6igmp_0_1_add_protocol4 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_add_protocol4 |
[protected pure virtual]
Pure-virtual function that needs to be implemented to:
Add/delete a client protocol in the MLD/IGMP protocol.
Parameters:
| xrl_sender_name | the XRL name of the originator of this XRL. |
| protocol_name | the name of the protocol to add/delete. |
| protocol_id | the ID of the protocol to add/delete (both sides must agree on the particular values). |
| vif_name | the name of the vif the protocol add/delete to apply to. |
| vif_index | the index of the vif the protocol add/delete to apply to. The added protocol will receive Join/Leave membership information about same-LAN members for the particular vif. |
| XrlCmdError mld6igmp_0_1_add_protocol6 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_add_protocol6 |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_delete_protocol4 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_delete_protocol4 |
[protected pure virtual]
| XrlCmdError mld6igmp_0_1_delete_protocol6 (
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index)
| mld6igmp_0_1_delete_protocol6 |
[protected pure virtual]
