diff options
Diffstat (limited to 'doc/source/library_mrt.rst')
-rw-r--r-- | doc/source/library_mrt.rst | 28 |
1 files changed, 28 insertions, 0 deletions
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 |