summaryrefslogtreecommitdiffstats
path: root/src/plugins/quic/quic_doc.md
diff options
context:
space:
mode:
authorNathan Skrzypczak <nathan.skrzypczak@gmail.com>2019-07-29 13:51:31 +0200
committerDave Wallace <dwallacelf@gmail.com>2019-08-05 16:19:54 +0000
commit7858d6e9e2e3aa118638676a202e600fc9668986 (patch)
tree05495064d263a489b7f117ad5da43a8a915276e4 /src/plugins/quic/quic_doc.md
parent09db37a5d40d393c4b9b44da32bc86943d53f8d3 (diff)
docs: Add more quic plugin documentation
Type: docs Change-Id: I0209769f73a46ddad7c2625ad0f774ee2eef43dd Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'src/plugins/quic/quic_doc.md')
-rw-r--r--src/plugins/quic/quic_doc.md38
1 files changed, 0 insertions, 38 deletions
diff --git a/src/plugins/quic/quic_doc.md b/src/plugins/quic/quic_doc.md
deleted file mode 100644
index 6ffd00c5ce7..00000000000
--- a/src/plugins/quic/quic_doc.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# QUIC implementation {#quic_doc}
-
-The quic plugin provides an IETF QUIC protocol implementation. It is based on
-the [quicly](https://github.com/h2o/quicly) library.
-
-This plugin adds the QUIC protocol to VPP's Host Stack. As a result QUIC is
-usable both in internal VPP applications and in external apps.
-
-
-## Maturity level
-Under development: it should mostly work, but has not been thoroughly tested and
-should not be used in production.
-
-
-## Features
- - only bidirectional streams are supported currently.
-
-
-## Getting started
-
-QUIC constructs are exposed as follows:
-
-- QUIC connections and streams are both regular host stack sessions.
-- QUIC connections can be created and destroyed with regular `connect` and
- `close` calls with `TRANSPORT_PROTO_QUIC`.
-- Streams can be opened in a connection by calling `connect`again and passing
- the ID of the connection to which the new stream should belong.
-- Streams can be closed with a regular `close`call.
-- Streams opened by peers can be accepted from the sessions corresponding to
- QUIC connections.
-- Data can ba exchanged by using the regular `send` and `recv` calls on the
- stream sessions.
-
-Example code can be found in:
-`src/vnet/session-apps/echo_client.c`: Test client using the internal API
-`src/vnet/session-apps/echoo_server.c`: Test server using the internal API
-`src/tests/vnet/session/quic_echo.c`: Client and server, using the external API
-