diff options
Diffstat (limited to 'docs/interfacing/libmemif')
| l--------- | docs/interfacing/libmemif/buildinstructions_doc.rst | 1 | ||||
| l--------- | docs/interfacing/libmemif/example_setup_doc.rst | 1 | ||||
| l--------- | docs/interfacing/libmemif/examples_doc.rst | 1 | ||||
| l--------- | docs/interfacing/libmemif/gettingstarted_doc.rst | 1 | ||||
| -rw-r--r-- | docs/interfacing/libmemif/index.rst | 24 | ||||
| l--------- | docs/interfacing/libmemif/libmemif_doc.rst | 1 |
6 files changed, 29 insertions, 0 deletions
diff --git a/docs/interfacing/libmemif/buildinstructions_doc.rst b/docs/interfacing/libmemif/buildinstructions_doc.rst new file mode 120000 index 00000000000..9a5cf40f593 --- /dev/null +++ b/docs/interfacing/libmemif/buildinstructions_doc.rst @@ -0,0 +1 @@ +../../../extras/libmemif/docs/buildinstructions_doc.rst
\ No newline at end of file diff --git a/docs/interfacing/libmemif/example_setup_doc.rst b/docs/interfacing/libmemif/example_setup_doc.rst new file mode 120000 index 00000000000..79e7dcfd672 --- /dev/null +++ b/docs/interfacing/libmemif/example_setup_doc.rst @@ -0,0 +1 @@ +../../../extras/libmemif/examples/example_setup_doc.rst
\ No newline at end of file diff --git a/docs/interfacing/libmemif/examples_doc.rst b/docs/interfacing/libmemif/examples_doc.rst new file mode 120000 index 00000000000..0f93bab5e58 --- /dev/null +++ b/docs/interfacing/libmemif/examples_doc.rst @@ -0,0 +1 @@ +../../../extras/libmemif/examples/examples_doc.rst
\ No newline at end of file diff --git a/docs/interfacing/libmemif/gettingstarted_doc.rst b/docs/interfacing/libmemif/gettingstarted_doc.rst new file mode 120000 index 00000000000..f9f20f6c31a --- /dev/null +++ b/docs/interfacing/libmemif/gettingstarted_doc.rst @@ -0,0 +1 @@ +../../../extras/libmemif/docs/gettingstarted_doc.rst
\ No newline at end of file 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 diff --git a/docs/interfacing/libmemif/libmemif_doc.rst b/docs/interfacing/libmemif/libmemif_doc.rst new file mode 120000 index 00000000000..394e83cd4e0 --- /dev/null +++ b/docs/interfacing/libmemif/libmemif_doc.rst @@ -0,0 +1 @@ +../../../extras/libmemif/libmemif_doc.rst
\ No newline at end of file |