class XrlMld6igmpNode


Definition#include <xrl_mld6igmp_node.hh>
InheritsMld6igmpNode [public ], Mld6igmpNodeCli [public ], XrlCliManagerV0p1Client (unknown) [public ], XrlCommonV0p1Client (unknown) [public ], XrlMfeaV0p1Client (unknown) [public ], XrlMld6igmpClientV0p1Client (unknown) [public ], XrlMld6igmpTargetBase (unknown) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

 XrlMld6igmpNode (int family, x_module_id module_id, EventLoop& event_loop, XrlRouter* r)

XrlMld6igmpNode

 ~XrlMld6igmpNode ()

~XrlMld6igmpNode

[virtual]

int  enable_cli ()

enable_cli

int  disable_cli ()

disable_cli

int  start_cli ()

start_cli

int  stop_cli ()

stop_cli

int  enable_mld6igmp ()

enable_mld6igmp

int  disable_mld6igmp ()

disable_mld6igmp

int  start_mld6igmp ()

start_mld6igmp

int  stop_mld6igmp ()

stop_mld6igmp

void  xrl_result_add_protocol (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_add_protocol

[protected]

void  xrl_result_allow_signal_messages (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_allow_signal_messages

[protected]

void  xrl_result_delete_protocol (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_delete_protocol

[protected]

int  proto_send (const string& dst_module_instance_name, x_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, const bool *fail, const string *reason)

xrl_result_send_protocol_message

[protected]

int  start_protocol_kernel ()

start_protocol_kernel

[protected]

Reimplemented from Mld6igmpNode.

int  stop_protocol_kernel ()

stop_protocol_kernel

[protected]

Reimplemented from Mld6igmpNode.

int  start_protocol_kernel_vif (uint16_t vif_index)

start_protocol_kernel_vif

[protected]

Reimplemented from Mld6igmpNode.

void  xrl_result_start_protocol_kernel_vif (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_start_protocol_kernel_vif

[protected]

int  stop_protocol_kernel_vif (uint16_t vif_index)

stop_protocol_kernel_vif

[protected]

Reimplemented from Mld6igmpNode.

void  xrl_result_stop_protocol_kernel_vif (const XrlError& xrl_error, const bool *fail, const string *reason)

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 Mld6igmpNode.

void  xrl_result_join_multicast_group (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_join_multicast_group

[protected]

int  leave_multicast_group (uint16_t vif_index, const IPvX& multicast_group)

leave_multicast_group

[protected]

Reimplemented from Mld6igmpNode.

void  xrl_result_leave_multicast_group (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_leave_multicast_group

[protected]

int  send_add_membership (const string& dst_module_instance_name, x_module_id dst_module_id, uint16_t vif_index, const IPvX& source, const IPvX& group)

send_add_membership

[protected]

Reimplemented from Mld6igmpNode.

void  xrl_result_send_add_membership (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_send_add_membership

[protected]

int  send_delete_membership (const string& dst_module_instance_name, x_module_id dst_module_id, uint16_t vif_index, const IPvX& source, const IPvX& group)

send_delete_membership

[protected]

Reimplemented from Mld6igmpNode.

void  xrl_result_send_delete_membership (const XrlError& xrl_error, const bool *fail, const string *reason)

xrl_result_send_delete_membership

[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, const bool *fail, const string *reason)

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, const bool *fail, const string *reason)

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

XrlCmdError  mfea_client_0_1_new_vif ( const string& vif_name, const uint32_t& vif_index, bool& fail, string& reason)

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.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_delete_vif ( const string& vif_name, const uint32_t& vif_index, bool& fail, string& reason)

mfea_client_0_1_delete_vif

[protected]

Delete an existing vif.

Parameters:
vif_namethe name of the vif to delete.
vif_indexthe index of the vif to delete.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_add_vif_addr4 ( const string& vif_name, const uint32_t& vif_index, const IPv4& addr, const IPv4Net& subnet, const IPv4& broadcast, const IPv4& peer, bool& fail, string& reason)

mfea_client_0_1_add_vif_addr4

[protected]

Add an address to a vif.

Parameters:
vif_namethe name of the vif.
vif_indexthe index of the vif.
addrthe unicast address to add.
subnetthe subnet address to add.
broadcastthe broadcast address (when applicable).
peerthe peer address (when applicable).
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_add_vif_addr6 ( const string& vif_name, const uint32_t& vif_index, const IPv6& addr, const IPv6Net& subnet, const IPv6& broadcast, const IPv6& peer, bool& fail, string& reason)

mfea_client_0_1_add_vif_addr6

[protected]

XrlCmdError  mfea_client_0_1_delete_vif_addr4 ( const string& vif_name, const uint32_t& vif_index, const IPv4& addr, bool& fail, string& reason)

mfea_client_0_1_delete_vif_addr4

[protected]

Delete an address from a vif.

Parameters:
vif_namethe name of the vif.
vif_indexthe index of the vif.
addrthe unicast address to delete.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_delete_vif_addr6 ( const string& vif_name, const uint32_t& vif_index, const IPv6& addr, bool& fail, string& reason)

mfea_client_0_1_delete_vif_addr6

[protected]

XrlCmdError  mfea_client_0_1_set_vif_flags ( const string& vif_name, const uint32_t& vif_index, 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, bool& fail, string& reason)

mfea_client_0_1_set_vif_flags

[protected]

Set flags to a vif.

Parameters:
vif_namethe name of the vif.
vif_indexthe index 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.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_set_vif_done ( const string& vif_name, const uint32_t& vif_index, bool& fail, string& reason)

mfea_client_0_1_set_vif_done

[protected]

Complete a transaction with vif information.

Parameters:
vif_namethe name of the vif.
vif_indexthe index of the vif.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_set_all_vifs_done ( bool& fail, string& reason)

mfea_client_0_1_set_all_vifs_done

[protected]

Complete all transactions with vif information.

Parameters:
failtrue if failure has occured.
reasoncontains failure reason if it occured.

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, bool& fail, string& reason)

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.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

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, bool& fail, string& reason)

mfea_client_0_1_recv_protocol_message6

[protected]

XrlCmdError  mfea_client_0_1_recv_kernel_signal_message4 ( const string& , const string& , const uint32_t& , const uint32_t& , const string& , const uint32_t& , const IPv4& , const IPv4& , const vector<uint8_t>& , bool& fail, string& reason)

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.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mfea_client_0_1_recv_kernel_signal_message6 ( const string& , const string& , const uint32_t& , const uint32_t& , const string& , const uint32_t& , const IPv6& , const IPv6& , const vector<uint8_t>& , bool& fail, string& reason)

mfea_client_0_1_recv_kernel_signal_message6

[protected]

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, bool& fail, string& reason)

mld6igmp_0_1_add_protocol4

[protected]

Add/delete a 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.
protocol_idthe ID of the protocol to add (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.
failtrue if failure has occured.
reasoncontains failure reason if it occured. The added protocol will receive Join/Leave membership information about same-LAN members.

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, bool& fail, string& reason)

mld6igmp_0_1_add_protocol6

[protected]

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, bool& fail, string& reason)

mld6igmp_0_1_delete_protocol4

[protected]

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, bool& fail, string& reason)

mld6igmp_0_1_delete_protocol6

[protected]

XrlCmdError  mfea_client_0_1_add_mrib4 ( const string& , const IPv4Net& , const IPv4& , const string& , const uint32_t& , const uint32_t& , const uint32_t& , bool& fail, string& reason)

mfea_client_0_1_add_mrib4

[protected]

XrlCmdError  mfea_client_0_1_add_mrib6 ( const string& , const IPv6Net& , const IPv6& , const string& , const uint32_t& , const uint32_t& , const uint32_t& , bool& fail, string& reason)

mfea_client_0_1_add_mrib6

[protected]

XrlCmdError  mfea_client_0_1_delete_mrib4 ( const string& , const IPv4Net& , bool& fail, string& reason)

mfea_client_0_1_delete_mrib4

[protected]

XrlCmdError  mfea_client_0_1_delete_mrib6 ( const string& , const IPv6Net& , bool& fail, string& reason)

mfea_client_0_1_delete_mrib6

[protected]

XrlCmdError  mfea_client_0_1_set_mrib_done ( const string& , bool& fail, string& reason)

mfea_client_0_1_set_mrib_done

[protected]

XrlCmdError  mfea_client_0_1_recv_dataflow_signal4 ( const string& , const IPv4& , const IPv4& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const bool& , const bool& , const bool& , const bool& , bool& fail, string& reason)

mfea_client_0_1_recv_dataflow_signal4

[protected]

XrlCmdError  mfea_client_0_1_recv_dataflow_signal6 ( const string& , const IPv6& , const IPv6& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const uint32_t& , const bool& , const bool& , const bool& , const bool& , bool& fail, string& reason)

mfea_client_0_1_recv_dataflow_signal6

[protected]

XrlCmdError  mld6igmp_0_1_enable_vif ( const string& vif_name, bool& fail, string& reason)

mld6igmp_0_1_enable_vif

[protected]

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

Parameters:
vif_namethe name of the vif to enable/disable/start/stop.
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mld6igmp_0_1_disable_vif ( const string& vif_name, bool& fail, string& reason)

mld6igmp_0_1_disable_vif

[protected]

XrlCmdError  mld6igmp_0_1_start_vif ( const string& vif_name, bool& fail, string& reason)

mld6igmp_0_1_start_vif

[protected]

XrlCmdError  mld6igmp_0_1_stop_vif ( const string& vif_name, bool& fail, string& reason)

mld6igmp_0_1_stop_vif

[protected]

XrlCmdError  mld6igmp_0_1_enable_all_vifs ( bool& fail, string& reason)

mld6igmp_0_1_enable_all_vifs

[protected]

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

Parameters:
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mld6igmp_0_1_disable_all_vifs ( bool& fail, string& reason)

mld6igmp_0_1_disable_all_vifs

[protected]

XrlCmdError  mld6igmp_0_1_start_all_vifs ( bool& fail, string& reason)

mld6igmp_0_1_start_all_vifs

[protected]

XrlCmdError  mld6igmp_0_1_stop_all_vifs ( bool& fail, string& reason)

mld6igmp_0_1_stop_all_vifs

[protected]

XrlCmdError  mld6igmp_0_1_enable_mld6igmp ( bool& fail, string& reason)

mld6igmp_0_1_enable_mld6igmp

[protected]

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

Parameters:
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mld6igmp_0_1_disable_mld6igmp ( bool& fail, string& reason)

mld6igmp_0_1_disable_mld6igmp

[protected]

XrlCmdError  mld6igmp_0_1_enable_cli ( bool& fail, string& reason)

mld6igmp_0_1_enable_cli

[protected]

XrlCmdError  mld6igmp_0_1_disable_cli ( bool& fail, string& reason)

mld6igmp_0_1_disable_cli

[protected]

XrlCmdError  mld6igmp_0_1_start_mld6igmp ( bool& fail, string& reason)

mld6igmp_0_1_start_mld6igmp

[protected]

XrlCmdError  mld6igmp_0_1_stop_mld6igmp ( bool& fail, string& reason)

mld6igmp_0_1_stop_mld6igmp

[protected]

XrlCmdError  mld6igmp_0_1_start_cli ( bool& fail, string& reason)

mld6igmp_0_1_start_cli

[protected]

XrlCmdError  mld6igmp_0_1_stop_cli ( bool& fail, string& reason)

mld6igmp_0_1_stop_cli

[protected]

XrlCmdError  mld6igmp_0_1_enable_log_trace ( bool& fail, string& reason)

mld6igmp_0_1_enable_log_trace

[protected]

Enable/disable the MLD6IGMP trace log.

Parameters:
failtrue if failure has occured.
reasoncontains failure reason if it occured.

XrlCmdError  mld6igmp_0_1_disable_log_trace ( bool& fail, string& reason)

mld6igmp_0_1_disable_log_trace

[protected]


Generated by: pavlin on possum.icir.org on Wed Dec 11 16:50:50 2002, using kdoc 2.0a54+XORP.