class MfeaVif

A class for MFEA-specific virtual interface. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods


Detailed Description

 MfeaVif (MfeaNode& mfea_node, const Vif& vif)

MfeaVif

Constructor for a given MFEA node and a generic virtual interface.

Parameters:

mfea_nodethe MfeaNode this interface belongs to.
vifthe generic Vif interface that contains various information.
 MfeaVif (MfeaNode& mfea_node, const MfeaVif& mfea_vif)

MfeaVif

Copy Constructor for a given MFEA node and MFEA-specific virtual interface.

Parameters:

mfea_nodethe MfeaNode this interface belongs to.
mfea_vifthe origin MfeaVif interface that contains the initialization information.
 ~MfeaVif ()

~MfeaVif

[virtual]

Destructor

int  start (string& error_msg)

start

Start MFEA on a single virtual interface.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  stop (string& error_msg)

stop

Stop MFEA on a single virtual interface.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

void  enable ()

enable

Enable MFEA on a single virtual interface.

If an unit is not enabled, it cannot be start, or pending-start.

void  disable ()

disable

Disable MFEA on a single virtual interface.

If an unit is disabled, it cannot be start or pending-start. If the unit was runnning, it will be stop first.

int  register_protocol (const string& module_instance_name, uint8_t ip_protocol, string& error_msg)

register_protocol

Register a protocol on a single virtual interface.

There could be only one registered protocol per interface/vif.

Parameters:

module_instance_namethe module instance name of the protocol to register.
ip_protocolthe IP protocol number. It must be between 1 and 255.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  unregister_protocol (const string& module_instance_name, string& error_msg)

unregister_protocol

Unregister a protocol on a single virtual interface.

Parameters:

module_instance_namethe module instance name of the protocol to unregister.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

uint8_t  min_ttl_threshold ()

min_ttl_threshold

[const]

Get the minimum TTL a multicast packet must have to be forwarded on this virtual interface.

Returns: the minimum TTL a multicast packet must have to be forwarded on this virtual interface.

void  set_min_ttl_threshold (uint8_t v)

set_min_ttl_threshold

Set the minimum TTL a multicast packet must have to be forwarded on this virtual interface.

Parameters:

vthe value of the minimum TTL a multicast packet must have to be forwarded on this virtual interface.
uint32_t  max_rate_limit ()

max_rate_limit

[const]

Get the maximum multicast bandwidth rate allowed on this virtual interface.

Returns: the maximum multicast bandwidth rate allowed on this virtual interface.

void  set_max_rate_limit (uint32_t v)

set_max_rate_limit

Set the maximum multicast bandwidth rate allowed on this virtual interface.

Parameters:

vthe value of the maximum multicast bandwidth rate allowed on this virtual interface.
const string&  registered_module_instance_name ()

registered_module_instance_name

[const]

Get the registered module instance name.

Returns: the registered module instance name.

uint8_t  registered_ip_protocol ()

registered_ip_protocol

[const]

Get the registered IP protocol.

Returns: the registered IP protocol.


Generated by: pavlin on kobe.xorp.net on Wed Jan 7 19:10:56 2009, using kdoc 2.0a54+XORP.