xorp

IfConfigGet Class Reference

Inheritance diagram for IfConfigGet:
IfConfigGetDummy IfConfigGetGetifaddrs IfConfigGetIPHelper IfConfigGetSysctl

List of all members.

Public Member Functions

 IfConfigGet (FeaDataPlaneManager &fea_data_plane_manager)
 Constructor.
virtual ~IfConfigGet ()
 Virtual destructor.
IfConfigifconfig ()
 Get the IfConfig instance.
FeaDataPlaneManagerfea_data_plane_manager ()
 Get the FeaDataPlaneManager instance.
virtual bool is_running () const
 Test whether this instance is running.
virtual int start (string &error_msg)=0
 Start operation.
virtual int stop (string &error_msg)=0
 Stop operation.
virtual int pull_config (const IfTree *local_config, IfTree &iftree)=0
 Pull the network interface information from the underlying system.
virtual bool can_pull_one ()
 Child classes that *can* do this should over-ride.
virtual int pull_config_one (IfTree &iftree, const char *ifname, int if_index)
 If_index can be -1 if unknown: We will try to resolve it from ifname.

Protected Attributes

bool _is_running

Private Attributes

IfConfig_ifconfig
FeaDataPlaneManager_fea_data_plane_manager

Constructor & Destructor Documentation

IfConfigGet::IfConfigGet ( FeaDataPlaneManager fea_data_plane_manager) [inline]

Constructor.

Parameters:
fea_data_plane_managerthe corresponding data plane manager (FeaDataPlaneManager).

Member Function Documentation

FeaDataPlaneManager& IfConfigGet::fea_data_plane_manager ( ) [inline]

Get the FeaDataPlaneManager instance.

Returns:
the FeaDataPlaneManager instance.
IfConfig& IfConfigGet::ifconfig ( ) [inline]

Get the IfConfig instance.

Returns:
the IfConfig instance.
virtual bool IfConfigGet::is_running ( ) const [inline, virtual]

Test whether this instance is running.

Returns:
true if the instance is running, otherwise false.
virtual int IfConfigGet::pull_config ( const IfTree local_config,
IfTree iftree 
) [pure virtual]

Pull the network interface information from the underlying system.

Parameters:
local_configIf not NULL, optimized ifconfig-get subclasses may pull interface config for only interfaces found in local_config. Set to NULl to pull all information from the kernel.
iftreethe IfTree storage to store the pulled information.
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in IfConfigGetDummy, IfConfigGetGetifaddrs, IfConfigGetIPHelper, and IfConfigGetSysctl.

virtual int IfConfigGet::pull_config_one ( IfTree iftree,
const char *  ifname,
int  if_index 
) [inline, virtual]

If_index can be -1 if unknown: We will try to resolve it from ifname.

Child classes that can do this should implement the method.

virtual int IfConfigGet::start ( string &  error_msg) [pure virtual]

Start operation.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in IfConfigGetDummy, IfConfigGetGetifaddrs, IfConfigGetIPHelper, and IfConfigGetSysctl.

virtual int IfConfigGet::stop ( string &  error_msg) [pure virtual]

Stop operation.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in IfConfigGetDummy, IfConfigGetGetifaddrs, IfConfigGetIPHelper, and IfConfigGetSysctl.


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