xorp

PimScopeZone Class Reference

List of all members.

Public Member Functions

 PimScopeZone (const IPvXNet &scope_zone_prefix, const Mifset &scoped_vifs)
 PimScopeZone::PimScopeZone: : The scope zone address prefix.
virtual ~PimScopeZone ()
 PimScopeZone::~PimScopeZone: @:
const IPvXNetscope_zone_prefix () const
void set_scoped_vif (uint32_t vif_index, bool v)
 PimScopeZone::set_scoped_vif: : The vif index of the interface to set or reset.
bool is_empty () const
bool is_set (uint32_t vif_index) const
 PimScopeZone::is_set: : The vif index of the interface to test.
bool is_scoped (const IPvX &addr, uint32_t vif_index) const
 PimScopeZone::is_scoped: : The address to test whether it is scoped.
bool is_scoped (const PimScopeZoneId &zone_id, uint32_t vif_index) const
 PimScopeZone::is_scoped: : The zone ID to test whether it is scoped.
bool is_same_scope_zone (const IPvXNet &scope_zone_prefix) const
 PimScopeZone::is_same_scope_zone: : The prefix address to test if it is the prefix address of this scope zone.

Private Attributes

IPvXNet _scope_zone_prefix
Mifset _scoped_vifs

Constructor & Destructor Documentation

PimScopeZone::PimScopeZone ( const IPvXNet scope_zone_prefix,
const Mifset &  scoped_vifs 
)

PimScopeZone::PimScopeZone: : The scope zone address prefix.

: The bitmask with the vifs that are zone boundary.

PimScopeZone constructor.

PimScopeZone::~PimScopeZone ( ) [virtual]

Member Function Documentation

bool PimScopeZone::is_same_scope_zone ( const IPvXNet scope_zone_prefix) const

PimScopeZone::is_same_scope_zone: : The prefix address to test if it is the prefix address of this scope zone.

Test if this scope zone prefix address is same as .

Return value: True if is same prefix address as the prefix address of this scope zone, otherwise false.

bool PimScopeZone::is_scoped ( const IPvX addr,
uint32_t  vif_index 
) const

PimScopeZone::is_scoped: : The address to test whether it is scoped.

: The vif index of the interface to test.

Test if address is scoped on interface with vif index of .

Return value: True if is scoped on , otherwise false.

bool PimScopeZone::is_scoped ( const PimScopeZoneId zone_id,
uint32_t  vif_index 
) const

PimScopeZone::is_scoped: : The zone ID to test whether it is scoped.

: The vif index of the interface to test.

Test if zone with zone ID of is scoped on interface with vif index of .

Return value: True if is scoped on , otherwise false.

bool PimScopeZone::is_set ( uint32_t  vif_index) const

PimScopeZone::is_set: : The vif index of the interface to test.

Test if an interface is a boundary for this scope zone.

Return value: True if the tested interface is a boundary for this scope zone, otherwise false.

void PimScopeZone::set_scoped_vif ( uint32_t  vif_index,
bool  v 
)

PimScopeZone::set_scoped_vif: : The vif index of the interface to set or reset.

: If true, set the interface as a boundary for this scope zone, otherwise reset it.

Set or reset an interface as a boundary for this scope zone.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations