|
|
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 ()
| RibManager |
RibManager constructor
Parameters:
eventloop | the event loop to user. |
xrl_std_router | the XRL router to use. |
~RibManager ()
| ~RibManager |
RibManager destructor
int start ()
| start |
Start operation.
Returns: XORP_OK on success, otherwise XORP_ERROR.
Reimplemented from ProtoState.
int stop ()
| stop |
Stop operation.
Gracefully stop the RIB.
Returns: XORP_OK on success, otherwise XORP_ERROR.
Reimplemented from ProtoState.
bool status_updater ()
| status_updater |
Periodic Status Update
Returns: true to reschedule next status check.
ProcessStatus status (string& reason)
| status |
[const]
Check status of RIB process.
Returns: process status code
int new_vif (const string& vifname, const Vif& vif, string& err)
| new_vif |
int delete_vif (const string& vifname, string& err)
| delete_vif |
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. |
int add_vif_addr (const string& vifname,
const IPv4& addr,
const IPNet<IPv4>& net,
string& err)
| add_vif_addr |
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. |
int delete_vif_addr (const string& vifname,
const IPv4& addr,
string& err)
| delete_vif_addr |
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. |
int add_vif_addr (const string& vifname,
const IPv6& addr,
const IPNet<IPv6>& net,
string& err)
| add_vif_addr |
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. |
int delete_vif_addr (const string& vifname,
const IPv6& addr,
string& err)
| delete_vif_addr |
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. |
RibClient * find_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| find_rib_client |
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.
int add_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| add_rib_client |
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.
int delete_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| delete_rib_client |
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.
int enable_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| enable_rib_client |
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.
int disable_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| disable_rib_client |
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.
int no_fea ()
| no_fea |
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.
void make_errors_fatal ()
| make_errors_fatal |
Make some errors we'd normally mask fatal. Should be used for testing only.
void register_interest_in_target (const string& tgt_class)
| register_interest_in_target |
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. |
void register_interest_in_target_done (const XrlError& e)
| register_interest_in_target_done |
Called in response to registering interest in an XRL target
Parameters:
e | XRL Response code. |
void target_death (const string& tgt_class, const string& tgt_instance)
| target_death |
RibManager (EventLoop& eventloop, XrlStdRouter& xrl_std_router)
| RibManager |
RibManager constructor
Parameters:
eventloop | the event loop to user. |
xrl_std_router | the XRL router to use. |
~RibManager ()
| ~RibManager |
RibManager destructor
int start ()
| start |
Start operation.
Returns: XORP_OK on success, otherwise XORP_ERROR.
Reimplemented from ProtoState.
int stop ()
| stop |
Stop operation.
Gracefully stop the RIB.
Returns: XORP_OK on success, otherwise XORP_ERROR.
Reimplemented from ProtoState.
bool status_updater ()
| status_updater |
Periodic Status Update
Returns: true to reschedule next status check.
ProcessStatus status (string& reason)
| status |
[const]
Check status of RIB process.
Returns: process status code
int new_vif (const string& vifname, const Vif& vif, string& err)
| new_vif |
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. |
int delete_vif (const string& vifname, string& err)
| delete_vif |
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. |
int add_vif_addr (const string& vifname,
const IPv4& addr,
const IPNet<IPv4>& net,
string& err)
| add_vif_addr |
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. |
int delete_vif_addr (const string& vifname,
const IPv4& addr,
string& err)
| delete_vif_addr |
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. |
int add_vif_addr (const string& vifname,
const IPv6& addr,
const IPNet<IPv6>& net,
string& err)
| add_vif_addr |
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. |
int delete_vif_addr (const string& vifname,
const IPv6& addr,
string& err)
| delete_vif_addr |
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. |
RibClient * find_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| find_rib_client |
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.
int add_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| add_rib_client |
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.
int delete_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| delete_rib_client |
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.
int enable_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| enable_rib_client |
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.
int disable_rib_client (const string& target_name, int family,
bool unicast, bool multicast)
| disable_rib_client |
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.
int no_fea ()
| no_fea |
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.
void make_errors_fatal ()
| make_errors_fatal |
Make some errors we'd normally mask fatal. Should be used for testing only.
void register_interest_in_target (const string& tgt_class)
| register_interest_in_target |
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. |
void register_interest_in_target_done (const XrlError& e)
| register_interest_in_target_done |
Called in response to registering interest in an XRL target
Parameters:
e | XRL Response code. |
void target_death (const string& tgt_class, const string& tgt_instance)
| target_death |
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. |
Generated by: pavlin on possum.icir.org on Thu Nov 6 23:47:07 2003, using kdoc 2.0a54+XORP. |