xorp

PortTimerConstants Class Reference

Container of timer constants associated with a RIP port. More...

#include <port_vars.hh>

List of all members.

Public Member Functions

 PortTimerConstants ()
 Initialize contants with default values from RIPv2 spec.
bool set_expiry_secs (uint32_t t)
 Set the route expiration time.
uint32_t expiry_secs () const
 Get the route route expiration time.
bool set_deletion_secs (uint32_t t)
 Set the route deletion time.
uint32_t deletion_secs () const
 Get the route deletion time.
bool set_table_request_period_secs (uint32_t t)
 Set request packet transmission period.
uint32_t table_request_period_secs () const
 Set request packet transmission period.
bool set_update_interval (uint32_t t_secs)
 Set unsolicitied response time.
uint32_t update_interval ()
 Get unsolicitied response time.
bool set_update_jitter (uint32_t t_jitter)
 Set unsolicitied response time jitter.
uint32_t update_jitter ()
 Get unsolicitied response time jitter.
bool set_triggered_update_delay (uint32_t t_secs)
 Set the triggered update delay.
uint32_t triggered_update_delay () const
 Get the triggered update delay.
bool set_triggered_update_jitter (uint32_t t_jitter)
 Set the triggered update jitter.
uint32_t triggered_update_jitter () const
 Get the triggered update jitter.
bool set_interpacket_delay_ms (uint32_t t)
 Set the interpacket packet delay.
uint32_t interpacket_delay_ms () const
 Get the interpacket packet delay in milliseconds.
bool set_interquery_delay_ms (uint32_t t)
 Set the interquery gap.
uint32_t interquery_delay_ms () const
 Get the interquery gap.

Protected Attributes

uint32_t _expiry_secs
uint32_t _deletion_secs
uint32_t _table_request_secs
uint32_t _update_interval
uint32_t _update_jitter
uint32_t _triggered_update_delay
uint32_t _triggered_update_jitter
uint32_t _interpacket_msecs
uint32_t _interquery_msecs

Detailed Description

Container of timer constants associated with a RIP port.


Constructor & Destructor Documentation

PortTimerConstants::PortTimerConstants ( ) [inline]

Initialize contants with default values from RIPv2 spec.

The values are defined in constants.hh.


Member Function Documentation

uint32_t PortTimerConstants::deletion_secs ( ) const [inline]

Get the route deletion time.

Returns:
deletion time in seconds.
uint32_t PortTimerConstants::expiry_secs ( ) const [inline]

Get the route route expiration time.

Returns:
expiry time in seconds.
uint32_t PortTimerConstants::interquery_delay_ms ( ) const [inline]

Get the interquery gap.

This is the minimum temporal gap between route request packets that query specific routes. Fast arriving queries are ignored.

Returns:
the interquery delay in milliseconds.
bool PortTimerConstants::set_deletion_secs ( uint32_t  t) [inline]

Set the route deletion time.

Parameters:
tthe deletion time in seconds (must be >= 1).
Returns:
true on success, false if t == 0.
bool PortTimerConstants::set_expiry_secs ( uint32_t  t) [inline]

Set the route expiration time.

Parameters:
tthe expiration time in seconds.
Returns:
true on success.
bool PortTimerConstants::set_interpacket_delay_ms ( uint32_t  t) [inline]

Set the interpacket packet delay.

Parameters:
tthe interpacket delay for back-to-back packets in milliseconds.
Returns:
true on success, false if t is greater than MAXIMUM_INTERPACKET_DELAY_MS.
bool PortTimerConstants::set_interquery_delay_ms ( uint32_t  t) [inline]

Set the interquery gap.

This is the minimum temporal gap between route request packets that query specific routes. Queries arriving at a faster rate are ignored.

Parameters:
tthe interquery delay in milliseconds.
Returns:
true on success.
bool PortTimerConstants::set_table_request_period_secs ( uint32_t  t) [inline]

Set request packet transmission period.

Request packets are only sent when there are no peers associated with a port.

Parameters:
tinter-packet interval in seconds.
Returns:
true on success.
bool PortTimerConstants::set_triggered_update_delay ( uint32_t  t_secs) [inline]

Set the triggered update delay.

Parameters:
t_secsthe triggered update delay in seconds.
Returns:
true on success.
bool PortTimerConstants::set_triggered_update_jitter ( uint32_t  t_jitter) [inline]

Set the triggered update jitter.

Parameters:
t_jitterthe triggered update jitter (in percents of the time delay).
Returns:
true on success.
bool PortTimerConstants::set_update_interval ( uint32_t  t_secs) [inline]

Set unsolicitied response time.

Parameters:
t_secsunsolicited response time in seconds.
Returns:
true on success.
bool PortTimerConstants::set_update_jitter ( uint32_t  t_jitter) [inline]

Set unsolicitied response time jitter.

Parameters:
t_jitterunsolicited response time jitter (in percents of the time period).
Returns:
true on success.
uint32_t PortTimerConstants::table_request_period_secs ( ) const [inline]

Set request packet transmission period.

Returns:
inter-packet interval in seconds.
uint32_t PortTimerConstants::triggered_update_delay ( ) const [inline]

Get the triggered update delay.

Returns:
the triggered update delay in seconds.
uint32_t PortTimerConstants::triggered_update_jitter ( ) const [inline]

Get the triggered update jitter.

Returns:
the triggered update jitter (in percents of the time delay).
uint32_t PortTimerConstants::update_interval ( ) [inline]

Get unsolicitied response time.

Returns:
unsolicited response time in seconds.
uint32_t PortTimerConstants::update_jitter ( ) [inline]

Get unsolicitied response time jitter.

Returns:
unsolicited response time jitter (in percents of the time period).

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