summaryrefslogtreecommitdiffhomepage
path: root/doc/source/library_bgp_speaker_ref.rst
diff options
context:
space:
mode:
authorFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2014-06-13 08:05:25 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2014-06-13 08:05:25 +0900
commit5474bf214c22ca459719ddbe786a3c9a8f967757 (patch)
tree8734b1fbee081e4fbee928504f7a392a176a4ee6 /doc/source/library_bgp_speaker_ref.rst
parent6fbd67e29b071e5e63eff832e9cb8b1e7da0ea92 (diff)
bgp: add bgpspaker module for non Ryu application usage
This enables you to use Ryu BGP feature as 'bgp speaker' python library, that is, without ryu-manager, RPC API, REST API, or other Ryu stuff, you can use Ryu BGP feature in your python application (just import bgpspeaker.py). The sample code and the API reference docs are included too. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> Reviewed-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Diffstat (limited to 'doc/source/library_bgp_speaker_ref.rst')
-rw-r--r--doc/source/library_bgp_speaker_ref.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/library_bgp_speaker_ref.rst b/doc/source/library_bgp_speaker_ref.rst
new file mode 100644
index 00000000..493f322e
--- /dev/null
+++ b/doc/source/library_bgp_speaker_ref.rst
@@ -0,0 +1,12 @@
+*********************************
+BGP speaker library API Reference
+*********************************
+
+BGPSpeaker class
+================
+
+.. autoclass:: ryu.services.protocols.bgp.bgpspeaker.BGPSpeaker
+ :members:
+
+.. autoclass:: ryu.services.protocols.bgp.bgpspeaker.EventPrefix
+ :members: