openstack/deb-ryu
Code Issues Proposed changes

doc: Add MRT file library reference

Browse Source 
Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
IWASE Yusuke 2016-11-25 17:02:57 +09:00 committed by FUJITA Tomonori
parent d993e430ef
commit f8fa7b68db
2 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/library.rst
View File

@ -13,4 +13,5 @@ Ryu provides some useful library for your network applications.
library_of_config.rst library_of_config.rst
library_bgp_speaker.rst library_bgp_speaker.rst
library_bgp_speaker_ref.rst library_bgp_speaker_ref.rst
library_mrt.rst
library_ovsdb_manager.rst library_ovsdb_manager.rst

28
doc/source/library_mrt.rst Normal file
View File

@ -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