summaryrefslogtreecommitdiff
path: root/nest/proto-hooks.c
diff options
context:
space:
mode:
Diffstat (limited to 'nest/proto-hooks.c')
-rw-r--r--nest/proto-hooks.c15
1 files changed, 13 insertions, 2 deletions
diff --git a/nest/proto-hooks.c b/nest/proto-hooks.c
index 82df5cb7..c30b1070 100644
--- a/nest/proto-hooks.c
+++ b/nest/proto-hooks.c
@@ -179,8 +179,8 @@ void ifa_notify(struct proto *p, unsigned flags, struct ifa *a)
* rt_notify - notify instance about routing table change
* @p: protocol instance
* @net: a network entry
- * @new: new optimal route for the network
- * @old: old optimal route for the network
+ * @new: new route for the network
+ * @old: old route for the network
* @attrs: extended attributes associated with the @new entry
*
* The rt_notify() hook is called to inform the protocol instance about
@@ -188,6 +188,17 @@ void ifa_notify(struct proto *p, unsigned flags, struct ifa *a)
* belonging to network @net being replaced by a new route @new with
* extended attributes @attrs. Either @new or @old or both can be %NULL
* if the corresponding route doesn't exist.
+ *
+ * If the type of route announcement is RA_OPTIMAL, it is an
+ * announcement of optimal route change, @new stores the new optimal
+ * route and @old stores the old optimal route.
+ *
+ * If the type of route announcement is RA_ANY, it is an announcement
+ * of any route change, @new stores the new route and @old stores the
+ * old route from the same protocol.
+ *
+ * @p->accept_ra_types specifies which kind of route announcements
+ * protocol wants to receive.
*/
void rt_notify(struct proto *p, net *net, rte *new, rte *old, ea_list *attrs)
{ DUMMY; }