summaryrefslogtreecommitdiffhomepage
path: root/doc/source/library_pcap.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/library_pcap.rst')
-rw-r--r--doc/source/library_pcap.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/source/library_pcap.rst b/doc/source/library_pcap.rst
new file mode 100644
index 00000000..2eb3fe5e
--- /dev/null
+++ b/doc/source/library_pcap.rst
@@ -0,0 +1,27 @@
+*****************
+PCAP file library
+*****************
+
+Introduction
+============
+
+Ryu PCAP file library helps you to read/write PCAP file which file
+format are described in `The Wireshark Wiki`_.
+
+.. _The Wireshark Wiki: https://wiki.wireshark.org/Development/LibpcapFileFormat
+
+Reading PCAP file
+=================
+
+For loading the packet data containing in PCAP files, you can use
+pcaplib.Reader.
+
+.. autoclass:: ryu.lib.pcaplib.Reader
+
+Writing PCAP file
+=================
+
+For dumping the packet data which your RyuApp received, you can use
+pcaplib.Writer.
+
+.. autoclass:: ryu.lib.pcaplib.Writer