From f3e931b03fe2839d2f512c37b7be05944078b2e2 Mon Sep 17 00:00:00 2001 From: IWASE Yusuke Date: Mon, 30 May 2016 15:24:44 +0900 Subject: doc: Add PCAP file library reference Signed-off-by: IWASE Yusuke Signed-off-by: FUJITA Tomonori --- doc/source/library_pcap.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/source/library_pcap.rst (limited to 'doc/source/library_pcap.rst') 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 -- cgit v1.2.3