class IfConfigSet


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

 IfConfigSet (IfConfig& ifc)

IfConfigSet

 ~IfConfigSet ()

~IfConfigSet

[virtual]

IfConfig&  ifc ()

ifc

void  register_ifc_primary ()

register_ifc_primary

[virtual]

void  register_ifc_secondary ()

register_ifc_secondary

[virtual]

void  set_primary ()

set_primary

[virtual]

void  set_secondary ()

set_secondary

[virtual]

bool  is_primary ()

is_primary

[const virtual]

bool  is_secondary ()

is_secondary

[const virtual]

bool  is_running ()

is_running

[const virtual]

int  start (string& error_msg)

start

[pure virtual]

Start operation.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  stop (string& error_msg)

stop

[pure virtual]

Stop operation.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

bool  push_config (IfTree& config)

push_config

[virtual]

Push the network interface configuration into the underlying system.

Note that on return some of the interface tree configuration state may be modified.

Parameters:

configthe interface tree configuration to push.

Returns: true on success, otherwise false.

bool  is_discard_emulated (const IfTreeInterface& i)

is_discard_emulated

[const pure virtual]

Determine if the interface's underlying provider implements discard semantics natively, or if they are emulated through other means.

Parameters:

ithe interface item to inspect.

Returns: true if discard semantics are emulated.

int  config_begin (string& error_msg)

config_begin

[protected pure virtual]

Start the configuration.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  config_end (string& error_msg)

config_end

[protected pure virtual]

Complete the configuration.

Parameters:

error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  add_interface (const string& ifname, uint32_t if_index, string& error_msg)

add_interface

[protected pure virtual]

Add an interface.

Parameters:

ifnamethe interface name.
if_indexthe interface index.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  add_vif (const string& ifname, const string& vifname, uint32_t if_index, string& error_msg)

add_vif

[protected pure virtual]

Add a vif.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
if_indexthe interface index.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  config_interface (const string& ifname, uint32_t if_index, uint32_t flags, bool is_up, bool is_deleted, string& error_msg)

config_interface

[protected pure virtual]

Configure an interface.

Parameters:

ifnamethe interface name.
if_indexthe interface index.
flagsthe flags to set on the interface.
is_upif true, the interface is UP, otherwise is DOWN.
is_deletedif true, the interface is deleted.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  config_vif (const string& ifname, const string& vifname, uint32_t if_index, uint32_t flags, bool is_up, bool is_deleted, bool broadcast, bool loopback, bool point_to_point, bool multicast, string& error_msg)

config_vif

[protected pure virtual]

Configure a vif.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
if_indexthe interface index.
flagsthe flags to set on the vif.
is_upif true, the vif is UP, otherwise is DOWN.
is_deletedif true, the vif is deleted.
broadcastif true, the vif is broadcast capable.
loopbackif true, the vif corresponds to the loopback interface.
point_to_pointif true, the vif is a point-to-point interface.
multicastif true, the vif is multicast capable.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_interface_mac_address (const string& ifname, uint32_t if_index, const struct ether_addr& ether_addr, string& error_msg)

set_interface_mac_address

[protected pure virtual]

Set the MAC address of an interface.

Parameters:

ifnamethe interface name.
if_indexthe interface index.
ether_addrthe Ethernet MAC address to set.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_interface_mtu (const string& ifname, uint32_t if_index, uint32_t mtu, string& error_msg)

set_interface_mtu

[protected pure virtual]

Set the MTU of an interface.

Parameters:

ifnamethe interface name.
if_indexthe interface index.
mtuthe MTU to set.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  add_vif_address (const string& ifname, const string& vifname, uint32_t if_index, bool is_broadcast, bool is_p2p, const IPvX& addr, const IPvX& dst_or_bcast, uint32_t prefix_len, string& error_msg)

add_vif_address

[protected pure virtual]

Add an address to a vif.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
if_indexthe interface index.
is_broadcasttrue if dst_or_bcast is a broadcast address.
is_p2ptrue if dst_or_bcast is a destination/peer address.
addrthe address to add.
dst_or_bcastthe broadcast or the destination/peer address.
prefix_lenthe prefix length of the subnet mask.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  delete_vif_address (const string& ifname, const string& vifname, uint32_t if_index, const IPvX& addr, uint32_t prefix_len, string& error_msg)

delete_vif_address

[protected pure virtual]

Delete an address from a vif.

Parameters:

ifnamethe interface name.
vifnamethe vif name.
if_indexthe interface index.
addrthe address to delete.
prefix_lenthe prefix length of the subnet mask.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

bool _is_running

_is_running

[protected]


Generated by: pavlin on possum.icir.org on Thu Mar 9 04:43:06 2006, using kdoc $.