xorp

Mld6igmpSourceRecord Class Reference

A class to store information about a source (within a given multicast group). More...

#include <mld6igmp_source_record.hh>

List of all members.

Public Member Functions

 Mld6igmpSourceRecord (Mld6igmpGroupRecord &group_record, const IPvX &source)
 Constructor for a given group record and source address.
 ~Mld6igmpSourceRecord ()
 Destructor.
Mld6igmpGroupRecordgroup_record () const
 Get the group record this entry belongs to.
const IPvXsource () const
 Get the source address.
int family () const
 Get the address family.
void set_source_timer (const TimeVal &timeval)
 Set the source timer.
void cancel_source_timer ()
 Cancel the source timer.
void lower_source_timer (const TimeVal &timeval)
 Lower the source timer.
XorpTimersource_timer ()
 Get a reference to the source timer.
uint32_t timeout_sec () const
 Get the number of seconds until the source timer expires.
size_t query_retransmission_count () const
 Get the Query retransmission count.
void set_query_retransmission_count (size_t v)
 Set the Query retransmission count.
 Mld6igmpSourceRecord (Mld6igmpGroupRecord &group_record, const IPvX &source)
 Constructor for a given group record and source address.
 ~Mld6igmpSourceRecord ()
 Destructor.
Mld6igmpGroupRecordgroup_record () const
 Get the group record this entry belongs to.
const IPvXsource () const
 Get the source address.
int family () const
 Get the address family.
void set_source_timer (const TimeVal &timeval)
 Set the source timer.
void cancel_source_timer ()
 Cancel the source timer.
void lower_source_timer (const TimeVal &timeval)
 Lower the source timer.
XorpTimersource_timer ()
 Get a reference to the source timer.
uint32_t timeout_sec () const
 Get the number of seconds until the source timer expires.
size_t query_retransmission_count () const
 Get the Query retransmission count.
void set_query_retransmission_count (size_t v)
 Set the Query retransmission count.

Private Member Functions

void source_timer_timeout ()
 Timeout: the source timer has expired.
void source_timer_timeout ()
 Timeout: the source timer has expired.

Private Attributes

Mld6igmpGroupRecord_group_record
IPvX _source
XorpTimer _source_timer
size_t _query_retransmission_count

Detailed Description

A class to store information about a source (within a given multicast group).


Constructor & Destructor Documentation

Mld6igmpSourceRecord::Mld6igmpSourceRecord ( Mld6igmpGroupRecord group_record,
const IPvX source 
)

Constructor for a given group record and source address.

Mld6igmpSourceRecord::Mld6igmpSourceRecord: : The group record this entry belongs to.

Parameters:
group_recordthe group record this entry belongs to.
sourcethe source address.

: The entry source address.

Return value:

Mld6igmpSourceRecord::~Mld6igmpSourceRecord ( )
Mld6igmpSourceRecord::Mld6igmpSourceRecord ( Mld6igmpGroupRecord group_record,
const IPvX source 
)

Constructor for a given group record and source address.

Parameters:
group_recordthe group record this entry belongs to.
sourcethe source address.

Member Function Documentation

int Mld6igmpSourceRecord::family ( ) const [inline]

Get the address family.

Returns:
the address family.
int Mld6igmpSourceRecord::family ( ) const [inline]

Get the address family.

Returns:
the address family.
Mld6igmpGroupRecord& Mld6igmpSourceRecord::group_record ( ) const [inline]

Get the group record this entry belongs to.

Returns:
a reference to the group record this entry belongs to.
Mld6igmpGroupRecord& Mld6igmpSourceRecord::group_record ( ) const [inline]

Get the group record this entry belongs to.

Returns:
a reference to the group record this entry belongs to.
void Mld6igmpSourceRecord::lower_source_timer ( const TimeVal timeval)

Lower the source timer.

Parameters:
timevalthe timeout interval the source timer should be lowered to.
void Mld6igmpSourceRecord::lower_source_timer ( const TimeVal timeval)

Lower the source timer.

Parameters:
timevalthe timeout interval the source timer should be lowered to.
size_t Mld6igmpSourceRecord::query_retransmission_count ( ) const [inline]

Get the Query retransmission count.

Returns:
the Query retransmission count.
size_t Mld6igmpSourceRecord::query_retransmission_count ( ) const [inline]

Get the Query retransmission count.

Returns:
the Query retransmission count.
void Mld6igmpSourceRecord::set_query_retransmission_count ( size_t  v) [inline]

Set the Query retransmission count.

Parameters:
vthe value to set.
void Mld6igmpSourceRecord::set_query_retransmission_count ( size_t  v) [inline]

Set the Query retransmission count.

Parameters:
vthe value to set.
void Mld6igmpSourceRecord::set_source_timer ( const TimeVal timeval)

Set the source timer.

Parameters:
timevalthe timeout interval of the source timer.
void Mld6igmpSourceRecord::set_source_timer ( const TimeVal timeval)

Set the source timer.

Parameters:
timevalthe timeout interval of the source timer.
const IPvX& Mld6igmpSourceRecord::source ( ) const [inline]

Get the source address.

Returns:
the source address.
const IPvX& Mld6igmpSourceRecord::source ( ) const [inline]

Get the source address.

Returns:
the source address.
XorpTimer& Mld6igmpSourceRecord::source_timer ( ) [inline]

Get a reference to the source timer.

Returns:
a reference to the source timer.
XorpTimer& Mld6igmpSourceRecord::source_timer ( ) [inline]

Get a reference to the source timer.

Returns:
a reference to the source timer.
uint32_t Mld6igmpSourceRecord::timeout_sec ( ) const

Get the number of seconds until the source timer expires.

Returns:
the number of seconds until the source timer expires.
uint32_t Mld6igmpSourceRecord::timeout_sec ( ) const

Get the number of seconds until the source timer expires.

Returns:
the number of seconds until the source timer expires.

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