class FtiConfig

Forwarding Table Interface. More...

Definition#include <fticonfig.hh>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Members


Detailed Description

Abstract class.

 FtiConfig (EventLoop& eventloop)

FtiConfig

Constructor.

Parameters:
eventloopthe event loop.

 ~FtiConfig ()

~FtiConfig

[virtual]

Virtual destructor (in case this class is used as base class).

EventLoop&  eventloop ()

eventloop

int  register_ftic_entry_get (FtiConfigEntryGet *ftic_entry_get)

register_ftic_entry_get

int  register_ftic_entry_set (FtiConfigEntrySet *ftic_entry_set)

register_ftic_entry_set

int  register_ftic_entry_observer (FtiConfigEntryObserver *ftic_entry_observer)

register_ftic_entry_observer

int  register_ftic_table_get (FtiConfigTableGet *ftic_table_get)

register_ftic_table_get

int  register_ftic_table_set (FtiConfigTableSet *ftic_table_set)

register_ftic_table_set

int  register_ftic_table_observer (FtiConfigTableObserver *ftic_table_observer)

register_ftic_table_observer

FtiConfigEntryGet&  ftic_entry_get ()

ftic_entry_get

FtiConfigEntrySet&  ftic_entry_set ()

ftic_entry_set

FtiConfigEntryObserver&  ftic_entry_observer ()

ftic_entry_observer

FtiConfigTableGet&  ftic_table_get ()

ftic_table_get

FtiConfigTableSet&  ftic_table_set ()

ftic_table_set

FtiConfigTableObserver&  ftic_table_observer ()

ftic_table_observer

int  set_dummy ()

set_dummy

Setup the unit to behave as dummy (for testing purpose).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  start ()

start

Start operation.

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  stop ()

stop

Stop operation.

Returns: XORP_OK on success, otherwise XORP_ERROR.

bool  start_configuration ()

start_configuration

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

Returns: true if configuration successfully started.

bool  end_configuration ()

end_configuration

End of configuration interval.

Returns: true configuration success pushed down into forwarding table.

bool  add_entry4 (const Fte4& fte)

add_entry4

[virtual]

Add a single routing entry. Must be within a configuration interval.

Parameters:
ftethe entry to add.

Returns: true on success, otherwise false.

bool  delete_entry4 (const Fte4& fte)

delete_entry4

[virtual]

Delete a single routing entry. Must be with a configuration interval.

Parameters:
ftethe entry to delete. Only destination and netmask are used.

Returns: true on success, otherwise false.

bool  set_table4 (const list<Fte4>& fte_list)

set_table4

[virtual]

Set the unicast forwarding table.

Parameters:
fte_listthe list with all entries to install into the unicast forwarding table.

Returns: true on success, otherwise false.

bool  delete_all_entries4 ()

delete_all_entries4

[virtual]

Delete all entries in the routing table. Must be within a configuration interval.

Returns: true on success, otherwise false.

bool  lookup_route4 (const IPv4& dst, Fte4& fte)

lookup_route4

[virtual]

Lookup a route.

Parameters:
dsthost address to resolve.
ftereturn-by-reference forwarding table entry.

Returns: true on success, otherwise false.

bool  lookup_entry4 (const IPv4Net& dst, Fte4& fte)

lookup_entry4

[virtual]

Lookup entry.

Parameters:
dstnetwork address to resolve.
ftereturn-by-reference forwarding table entry.

Returns: true on success, otherwise false.

bool  get_table4 (list<Fte4>& fte_list)

get_table4

[virtual]

Obtain the unicast forwarding table.

Parameters:
fte_listthe return-by-reference list with all entries in the unicast forwarding table.

Returns: true on success, otherwise false.

bool  add_entry6 (const Fte6& fte)

add_entry6

[virtual]

Add a single routing entry. Must be within a configuration interval.

Parameters:
ftethe entry to add.

Returns: true on success, otherwise false.

bool  set_table6 (const list<Fte6>& fte_list)

set_table6

[virtual]

Set the unicast forwarding table.

Parameters:
fte_listthe list with all entries to install into the unicast forwarding table.

Returns: true on success, otherwise false.

bool  delete_entry6 (const Fte6& fte)

delete_entry6

[virtual]

Delete a single routing entry. Must be within a configuration interval.

Parameters:
ftethe entry to delete. Only destination and netmask are used.

Returns: true on success, otherwise false.

bool  delete_all_entries6 ()

delete_all_entries6

[virtual]

Delete all entries in the routing table. Must be within a configuration interval.

Returns: true on success, otherwise false.

bool  lookup_route6 (const IPv6& dst, Fte6& fte)

lookup_route6

[virtual]

Lookup a route.

Parameters:
dsthost address to resolve.
ftereturn-by-reference forwarding table entry.

Returns: true on success, otherwise false.

bool  lookup_entry6 (const IPv6Net& dst, Fte6& fte)

lookup_entry6

[virtual]

Lookup entry.

Parameters:
dstnetwork address to resolve.
ftereturn-by-reference forwarding table entry.

Returns: true on success, otherwise false.

bool  get_table6 (list<Fte6>& fte_list)

get_table6

[virtual]

Obtain the unicast forwarding table.

Parameters:
fte_listthe return-by-reference list with all entries in the unicast forwarding table.

Returns: true on success, otherwise false.

bool  have_ipv4 ()

have_ipv4

[const]

Test if the underlying system supports IPv4.

Returns: true if the underlying system supports IPv4, otherwise false.

bool  have_ipv6 ()

have_ipv6

[const]

Test if the underlying system supports IPv6.

Returns: true if the underlying system supports IPv6, otherwise false.

int  unicast_forwarding_enabled4 (bool& ret_value, string& error_msg)

unicast_forwarding_enabled4

[const]

Test whether the IPv4 unicast forwarding engine is enabled or disabled to forward packets.

Parameters:
ret_valueif true on return, then the IPv4 unicast forwarding is enabled, otherwise is disabled.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  unicast_forwarding_enabled6 (bool& ret_value, string& error_msg)

unicast_forwarding_enabled6

[const]

Test whether the IPv6 unicast forwarding engine is enabled or disabled to forward packets.

Parameters:
ret_valueif true on return, then the IPv6 unicast forwarding is enabled, otherwise is disabled.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  accept_rtadv_enabled6 (bool& ret_value, string& error_msg)

accept_rtadv_enabled6

[const]

Test whether the acceptance of IPv6 Router Advertisement messages is enabled or disabled.

Parameters:
ret_valueif true on return, then the acceptance of IPv6 Router Advertisement messages is enabled, otherwise is disabled.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_unicast_forwarding_enabled4 (bool v, string& error_msg)

set_unicast_forwarding_enabled4

Set the IPv4 unicast forwarding engine to enable or disable forwarding of packets.

Parameters:
vif true, then enable IPv4 unicast forwarding, otherwise disable it.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_unicast_forwarding_enabled6 (bool v, string& error_msg)

set_unicast_forwarding_enabled6

Set the IPv6 unicast forwarding engine to enable or disable forwarding of packets.

Parameters:
vif true, then enable IPv6 unicast forwarding, otherwise disable it.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

int  set_accept_rtadv_enabled6 (bool v, string& error_msg)

set_accept_rtadv_enabled6

Enable or disable the acceptance of IPv6 Router Advertisement messages from other routers. It should be enabled for hosts, and disabled for routers.

Parameters:
vif true, then enable the acceptance of IPv6 Router Advertisement messages, otherwise disable it.
error_msgthe error message (if error).

Returns: XORP_OK on success, otherwise XORP_ERROR.

Trie4&  trie4 ()

trie4

Get the IPv4 Trie (used for testing purpose).

Returns: the IPv4 Trie.

Trie6&  trie6 ()

trie6

Get the IPv6 Trie (used for testing purpose).

Returns: the IPv6 Trie.

Trie4 _trie4

_trie4

[protected]

Trie6 _trie6

_trie6

[protected]


Generated by: pavlin on possum.icir.org on Thu Nov 6 23:46:57 2003, using kdoc 2.0a54+XORP.