FibConfigTableSet Class Reference

Inheritance diagram for FibConfigTableSet:

List of all members.

Public Member Functions
	FibConfigTableSet (FeaDataPlaneManager &fea_data_plane_manager)
	Constructor.
virtual	~FibConfigTableSet ()
	Virtual destructor.
FibConfig &	fibconfig ()
	Get the FibConfig instance.
FeaDataPlaneManager &	fea_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	set_table4 (const list< Fte4 > &fte_list)=0
	Set the IPv4 unicast forwarding table.
virtual int	delete_all_entries4 ()=0
	Delete all entries in the IPv4 unicast forwarding table.
virtual int	set_table6 (const list< Fte6 > &fte_list)=0
	Set the IPv6 unicast forwarding table.
virtual int	delete_all_entries6 ()=0
	Delete all entries in the IPv6 unicast forwarding table.
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

FibConfigTableSet::FibConfigTableSet

(

FeaDataPlaneManager &

fea_data_plane_manager

)

[inline]

Constructor.

Parameters:

fea_data_plane_manager

the corresponding data plane manager (FeaDataPlaneManager).

---

Member Function Documentation

virtual int FibConfigTableSet::delete_all_entries4

(

)

[pure virtual]

Delete all entries in the IPv4 unicast forwarding table.

Must be within a configuration interval.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigTableSetDummy, FibConfigTableSetIPHelper, and FibConfigTableSetRtmV2.

virtual int FibConfigTableSet::delete_all_entries6

(

)

[pure virtual]

Delete all entries in the IPv6 unicast forwarding table.

Must be within a configuration interval.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigTableSetDummy, FibConfigTableSetIPHelper, and FibConfigTableSetRtmV2.

virtual int FibConfigTableSet::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_msg

the error message (if error).

Returns:

XORP_OK on success, otherwise XORP_ERROR.

FeaDataPlaneManager& FibConfigTableSet::fea_data_plane_manager

(

)

[inline]

Get the FeaDataPlaneManager instance.

Returns:

the FeaDataPlaneManager instance.

FibConfig& FibConfigTableSet::fibconfig

(

)

[inline]

Get the FibConfig instance.

Returns:

the FibConfig instance.

virtual bool FibConfigTableSet::is_running

(

)

const [inline, virtual]

Test whether this instance is running.

Returns:

true if the instance is running, otherwise false.

int FibConfigTableSet::mark_configuration_end

(

string &

error_msg

)

[inline, protected]

Mark end of a configuration.

Parameters:

error_msg

the error message (if error).

Returns:

XORP_OK on success, otherwise XORP_ERROR.

int FibConfigTableSet::mark_configuration_start

(

string &

error_msg

)

[inline, protected]

Mark start of a configuration.

Parameters:

error_msg

the error message (if error).

Returns:

XORP_OK on success, otherwise XORP_ERROR.

virtual int FibConfigTableSet::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 FibConfigTableSetDummy, and FibConfigTableSetIPHelper.

virtual int FibConfigTableSet::set_table4

(

const list< Fte4 > &

fte_list

)

[pure virtual]

Set the IPv4 unicast forwarding table.

Parameters:

fte_list

the list with all entries to install into the IPv4 unicast forwarding table.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigTableSetDummy, FibConfigTableSetIPHelper, and FibConfigTableSetRtmV2.

virtual int FibConfigTableSet::set_table6

(

const list< Fte6 > &

fte_list

)

[pure virtual]

Set the IPv6 unicast forwarding table.

Parameters:

fte_list

the list with all entries to install into the IPv6 unicast forwarding table.

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigTableSetDummy, FibConfigTableSetIPHelper, and FibConfigTableSetRtmV2.

virtual int FibConfigTableSet::start

(

string &

error_msg

)

[pure virtual]

Start operation.

Parameters:

error_msg

the error message (if error).

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigTableSetDummy, FibConfigTableSetIPHelper, and FibConfigTableSetRtmV2.

virtual int FibConfigTableSet::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_msg

the error message (if error).

Returns:

XORP_OK on success, otherwise XORP_ERROR.

virtual int FibConfigTableSet::stop

(

string &

error_msg

)

[pure virtual]

Stop operation.

Parameters:

error_msg

the error message (if error).

Returns:

XORP_OK on success, otherwise XORP_ERROR.

Implemented in FibConfigTableSetDummy, FibConfigTableSetIPHelper, and FibConfigTableSetRtmV2.

---

The documentation for this class was generated from the following file:

• /home/greearb/git/xorp.ct.github/xorp/fea/fibconfig_table_set.hh