class IfTreeInterface

FEA class for holding physical interface state. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Types

Public Methods


Detailed Description

FEA class for holding physical interface state.

typedef map<const string, IfTreeVif*> VifMap

VifMap

typedef set<Mac> MacSet

MacSet

 IfTreeInterface (IfTree& iftree, const string& ifname)

IfTreeInterface

 ~IfTreeInterface ()

~IfTreeInterface

IfTree&  iftree ()

iftree

const string&  ifname ()

ifname

[const]

uint32_t  pif_index ()

pif_index

[const]

void  set_pif_index (uint32_t v)

set_pif_index

bool  enabled ()

enabled

[const]

void  set_enabled (bool en)

set_enabled

uint32_t  mtu ()

mtu

[const]

void  set_mtu (uint32_t mtu)

set_mtu

const Mac&  mac ()

mac

[const]

void  set_mac (const Mac& mac)

set_mac

MacSet&  macs ()

macs

const MacSet&  macs ()

macs

[const]

bool  no_carrier ()

no_carrier

[const]

void  set_no_carrier (bool v)

set_no_carrier

uint64_t  baudrate ()

baudrate

[const]

void  set_baudrate (uint64_t v)

set_baudrate

bool  discard ()

discard

[const]

void  set_discard (bool discard)

set_discard

bool  unreachable ()

unreachable

[const]

void  set_unreachable (bool v)

set_unreachable

bool  management ()

management

[const]

void  set_management (bool v)

set_management

bool  default_system_config ()

default_system_config

[const]

void  set_default_system_config (bool v)

set_default_system_config

uint32_t  interface_flags ()

interface_flags

[const]

Get the system-specific interface flags.

Typically, this value is read from the underlying system, and is used only for internal purpose.

Returns: the system-specific interface flags.

void  set_interface_flags (uint32_t v)

set_interface_flags

Store the system-specific interface flags.

Typically, this value is read from the underlying system, and is used only for internal purpose.

Parameters:

vthe value of the system-specific interface flags to store.
const VifMap&  vifs ()

vifs

[const]

VifMap&  vifs ()

vifs

void  add_recursive_vif (const IfTreeVif& other_vif, bool mark_state)

add_recursive_vif

Add recursively a new vif.

Parameters:

other_vifthe vif to add recursively.
mark_stateif true, then mark the state same as the state from the other vif, otherwise the state will be CREATED.
int  add_vif (const string& vifname)

add_vif

Create a new vif.

Parameters:

vifnamethe vif name.

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  remove_vif (const string& vifname)

remove_vif

Label vif as ready for deletion. Deletion does not occur until finalize_state() is called.

Parameters:

vifnamethe name of the vif to be labelled.

Returns: XORP_OK on success, otherwise XORP_ERROR.

IfTreeVif*  find_vif (const string& vifname)

find_vif

Find a vif.

Parameters:

vifnamethe vif name to search for.

Returns: a pointer to the vif (IfTreeVif) or NULL if not found.

const IfTreeVif*  find_vif (const string& vifname)

find_vif

[const]

Find a const vif.

Parameters:

vifnamethe vif name to search for.

Returns: a const pointer to the vif (IfTreeVif) or NULL if not found.

IfTreeVif*  find_vif (uint32_t pif_index)

find_vif

Find a vif for a given physical index.

Parameters:

pif_indexthe physical interface index to search for.

Returns: a pointer to the interface (IfTreeVif) or NULL if not found.

const IfTreeVif*  find_vif (uint32_t pif_index)

find_vif

[const]

Find a const vif for a given physical index.

Parameters:

pif_indexthe physical interface index to search for.

Returns: a const pointer to the interface (IfTreeVif) or NULL if not found.

IfTreeAddr4*  find_addr (const string& vifname, const IPv4& addr)

find_addr

Find an IPv4 address.

Parameters:

vifnamethe vif name to search for.
addrthe address to search for.

Returns: a pointer to the vif (IfTreeAddr4) or NULL if not found.

const IfTreeAddr4*  find_addr (const string& vifname, const IPv4& addr)

find_addr

[const]

Find a const IPv4 address.

Parameters:

vifnamethe vif name to search for.
addrthe address to search for.

Returns: a const pointer to the vif (IfTreeAddr4) or NULL if not found.

IfTreeAddr6*  find_addr (const string& vifname, const IPv6& addr)

find_addr

Find an IPv6 address.

Parameters:

vifnamethe vif name to search for.
addrthe address to search for.

Returns: a pointer to the vif (IfTreeAddr6) or NULL if not found.

const IfTreeAddr6*  find_addr (const string& vifname, const IPv6& addr)

find_addr

[const]

Find a const IPv6 address.

Parameters:

vifnamethe vif name to search for.
addrthe address to search for.

Returns: a pointer to the vif (IfTreeAddr6) or NULL if not found.

void  copy_state (const IfTreeInterface& o, bool copy_user_config)

copy_state

Copy state of internal variables from another IfTreeInterface.

Parameters:

othe interface to copy from.
copy_user_configif true then copy the flags from the user's configuration.
bool  is_same_state (const IfTreeInterface& o)

is_same_state

Test if the interface-specific internal state is same.

Parameters:

othe IfTreeInterface to compare against.

Returns: true if the interface-specific internal state is same.

void  finalize_state ()

finalize_state

Reimplemented from IfTreeItem.

string  str ()

str

[const]

Reimplemented from IfTreeItem.


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