docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / interfacing / libmemif / index.rst
1 .. _libmemif_index:
2
3 Memif library (libmemif)
4 ========================
5
6 Shared memory packet interface (memif) provides high performance packet
7 transmit and receive between user application and Vector Packet
8 Processing (VPP) or multiple user applications. Using libmemif, user
9 application can create shared memory interface in master or slave mode
10 and connect to VPP or another application using libmemif. Once the
11 connection is established, user application can receive or transmit
12 packets using libmemif API.
13
14 .. figure:: /_images/libmemif_architecture.png
15    :alt: Architecture
16
17 .. toctree::
18     :maxdepth: 2
19
20     libmemif_doc
21     buildinstructions_doc
22     example_setup_doc
23     examples_doc
24     gettingstarted_doc