siena::BXTable Class Reference

implementation of the forwarding table based on Bloom filters and a data structure used for matching called XDD. More...

#include <bxtable.h>

Inheritance diagram for siena::BXTable:

Collaboration diagram for siena::BXTable:

Public Member Functions
virtual void	ifconfig (if_t, const predicate &)
	Associates a predicate to an interface. More...
virtual void	consolidate ()
	Prepares the forwarding table for matching. More...
virtual void	match (const message &, MatchHandler &) const
	Processes a message, calling the output() function on the given MatchHandler object for each matching interface. More...
virtual void	match (const message &, MatchMessageHandler &) const
	Processes a message, calling the output() function on the given MatchMessageHandler object for each matching interface. More...
virtual void	clear ()
	Clears the forwarding table. More...
virtual void	clear_recycle ()
	Clears the forwarding table. More...
virtual size_t	allocated_bytesize () const
	Memory allocated by the forwarding table. More...
virtual size_t	bytesize () const
	Memory used by the forwarding table. More...
Public Member Functions inherited from siena::ForwardingTable
virtual	~ForwardingTable ()
	Destroys the forwarding including all its internal data structures.

Protected Attributes
FTAllocator	memory
	Protected allocator of the forwarding table. More...
BXPredicate *	plist
	list of predicates. More...

Detailed Description

implementation of the forwarding table based on Bloom filters and a data structure used for matching called XDD.

Like BTable, this implementation is based on encoded filters and messages. However, instead of using a linear scan of the set of encoded filters, this implementation indexes the bitvectors representing filters with a decision diagram.

WARNING: This implementation is provided primarily for experimental purposes. See BTable for details.

Member Function Documentation

virtual size_t siena::BXTable::allocated_bytesize ( ) const

virtual

Memory allocated by the forwarding table.

returns the number of bytes of memory allocated by the forwarding table. This value is always greater than or equal to the value returned by bytesize().

Implements siena::ForwardingTable.

virtual size_t siena::BXTable::bytesize ( ) const

virtual

Memory used by the forwarding table.

returns the number of bytes of memory used by the forwarding table. This value is always less than or equal to the value returned by allocated_bytesize().

Implements siena::ForwardingTable.

virtual void siena::BXTable::clear ( )

virtual

Clears the forwarding table.

This method removes all the associations from the forwarding table and releases allocated memory. After a call to this method, the forwarding table is ready to be configured with ifconfig().

See Also

ifconfig()

consolidate()

Implements siena::ForwardingTable.

virtual void siena::BXTable::clear_recycle ( )

virtual

Clears the forwarding table.

This method removes all the associations from the forwarding table recycling the allocated memory. After a call to this method, the forwarding table is ready to be configured with ifconfig().

See Also

ifconfig()

consolidate()

Implements siena::ForwardingTable.

virtual void siena::BXTable::consolidate ( )

virtual

Prepares the forwarding table for matching.

This function processes the forwarding table, packing some of its internal data structures and preparing them to be used to match events. This function must therefore be called after all the necessary calls to ifconfig and before matching messages with match().

The forwarding table can be reset by calling clear or clear_recycle.

See Also

clear()

recycle_clear()

Reimplemented from siena::ForwardingTable.

virtual void siena::BXTable::ifconfig ( if_t  , const predicate &    )

virtual

Associates a predicate to an interface.

This is the method that constructs the forwarding table. This method must be called once for each interface, after the forwarding table is constructed or after it has been cleared. Using this method twice on the same interface without clearing the forwarding table has undefined effects.

See Also

consolidate()

Implements siena::ForwardingTable.

virtual void siena::BXTable::match ( const message &  , MatchHandler &    ) const

virtual

Processes a message, calling the output() function on the given MatchHandler object for each matching interface.

Matches a message against the predicates stored in the forwarding table. The result is processed through the MatchHandler passed as a parameter to this function.

Notice that the forwarding table must be consolidated by calling siena::ForwardingTable::consolidate() before this function is called.

See Also

consolidate()

Implements siena::ForwardingTable.

virtual void siena::BXTable::match ( const message &  , MatchMessageHandler &    ) const

virtual

Processes a message, calling the output() function on the given MatchMessageHandler object for each matching interface.

See Also

consolidate()

ifconfig()

Implements siena::ForwardingTable.

Member Data Documentation

FTAllocator siena::BXTable::memory

protected

Protected allocator of the forwarding table.

All the data structure forming the forwarding table are allocated through this memory management system.

BXPredicate* siena::BXTable::plist

protected

list of predicates.

each link in this linked list is a pair <predicate,interface-id>