xorp

FibConfigEntrySet Class Reference

Inheritance diagram for FibConfigEntrySet:
FibConfigEntrySetDummy FibConfigEntrySetIPHelper FibConfigEntrySetRtmV2

List of all members.

Public Member Functions

 FibConfigEntrySet (FeaDataPlaneManager &fea_data_plane_manager)
 Constructor.
virtual ~FibConfigEntrySet ()
 Virtual destructor.
FibConfigfibconfig ()
 Get the FibConfig 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 start_configuration (string &error_msg)
 Start a configuration interval.
virtual int end_configuration (string &error_msg)
 End of configuration interval.
virtual int add_entry4 (const Fte4 &fte)=0
 Add a single IPv4 forwarding entry.
virtual int delete_entry4 (const Fte4 &fte)=0
 Delete a single IPv4 forwarding entry.
virtual int add_entry6 (const Fte6 &fte)=0
 Add a single IPv6 forwarding entry.
virtual int delete_entry6 (const Fte6 &fte)=0
 Delete a single IPv6 forwarding entry.
virtual int notify_table_id_change (uint32_t new_tbl)=0
 Routing table ID that we are interested in might have changed.

Protected Member Functions

int mark_configuration_start (string &error_msg)
 Mark start of a configuration.
int mark_configuration_end (string &error_msg)
 Mark end of a configuration.
bool in_configuration () const

Protected Attributes

bool _is_running

Private Attributes

FibConfig_fibconfig
FeaDataPlaneManager_fea_data_plane_manager
bool _in_configuration

Constructor & Destructor Documentation

FibConfigEntrySet::FibConfigEntrySet ( FeaDataPlaneManager fea_data_plane_manager) [inline]

Constructor.

Parameters:
fea_data_plane_managerthe corresponding data plane manager (FeaDataPlaneManager).

Member Function Documentation

virtual int FibConfigEntrySet::add_entry4 ( const Fte4 fte) [pure virtual]

Add a single IPv4 forwarding entry.

Must be within a configuration interval.

Parameters:
ftethe entry to add.
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.

virtual int FibConfigEntrySet::add_entry6 ( const Fte6 fte) [pure virtual]

Add a single IPv6 forwarding entry.

Must be within a configuration interval.

Parameters:
ftethe entry to add.
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.

virtual int FibConfigEntrySet::delete_entry4 ( const Fte4 fte) [pure virtual]

Delete a single IPv4 forwarding entry.

Must be with a configuration interval.

Parameters:
ftethe entry to delete. Only destination and netmask are used.
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.

virtual int FibConfigEntrySet::delete_entry6 ( const Fte6 fte) [pure virtual]

Delete a single IPv6 forwarding entry.

Must be within a configuration interval.

Parameters:
ftethe entry to delete. Only destination and netmask are used.
Returns:
XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.

virtual int FibConfigEntrySet::end_configuration ( string &  error_msg) [inline, virtual]

End of configuration interval.

This method provides derived classes with a mechanism to perform any actions necessary at the end of a configuration, eg write a file.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
FeaDataPlaneManager& FibConfigEntrySet::fea_data_plane_manager ( ) [inline]

Get the FeaDataPlaneManager instance.

Returns:
the FeaDataPlaneManager instance.
FibConfig& FibConfigEntrySet::fibconfig ( ) [inline]

Get the FibConfig instance.

Returns:
the FibConfig instance.
virtual bool FibConfigEntrySet::is_running ( ) const [inline, virtual]

Test whether this instance is running.

Returns:
true if the instance is running, otherwise false.
int FibConfigEntrySet::mark_configuration_end ( string &  error_msg) [inline, protected]

Mark end of a configuration.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
int FibConfigEntrySet::mark_configuration_start ( string &  error_msg) [inline, protected]

Mark start of a configuration.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
virtual int FibConfigEntrySet::notify_table_id_change ( uint32_t  new_tbl) [pure virtual]

Routing table ID that we are interested in might have changed.

Maybe something can filter on this for increased efficiency.

Implemented in FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.

virtual int FibConfigEntrySet::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 FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.

virtual int FibConfigEntrySet::start_configuration ( string &  error_msg) [inline, virtual]

Start a configuration interval.

All modifications to must be within a marked "configuration" interval.

This method provides derived classes with a mechanism to perform any actions necessary before forwarding table modifications can be made.

Parameters:
error_msgthe error message (if error).
Returns:
XORP_OK on success, otherwise XORP_ERROR.
virtual int FibConfigEntrySet::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 FibConfigEntrySetDummy, FibConfigEntrySetIPHelper, and FibConfigEntrySetRtmV2.


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