diff options
| author | IWASE Yusuke <iwase.yusuke0@gmail.com> | 2016-11-25 17:02:57 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2016-12-10 22:00:49 +0900 |
| commit | f8fa7b68dbe3df653e6871061fd509d324e48989 (patch) | |
| tree | 44da172cb13dcfe66f21f707db2ddf48c6b422bb /doc | |
| parent | d993e430ef0d71c88234e216eb74117afa73bf3b (diff) | |
doc: Add MRT file library reference
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/library.rst | 1 | ||||
| -rw-r--r-- | doc/source/library_mrt.rst | 28 |
2 files changed, 29 insertions, 0 deletions
diff --git a/doc/source/library.rst b/doc/source/library.rst index ccdcae30..ff280415 100644 --- a/doc/source/library.rst +++ b/doc/source/library.rst @@ -13,4 +13,5 @@ Ryu provides some useful library for your network applications. library_of_config.rst library_bgp_speaker.rst library_bgp_speaker_ref.rst + library_mrt.rst library_ovsdb_manager.rst diff --git a/doc/source/library_mrt.rst b/doc/source/library_mrt.rst new file mode 100644 index 00000000..e5fccb24 --- /dev/null +++ b/doc/source/library_mrt.rst @@ -0,0 +1,28 @@ +**************** +MRT file library +**************** + +Introduction +============ + +Ryu MRT file library helps you to read/write MRT +(Multi-Threaded Routing Toolkit) Routing Information Export Format +[`RFC6396`_]. + +.. _RFC6396: https://tools.ietf.org/html/rfc6396 + +Reading MRT file +================ + +For loading the routing information contained in MRT files, you can use +mrtlib.Reader. + +.. autoclass:: ryu.lib.mrtlib.Reader + +Writing MRT file +================ + +For dumping the routing information which your RyuApp generated, you can use +mrtlib.Writer. + +.. autoclass:: ryu.lib.mrtlib.Writer |