xorp

Mrib Class Reference

The Multicast Routing Information Base payload entry. More...

#include <mrib_table.hh>

List of all members.

Public Member Functions

 Mrib (int family)
 Constructor for a given address family.
 Mrib (const IPvXNet &dest_prefix)
 Constructor for a given network address prefix.
 Mrib (const Mrib &mrib)
 Copy constructor for a given Mrib entry.
bool operator== (const Mrib &other) const
 Equality Operator.
const IPvXNetdest_prefix () const
 Get the network prefix address.
void set_dest_prefix (const IPvXNet &v)
 Set the network prefix address.
const IPvXnext_hop_router_addr () const
 Get the next-hop router address.
void set_next_hop_router_addr (const IPvX &v)
 Set the next-hop router address.
uint32_t next_hop_vif_index () const
 Get the vif index of the interface toward the next-hop router.
void set_next_hop_vif_index (uint32_t v)
 Set the vif index of the interface toward the next-hop router.
uint32_t metric_preference () const
 Get the metric preference value.
void set_metric_preference (uint32_t v)
 Set the metric preference value.
uint32_t metric () const
 Get the metric value.
void set_metric (uint32_t v)
 Set the metric value.
string str () const
 Convert this entry from binary form to presentation format.

Private Attributes

IPvXNet _dest_prefix
IPvX _next_hop_router_addr
uint32_t _next_hop_vif_index
uint32_t _metric_preference
uint32_t _metric

Detailed Description

The Multicast Routing Information Base payload entry.


Constructor & Destructor Documentation

Mrib::Mrib ( int  family)

Constructor for a given address family.

Parameters:
familythe address family.
Mrib::Mrib ( const IPvXNet dest_prefix)

Constructor for a given network address prefix.

Parameters:
dest_prefixthe network address prefix.
Mrib::Mrib ( const Mrib mrib)

Copy constructor for a given Mrib entry.

Parameters:
mribthe Mrib entry to copy.

Member Function Documentation

const IPvXNet& Mrib::dest_prefix ( ) const [inline]

Get the network prefix address.

Returns:
the network prefix address.
uint32_t Mrib::metric ( ) const [inline]

Get the metric value.

Returns:
the metric value.
uint32_t Mrib::metric_preference ( ) const [inline]

Get the metric preference value.

Returns:
the metric preference value.
const IPvX& Mrib::next_hop_router_addr ( ) const [inline]

Get the next-hop router address.

Returns:
the next-hop router address.
uint32_t Mrib::next_hop_vif_index ( ) const [inline]

Get the vif index of the interface toward the next-hop router.

Returns:
the vif index of the interface toward the next-hop router.
bool Mrib::operator== ( const Mrib other) const

Equality Operator.

Parameters:
otherthe right-hand operand to compare against.
Returns:
true if the left-hand operand is numerically same as the right-hand operand.
void Mrib::set_dest_prefix ( const IPvXNet v) [inline]

Set the network prefix address.

Parameters:
vthe value of the network prefix address to set.
void Mrib::set_metric ( uint32_t  v) [inline]

Set the metric value.

Parameters:
vthe value of the metric to set.
void Mrib::set_metric_preference ( uint32_t  v) [inline]

Set the metric preference value.

Parameters:
vthe value of the metric preference to set.
void Mrib::set_next_hop_router_addr ( const IPvX v) [inline]

Set the next-hop router address.

Parameters:
vthe value of the next-hop router address to set.
void Mrib::set_next_hop_vif_index ( uint32_t  v) [inline]

Set the vif index of the interface toward the next-hop router.

Parameters:
vthe value of the vif index to set.
string Mrib::str ( ) const

Convert this entry from binary form to presentation format.

Returns:
C++ string with the human-readable ASCII representation of the entry.

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