class XrlFeaTargetBase


 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Protected Methods

Protected Members


Detailed Description

XrlCmdMap* _cmds

_cmds

[protected]

 XrlFeaTargetBase (XrlCmdMap* cmds = 0)

XrlFeaTargetBase

Constructor.

Parameters:

cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
 ~XrlFeaTargetBase ()

~XrlFeaTargetBase

[virtual]

Destructor.

Dissociates instance commands from command map.

bool  set_command_map (XrlCmdMap* cmds)

set_command_map

Set command map.

Parameters:

cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.

Returns: true on success, false if cmds is null or a command map has already been supplied.

inline const string&  name ()

name

[const]

Get Xrl instance name associated with command map.

inline const char*  version ()

version

[const]

Get version string of instance.

XrlCmdError  common_0_1_get_target_name ( string& name)

common_0_1_get_target_name

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

XrlCmdError  common_0_1_get_version ( string& version)

common_0_1_get_version

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

XrlCmdError  common_0_1_get_status ( uint32_t& status, string& reason)

common_0_1_get_status

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

XrlCmdError  common_0_1_shutdown ()

common_0_1_shutdown

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

XrlCmdError  fea_fib_0_1_add_fib_client4 ( const string& target_name)

fea_fib_0_1_add_fib_client4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add a FIB client.

Parameters:

target_namethe target name of the FIB client to add.
XrlCmdError  fea_fib_0_1_add_fib_client6 ( const string& target_name)

fea_fib_0_1_add_fib_client6

[protected pure virtual]

XrlCmdError  fea_fib_0_1_delete_fib_client4 ( const string& target_name)

fea_fib_0_1_delete_fib_client4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a FIB client.

Parameters:

target_namethe target name of the FIB client to delete.
XrlCmdError  fea_fib_0_1_delete_fib_client6 ( const string& target_name)

fea_fib_0_1_delete_fib_client6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_interface_names ( XrlAtomList& ifnames)

ifmgr_0_1_get_configured_interface_names

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_vif_names ( const string& ifname, XrlAtomList& vifs)

ifmgr_0_1_get_configured_vif_names

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_vif_flags ( const string& ifname, const string& vif, bool& enabled, bool& broadcast, bool& loopback, bool& point_to_point, bool& multicast)

ifmgr_0_1_get_configured_vif_flags

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_vif_pif_index ( const string& ifname, const string& vif, uint32_t& pif_index)

ifmgr_0_1_get_configured_vif_pif_index

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_vif_addresses4 ( const string& ifname, const string& vif, XrlAtomList& addresses)

ifmgr_0_1_get_configured_vif_addresses4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_vif_addresses6 ( const string& ifname, const string& vif, XrlAtomList& addresses)

ifmgr_0_1_get_configured_vif_addresses6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_address_flags4 ( const string& ifname, const string& vif, const IPv4& address, bool& enabled, bool& broadcast, bool& loopback, bool& point_to_point, bool& multicast)

ifmgr_0_1_get_configured_address_flags4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_address_flags6 ( const string& ifname, const string& vif, const IPv6& address, bool& enabled, bool& loopback, bool& point_to_point, bool& multicast)

ifmgr_0_1_get_configured_address_flags6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_interface_enabled ( const string& ifname, bool& enabled)

ifmgr_0_1_get_configured_interface_enabled

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_mac ( const string& ifname, Mac& mac)

ifmgr_0_1_get_configured_mac

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_mtu ( const string& ifname, uint32_t& mtu)

ifmgr_0_1_get_configured_mtu

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_vif_enabled ( const string& ifname, const string& vif, bool& enabled)

ifmgr_0_1_get_configured_vif_enabled

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_prefix4 ( const string& ifname, const string& vif, const IPv4& address, uint32_t& prefix_len)

ifmgr_0_1_get_configured_prefix4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_broadcast4 ( const string& ifname, const string& vif, const IPv4& address, IPv4& broadcast)

ifmgr_0_1_get_configured_broadcast4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_endpoint4 ( const string& ifname, const string& vif, const IPv4& address, IPv4& endpoint)

ifmgr_0_1_get_configured_endpoint4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_prefix6 ( const string& ifname, const string& vif, const IPv6& address, uint32_t& prefix_len)

ifmgr_0_1_get_configured_prefix6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_endpoint6 ( const string& ifname, const string& vif, const IPv6& address, IPv6& endpoint)

ifmgr_0_1_get_configured_endpoint6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_start_transaction ( uint32_t& tid)

ifmgr_0_1_start_transaction

[protected pure virtual]

XrlCmdError  ifmgr_0_1_commit_transaction ( const uint32_t& tid)

ifmgr_0_1_commit_transaction

[protected pure virtual]

XrlCmdError  ifmgr_0_1_abort_transaction ( const uint32_t& tid)

ifmgr_0_1_abort_transaction

[protected pure virtual]

XrlCmdError  ifmgr_0_1_create_interface ( const uint32_t& tid, const string& ifname)

ifmgr_0_1_create_interface

[protected pure virtual]

XrlCmdError  ifmgr_0_1_delete_interface ( const uint32_t& tid, const string& ifname)

ifmgr_0_1_delete_interface

[protected pure virtual]

XrlCmdError  ifmgr_0_1_configure_interface_from_system ( const uint32_t& tid, const string& ifname)

ifmgr_0_1_configure_interface_from_system

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Implicitly configure an interface within the FEA by using information from the underlying system.

Parameters:

tidthe transaction ID.
ifnamethe name of the interface to configure.
XrlCmdError  ifmgr_0_1_set_interface_enabled ( const uint32_t& tid, const string& ifname, const bool& enabled)

ifmgr_0_1_set_interface_enabled

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_mac ( const uint32_t& tid, const string& ifname, const Mac& mac)

ifmgr_0_1_set_mac

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_mtu ( const uint32_t& tid, const string& ifname, const uint32_t& mtu)

ifmgr_0_1_set_mtu

[protected pure virtual]

XrlCmdError  ifmgr_0_1_create_vif ( const uint32_t& tid, const string& ifname, const string& vif)

ifmgr_0_1_create_vif

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Create a vif

Parameters:

ifnamethe name of the physical interface associated with the new vif.
vifname for new vif, must be unique across all the vifs in the system.
XrlCmdError  ifmgr_0_1_delete_vif ( const uint32_t& tid, const string& ifname, const string& vif)

ifmgr_0_1_delete_vif

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_vif_enabled ( const uint32_t& tid, const string& ifname, const string& vif, const bool& enabled)

ifmgr_0_1_set_vif_enabled

[protected pure virtual]

XrlCmdError  ifmgr_0_1_create_address4 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv4& address)

ifmgr_0_1_create_address4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_delete_address4 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv4& address)

ifmgr_0_1_delete_address4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_address_enabled4 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv4& address, const bool& enabled)

ifmgr_0_1_set_address_enabled4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_address_enabled4 ( const string& ifname, const string& vif, const IPv4& address, bool& enabled)

ifmgr_0_1_get_configured_address_enabled4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_prefix4 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv4& address, const uint32_t& prefix_len)

ifmgr_0_1_set_prefix4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_broadcast4 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv4& address, const IPv4& broadcast)

ifmgr_0_1_set_broadcast4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_endpoint4 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv4& address, const IPv4& endpoint)

ifmgr_0_1_set_endpoint4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_create_address6 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv6& address)

ifmgr_0_1_create_address6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_delete_address6 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv6& address)

ifmgr_0_1_delete_address6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_address_enabled6 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv6& address, const bool& enabled)

ifmgr_0_1_set_address_enabled6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_configured_address_enabled6 ( const string& ifname, const string& vif, const IPv6& address, bool& enabled)

ifmgr_0_1_get_configured_address_enabled6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_prefix6 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv6& address, const uint32_t& prefix_len)

ifmgr_0_1_set_prefix6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_set_endpoint6 ( const uint32_t& tid, const string& ifname, const string& vif, const IPv6& address, const IPv6& endpoint)

ifmgr_0_1_set_endpoint6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_register_client ( const string& clientname)

ifmgr_0_1_register_client

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Register network interface observer for configured interfaces.

Parameters:

clientnamename of xrl entity supporting fea_ifmgr_client.xif methods.
XrlCmdError  ifmgr_0_1_unregister_client ( const string& clientname)

ifmgr_0_1_unregister_client

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Unregister network interface observer for configured interfaces. This method is not strictly necessary, the fea will remove the interface observer from its list of known observers if interface update XRLs fail.

XrlCmdError  ifmgr_0_1_get_system_interface_names ( XrlAtomList& ifnames)

ifmgr_0_1_get_system_interface_names

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_vif_names ( const string& ifname, XrlAtomList& vifs)

ifmgr_0_1_get_system_vif_names

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_vif_flags ( const string& ifname, const string& vif, bool& enabled, bool& broadcast, bool& loopback, bool& point_to_point, bool& multicast)

ifmgr_0_1_get_system_vif_flags

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_vif_pif_index ( const string& ifname, const string& vif, uint32_t& pif_index)

ifmgr_0_1_get_system_vif_pif_index

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_vif_addresses4 ( const string& ifname, const string& vif, XrlAtomList& addresses)

ifmgr_0_1_get_system_vif_addresses4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_address_flags4 ( const string& ifname, const string& vif, const IPv4& address, bool& enabled, bool& broadcast, bool& loopback, bool& point_to_point, bool& multicast)

ifmgr_0_1_get_system_address_flags4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_vif_addresses6 ( const string& ifname, const string& vif, XrlAtomList& addresses)

ifmgr_0_1_get_system_vif_addresses6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_address_flags6 ( const string& ifname, const string& vif, const IPv6& address, bool& enabled, bool& loopback, bool& point_to_point, bool& multicast)

ifmgr_0_1_get_system_address_flags6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_interface_enabled ( const string& ifname, bool& enabled)

ifmgr_0_1_get_system_interface_enabled

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_mac ( const string& ifname, Mac& mac)

ifmgr_0_1_get_system_mac

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_mtu ( const string& ifname, uint32_t& mtu)

ifmgr_0_1_get_system_mtu

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_vif_enabled ( const string& ifname, const string& vif, bool& enabled)

ifmgr_0_1_get_system_vif_enabled

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_prefix4 ( const string& ifname, const string& vif, const IPv4& address, uint32_t& prefix_len)

ifmgr_0_1_get_system_prefix4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_broadcast4 ( const string& ifname, const string& vif, const IPv4& address, IPv4& broadcast)

ifmgr_0_1_get_system_broadcast4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_endpoint4 ( const string& ifname, const string& vif, const IPv4& address, IPv4& endpoint)

ifmgr_0_1_get_system_endpoint4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_prefix6 ( const string& ifname, const string& vif, const IPv6& address, uint32_t& prefix_len)

ifmgr_0_1_get_system_prefix6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_endpoint6 ( const string& ifname, const string& vif, const IPv6& address, IPv6& endpoint)

ifmgr_0_1_get_system_endpoint6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_address_enabled4 ( const string& ifname, const string& vif, const IPv4& address, bool& enabled)

ifmgr_0_1_get_system_address_enabled4

[protected pure virtual]

XrlCmdError  ifmgr_0_1_get_system_address_enabled6 ( const string& ifname, const string& vif, const IPv6& address, bool& enabled)

ifmgr_0_1_get_system_address_enabled6

[protected pure virtual]

XrlCmdError  ifmgr_0_1_register_system_interfaces_client ( const string& clientname)

ifmgr_0_1_register_system_interfaces_client

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Register network interface observer for all system interfaces.

Parameters:

clientnamename of xrl entity supporting fea_ifmgr_client.xif methods.
XrlCmdError  ifmgr_0_1_unregister_system_interfaces_client ( const string& clientname)

ifmgr_0_1_unregister_system_interfaces_client

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Unregister network interface observer for all system interfaces. This method is not strictly necessary, the fea will remove the interface observer from its list of known observers if interface update XRLs fail.

XrlCmdError  ifmgr_replicator_0_1_register_ifmgr_mirror ( const string& clientname)

ifmgr_replicator_0_1_register_ifmgr_mirror

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Register remote mirror of interface state.

XrlCmdError  ifmgr_replicator_0_1_unregister_ifmgr_mirror ( const string& clientname)

ifmgr_replicator_0_1_unregister_ifmgr_mirror

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Register remote mirror of interface state.

XrlCmdError  fti_0_2_start_transaction ( uint32_t& tid)

fti_0_2_start_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Start transaction.

Parameters:

tidthe transaction ID to use for this transaction.
XrlCmdError  fti_0_2_commit_transaction ( const uint32_t& tid)

fti_0_2_commit_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Commit transaction.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  fti_0_2_abort_transaction ( const uint32_t& tid)

fti_0_2_abort_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Abort transaction.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  fti_0_2_add_entry4 ( const uint32_t& tid, const IPv4Net& dst, const IPv4& gateway, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin)

fti_0_2_add_entry4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add a routing entry.

Parameters:

tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  fti_0_2_add_entry6 ( const uint32_t& tid, const IPv6Net& dst, const IPv6& gateway, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& admin_distance, const string& protocol_origin)

fti_0_2_add_entry6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add a routing entry.

Parameters:

tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  fti_0_2_delete_entry4 ( const uint32_t& tid, const IPv4Net& dst)

fti_0_2_delete_entry4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a routing entry.

Parameters:

tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.
XrlCmdError  fti_0_2_delete_entry6 ( const uint32_t& tid, const IPv6Net& dst)

fti_0_2_delete_entry6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a routing entry.

Parameters:

tidthe transaction ID of this transaction.
dstthe destination subnet address of the entry.
XrlCmdError  fti_0_2_delete_all_entries ( const uint32_t& tid)

fti_0_2_delete_all_entries

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete all routing entries for all address families.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  fti_0_2_delete_all_entries4 ( const uint32_t& tid)

fti_0_2_delete_all_entries4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete all routing entries for the IPv4 address family.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  fti_0_2_delete_all_entries6 ( const uint32_t& tid)

fti_0_2_delete_all_entries6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Delete all routing entries for the IPv6 address family.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  fti_0_2_lookup_route4 ( const IPv4& dst, IPv4Net& netmask, IPv4& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_route4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup a route for a destination host address.

Parameters:

dstthe destination host address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  fti_0_2_lookup_route6 ( const IPv6& dst, IPv6Net& netmask, IPv6& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_route6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup a route for a destination host address.

Parameters:

dstthe destination host address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  fti_0_2_lookup_entry4 ( const IPv4Net& dst, IPv4& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_entry4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup a route for a destination subnet address.

Parameters:

dstthe destination subnet address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  fti_0_2_lookup_entry6 ( const IPv6Net& dst, IPv6& gateway, string& ifname, string& vifname, uint32_t& metric, uint32_t& admin_distance, string& protocol_origin)

fti_0_2_lookup_entry6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Lookup a route for a destination subnet address.

Parameters:

dstthe destination subnet address to lookup.
gatewaythe address of the next-hop router toward dst.
ifnamethe name of the physical interface toward dst.
vifnamethe name of the virtual interface toward dst.
metricthe routing metric toward dst.
admin_distancethe administratively defined distance toward dst.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  fti_0_2_have_ipv4 ( bool& result)

fti_0_2_have_ipv4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Test if the underlying system supports IPv4.

Parameters:

resulttrue if the underlying system supports IPv4, otherwise false.
XrlCmdError  fti_0_2_have_ipv6 ( bool& result)

fti_0_2_have_ipv6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Test if the underlying system supports IPv6.

Parameters:

resulttrue if the underlying system supports IPv4, otherwise false.
XrlCmdError  fti_0_2_get_unicast_forwarding_enabled4 ( bool& enabled)

fti_0_2_get_unicast_forwarding_enabled4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

enabledif true, then the IPv4 unicast forwarding is enabled, otherwise is disabled.
XrlCmdError  fti_0_2_get_unicast_forwarding_enabled6 ( bool& enabled)

fti_0_2_get_unicast_forwarding_enabled6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

enabledif true, then the IPv6 unicast forwarding is enabled, otherwise is disabled.
XrlCmdError  fti_0_2_set_unicast_forwarding_enabled4 ( const bool& enabled)

fti_0_2_set_unicast_forwarding_enabled4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

enabledif true, then enable IPv4 unicast forwarding, otherwise disable it.
XrlCmdError  fti_0_2_set_unicast_forwarding_enabled6 ( const bool& enabled)

fti_0_2_set_unicast_forwarding_enabled6

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

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

Parameters:

enabledif true, then enable IPv6 unicast forwarding, otherwise disable it.
XrlCmdError  redist_transaction4_0_1_start_transaction ( uint32_t& tid)

redist_transaction4_0_1_start_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Start transaction.

Parameters:

tidthe transaction ID to use for this transaction.
XrlCmdError  redist_transaction4_0_1_commit_transaction ( const uint32_t& tid)

redist_transaction4_0_1_commit_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Commit transaction.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  redist_transaction4_0_1_abort_transaction ( const uint32_t& tid)

redist_transaction4_0_1_abort_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Abort transaction.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  redist_transaction4_0_1_add_route ( const uint32_t& tid, const IPv4Net& dst, const IPv4& nh, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& ad, const string& cookie, const string& protocol_origin)

redist_transaction4_0_1_add_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a routing entry.

Parameters:

tidthe transaction ID of this transaction.
dstdestination network.
nhnexthop router address.
ifnameinterface name associated with nexthop.
vifnamevirtual interface name with nexthop.
metricorigin routing protocol metric for route.
adadministrative distance of origin routing protocol.
cookievalue set be requestor to identify redistribution source. Typical value is the originating protocol name.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  redist_transaction4_0_1_delete_route ( const uint32_t& tid, const IPv4Net& network, const string& cookie)

redist_transaction4_0_1_delete_route

[protected pure virtual]

XrlCmdError  redist_transaction6_0_1_start_transaction ( uint32_t& tid)

redist_transaction6_0_1_start_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Start transaction.

Parameters:

tidthe transaction ID to use for this transaction.
XrlCmdError  redist_transaction6_0_1_commit_transaction ( const uint32_t& tid)

redist_transaction6_0_1_commit_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Commit transaction.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  redist_transaction6_0_1_abort_transaction ( const uint32_t& tid)

redist_transaction6_0_1_abort_transaction

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Abort transaction.

Parameters:

tidthe transaction ID of this transaction.
XrlCmdError  redist_transaction6_0_1_add_route ( const uint32_t& tid, const IPv6Net& dst, const IPv6& nh, const string& ifname, const string& vifname, const uint32_t& metric, const uint32_t& ad, const string& cookie, const string& protocol_origin)

redist_transaction6_0_1_add_route

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Add/delete a routing entry.

Parameters:

tidthe transaction ID of this transaction.
dstdestination network.
nhnexthop router address.
ifnameinterface name associated with nexthop.
vifnamevirtual interface name with nexthop.
metricorigin routing protocol metric for route.
adadministrative distance of origin routing protocol.
cookievalue set be requestor to identify redistribution source. Typical value is the originating protocol name.
protocol_originthe name of the protocol that originated this entry.
XrlCmdError  redist_transaction6_0_1_delete_route ( const uint32_t& tid, const IPv6Net& network, const string& cookie)

redist_transaction6_0_1_delete_route

[protected pure virtual]

XrlCmdError  raw_packet_0_1_send4 ( const IPv4& src_address, const IPv4& dst_address, const string& vif_name, const uint32_t& proto, const uint32_t& ttl, const uint32_t& tos, const vector<uint8_t>& options, const vector<uint8_t>& payload)

raw_packet_0_1_send4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Send a packet on a raw socket.

XrlCmdError  raw_packet_0_1_send_raw4 ( const string& vif_name, const vector<uint8_t>& packet)

raw_packet_0_1_send_raw4

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Send raw packet. Checksum is computed and applied before transmission. All the fields within the IPv4 header must be in network order.

XrlCmdError  raw_packet_0_1_register_vif_receiver ( const string& router_name, const string& if_name, const string& vif_name, const uint32_t& proto)

raw_packet_0_1_register_vif_receiver

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Register to receive packets. The receiver is expected to support raw_socket_client/0.1 interface.

XrlCmdError  raw_packet_0_1_unregister_vif_receiver ( const string& router_name, const string& if_name, const string& vif_name, const uint32_t& proto)

raw_packet_0_1_unregister_vif_receiver

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Unregister stop receiving packets.

Parameters:

protoProtocol number that the receiver is interested in.
XrlCmdError  socket4_locator_0_1_find_socket_server_for_addr ( const IPv4& local_addr, string& xrl_target)

socket4_locator_0_1_find_socket_server_for_addr

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Find suitable socket serving Xrl Target for a particular interface address.

XrlCmdError  socket6_locator_0_1_find_socket_server_for_addr ( const IPv6& local_addr, string& xrl_target)

socket6_locator_0_1_find_socket_server_for_addr

[protected pure virtual]

Pure-virtual function that needs to be implemented to:

Find suitable socket serving Xrl Target for a particular interface address.


Generated by: pavlin on possum.icir.org on Thu Jul 8 23:48:20 2004, using kdoc $.