diff options
author | Martin Mares <mj@ucw.cz> | 2000-06-04 16:15:37 +0000 |
---|---|---|
committer | Martin Mares <mj@ucw.cz> | 2000-06-04 16:15:37 +0000 |
commit | 3b31c538333156770ddb74a7a27f271784745144 (patch) | |
tree | 2bb7a5614cd4ea2810cf5ab94b5ae95f267e582f /proto/pipe/pipe.c | |
parent | 2a863dd6e18a43fe3de5b1f3651e816f6fc27bb1 (diff) |
Documented all the trivial protocols.
Diffstat (limited to 'proto/pipe/pipe.c')
-rw-r--r-- | proto/pipe/pipe.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/proto/pipe/pipe.c b/proto/pipe/pipe.c index 3f41faaf..f7ba866b 100644 --- a/proto/pipe/pipe.c +++ b/proto/pipe/pipe.c @@ -6,6 +6,18 @@ * Can be freely distributed and used under the terms of the GNU GPL. */ +/** + * DOC: Pipe + * + * The Pipe protocol is very simple. It just connects to two routing tables + * using proto_add_announce_hook() and whenever it receives a rt_notify() + * about a change in one of the tables, it converts it to a rte_update() + * in the other one. + * + * To avoid pipe loops, Pipe keeps a `being updated' flag in each routing + * table. + */ + #undef LOCAL_DEBUG #include "nest/bird.h" |