class RibManager Main top-level class containing RIBs and main eventloop. More... Definition #include <dummy_rib_manager.hh> Inherits ProtoState (libproto) [public ], ProtoState (libproto) [public ] List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  RibManager ()
•  ~RibManager ()
• int  start ()
• int  stop ()
• bool  status_updater ()
• ProcessStatus  status (string& reason) const
• int  new_vif (const string& vifname, const Vif& vif, string& err)
• int  delete_vif (const string& vifname, string& err)
• int  add_vif_addr (const string& vifname, const IPv4& addr, const IPNet<IPv4>& net, string& err)
• int  delete_vif_addr (const string& vifname, const IPv4& addr, string& err)
• int  add_vif_addr (const string& vifname, const IPv6& addr, const IPNet<IPv6>& net, string& err)
• int  delete_vif_addr (const string& vifname, const IPv6& addr, string& err)
• RibClient * find_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  add_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  delete_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  enable_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  disable_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  no_fea ()
• void  make_errors_fatal ()
• void  register_interest_in_target (const string& tgt_class)
• void  register_interest_in_target_done (const XrlError& e)
• void  target_death (const string& tgt_class, const string& tgt_instance)
•  RibManager (EventLoop& eventloop, XrlStdRouter& xrl_std_router)
•  ~RibManager ()
• int  start ()
• int  stop ()
• bool  status_updater ()
• ProcessStatus  status (string& reason) const
• int  new_vif (const string& vifname, const Vif& vif, string& err)
• int  delete_vif (const string& vifname, string& err)
• int  add_vif_addr (const string& vifname, const IPv4& addr, const IPNet<IPv4>& net, string& err)
• int  delete_vif_addr (const string& vifname, const IPv4& addr, string& err)
• int  add_vif_addr (const string& vifname, const IPv6& addr, const IPNet<IPv6>& net, string& err)
• int  delete_vif_addr (const string& vifname, const IPv6& addr, string& err)
• RibClient * find_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  add_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  delete_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  enable_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  disable_rib_client (const string& target_name, int family, bool unicast, bool multicast)
• int  no_fea ()
• void  make_errors_fatal ()
• void  register_interest_in_target (const string& tgt_class)
• void  register_interest_in_target_done (const XrlError& e)
• void  target_death (const string& tgt_class, const string& tgt_instance)

Detailed Description

The single RibManager class instance is the top-level class in the RIB process from which everything else is built and run. It contains the four RIBs for IPv4 unicast routes, IPv4 multicast routes, IPv6 unicast routes and IPv6 multicast routes. It also contains the RIB's main eventloop.

RibManager constructor

Parameters:

eventloop	the event loop to user.
xrl_std_router	the XRL router to use.

RibManager destructor

Start operation.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoState.

Stop operation.

Gracefully stop the RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoState.

Periodic Status Update

Returns: true to reschedule next status check.

[const]

Check status of RIB process.

Returns: process status code

delete_vif is called to inform all the RIBs that a virtual interface that they previously knew about has been deleted.

Parameters:

vifname	the name of the VIF that was deleted.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

add_vif_addr is called to inform all the RIBs that a new IPv4 address has been added to a virtual interface.

Parameters:

vifname	the name of the VIF that the address was added to.
addr	the new address.
net	the subnet (masked address) that the new address resides on.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

delete_vif_addr is called to inform all the RIBs that an IPv4 address that they previously know about has been deleted from a specific VIF.

Parameters:

vifname	the name of the VIF that the address was deleted from.
addr	the address that was deleted.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

add_vif_addr is called to inform all the RIBs that a new IPv6 address has been added to a virtual interface.

Parameters:

vifname	the name of the VIF that the address was added to.
addr	the new address.
net	the subnet (masked address) that the new address resides on.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

delete_vif_addr is called to inform all the RIBs that an IPv6 address that they previously know about has been deleted from a specific VIF.

Parameters:

vifname	the name of the VIF that the address was deleted from.
addr	the address that was deleted.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

Find a RIB client.

Find a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: a pointer to a valid RibClient if found, otherwise NULL.

Add a RIB client.

Add a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete a RIB client.

Delete a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Enable a RIB client.

Enable a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Disable a RIB client.

Disable a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Don't try to communicate with the FEA.

Note that this method will be obsoleted in the future, and will be replaced with cleaner interface.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Make some errors we'd normally mask fatal. Should be used for testing only.

Register Interest in an XRL target so we can monitor process births and deaths and clean up appropriately when things die.

Parameters:

tgt_class

the XRL Target Class we're interested in.

Called in response to registering interest in an XRL target

Parameters:

e	XRL Response code.

RibManager constructor

Parameters:

eventloop	the event loop to user.
xrl_std_router	the XRL router to use.

RibManager destructor

Start operation.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoState.

Stop operation.

Gracefully stop the RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoState.

Periodic Status Update

Returns: true to reschedule next status check.

[const]

Check status of RIB process.

Returns: process status code

new_vif is called to inform all the RIBs that a new virtual interface has been created.

Parameters:

vifname	the name of the new VIF.
vif	the Vif class instance holding information about the new VIF.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

delete_vif is called to inform all the RIBs that a virtual interface that they previously knew about has been deleted.

Parameters:

vifname	the name of the VIF that was deleted.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

add_vif_addr is called to inform all the RIBs that a new IPv4 address has been added to a virtual interface.

Parameters:

vifname	the name of the VIF that the address was added to.
addr	the new address.
net	the subnet (masked address) that the new address resides on.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

delete_vif_addr is called to inform all the RIBs that an IPv4 address that they previously know about has been deleted from a specific VIF.

Parameters:

vifname	the name of the VIF that the address was deleted from.
addr	the address that was deleted.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

add_vif_addr is called to inform all the RIBs that a new IPv6 address has been added to a virtual interface.

Parameters:

vifname	the name of the VIF that the address was added to.
addr	the new address.
net	the subnet (masked address) that the new address resides on.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

delete_vif_addr is called to inform all the RIBs that an IPv6 address that they previously know about has been deleted from a specific VIF.

Parameters:

vifname	the name of the VIF that the address was deleted from.
addr	the address that was deleted.
err	reference to string in which to store the human-readable error message in case anything goes wrong. Used for debugging purposes.

Find a RIB client.

Find a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: a pointer to a valid RibClient if found, otherwise NULL.

Add a RIB client.

Add a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete a RIB client.

Delete a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Enable a RIB client.

Enable a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Disable a RIB client.

Disable a RIB client for a given target name, address family, and unicast/multicast flags.

Parameters:

target_name	the target name of the RIB client.
family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
unicast	true if a client for the unicast RIB.
multicast	true if a client for the multicast RIB.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Don't try to communicate with the FEA.

Note that this method will be obsoleted in the future, and will be replaced with cleaner interface.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Make some errors we'd normally mask fatal. Should be used for testing only.

Register Interest in an XRL target so we can monitor process births and deaths and clean up appropriately when things die.

Parameters:

tgt_class

the XRL Target Class we're interested in.

Called in response to registering interest in an XRL target

Parameters:

e	XRL Response code.

Target Death is called when an XRL target that we've registered an interest in dies.

Parameters:

tgt_class	the XRL Class of the target that died.
tgt_instance	the XRL Class Instance of the target that died.