summaryrefslogtreecommitdiffstats
path: root/docs/interfacing/libmemif/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/interfacing/libmemif/index.rst')
-rw-r--r--docs/interfacing/libmemif/index.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/interfacing/libmemif/index.rst b/docs/interfacing/libmemif/index.rst
new file mode 100644
index 00000000000..4d4b24f36ce
--- /dev/null
+++ b/docs/interfacing/libmemif/index.rst
@@ -0,0 +1,24 @@
+.. _libmemif_index:
+
+Memif library (libmemif)
+========================
+
+Shared memory packet interface (memif) provides high performance packet
+transmit and receive between user application and Vector Packet
+Processing (VPP) or multiple user applications. Using libmemif, user
+application can create shared memory interface in master or slave mode
+and connect to VPP or another application using libmemif. Once the
+connection is established, user application can receive or transmit
+packets using libmemif API.
+
+.. figure:: /_images/libmemif_architecture.png
+ :alt: Architecture
+
+.. toctree::
+ :maxdepth: 2
+
+ libmemif_doc
+ buildinstructions_doc
+ example_setup_doc
+ examples_doc
+ gettingstarted_doc