class RouteWalker Asynchronous RouteDB walker. More...

Annotated List  Files  Globals  Hierarchy  Index  Top

Public Types

• typedef A Addr
• typedef IPNet<A> Net
• typedef RouteDB<A>::RouteContainer RouteContainer
• typedef RouteDB<A>::Route Route
• enum State { STATE_RUNNING, STATE_PAUSED }

Public Methods

•  RouteWalker (RouteDB<A>& route_db)
•  ~RouteWalker ()
• inline State  state () const
• const Route*  next_route ()
• const Route*  current_route ()
• void  pause (uint32_t pause_ms)
• void  resume ()
• void  reset ()

Protected Methods

•  RouteWalker (const RouteWalker&)
• RouteWalker&  operator= (const RouteWalker&)

Detailed Description

The RouteWalker class walks the routes in a RouteDB. It assumes the walking is broken up into a number of shorter walks, and that each short walk is triggered from a XorpTimer. The end of a short walk causes state to saved and is signalled using the pause() method. When the next short walk is ready to start, resume() should be called. These calls save and resume state are relatively expensive.

[const]

Returns: current state of instance.

Move iterator to next available route.

Returns: true on success, false if route not available or instance is not in the STATE_RUNNING state.

Get current route.

Returns: pointer to route if available, 0 if route not available or not in STATE_RUNNING state.

Pause route walking operation. The instance state is transitioned from STATE_RUNNING to STATE_PAUSED on the assumption that route walking will be resumed at some point in the future (resume). If the current route has a deletion timer associated with it that would expire within pause_ms, the timer expiry is pushed back so it will expire at a time after the expected resume time. Thus in most cases a walk can safely resume from where it was paused.

Parameters:

Resume route walking. The instance state is transitioned from STATE_PAUSED to STATE_RUNNING. The internal iterator is checked for validity and recovery steps taken should the route pointed to have been deleted.

Effect a reset. The internal iterator is moved to the first stored route and the state is set to STATE_RUNNING.

[protected]

[protected]