xorp

ShowDistancesProcessor Class Reference

Inheritance diagram for ShowDistancesProcessor:
XrlShowDistancesTargetBase ServiceBase BugCatcher

List of all members.

Public Member Functions

 ShowDistancesProcessor (EventLoop &e, ShowDistancesOptions &opts)
int startup ()
 Start service.
int shutdown ()
 Shutdown service.
XrlCmdError common_0_1_get_target_name (string &name)
 Pure-virtual function that needs to be implemented to:
XrlCmdError common_0_1_get_version (string &version)
 Pure-virtual function that needs to be implemented to:
XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)
 Pure-virtual function that needs to be implemented to:
XrlCmdError common_0_1_shutdown ()
 Pure-virtual function that needs to be implemented to:
XrlCmdError common_0_1_startup ()
 Pure-virtual function that needs to be implemented to:
XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &cls, const string &ins)
 Pure-virtual function that needs to be implemented to:
XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &cls, const string &ins)
 Pure-virtual function that needs to be implemented to:
bool poll_ready_failed ()
void step_100_watch_rib ()
 Register with Finder to watch RIB birth and death events.
void watch_rib_cb (const XrlError &xe)
void step_200_get_admin_distances ()
 Get all registered admin distances for the selected RIB.
void get_distances_cb (const XrlError &xe, const XrlAtomList *protocols, const XrlAtomList *distances)

Protected Attributes

EventLoop_e
const ShowDistancesOptions_opts
XrlRouter_rtr
XorpTimer _t
XorpTask _task
multimap< uint32_t, string > _admin_distances

Member Function Documentation

XrlCmdError ShowDistancesProcessor::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implements XrlShowDistancesTargetBase.

XrlCmdError ShowDistancesProcessor::common_0_1_get_target_name ( string &  name) [virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implements XrlShowDistancesTargetBase.

XrlCmdError ShowDistancesProcessor::common_0_1_get_version ( string &  version) [virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implements XrlShowDistancesTargetBase.

XrlCmdError ShowDistancesProcessor::common_0_1_shutdown ( ) [virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implements XrlShowDistancesTargetBase.

XrlCmdError ShowDistancesProcessor::common_0_1_startup ( ) [inline, virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implements XrlShowDistancesTargetBase.

XrlCmdError ShowDistancesProcessor::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implements XrlShowDistancesTargetBase.

XrlCmdError ShowDistancesProcessor::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implements XrlShowDistancesTargetBase.

int ShowDistancesProcessor::shutdown ( ) [virtual]

Shutdown service.

Service should transition from SERVICE_RUNNING to SERVICE_SHUTTING_DOWN immediately and onto SERVICE_SHUTDOWN or SERVICE_FAILED in the near future.

Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements ServiceBase.

int ShowDistancesProcessor::startup ( ) [virtual]

Start service.

Service should transition from SERVICE_READY to SERVICE_STARTING immediately and onto SERVICE_RUNNING or SERVICE_FAILED in the near future.

Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implements ServiceBase.

void ShowDistancesProcessor::step_100_watch_rib ( )

Register with Finder to watch RIB birth and death events.

If the RIB crashes we don't want to hang waiting for messages from the RIB that will never arrive.


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