]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
QUIC: Update glossary
authorHugo Landau <hlandau@openssl.org>
Thu, 18 Jan 2024 10:24:22 +0000 (10:24 +0000)
committerViktor Dukhovni <openssl-users@dukhovni.org>
Wed, 11 Sep 2024 07:32:28 +0000 (17:32 +1000)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21795)

doc/designs/quic-design/glossary.md

index 831890d38200624fee88b6ae0e545f5f57fc024a..a295483b2642e1c61129f3335f58a5753bf2fe9a 100644 (file)
@@ -56,6 +56,11 @@ dispatches calls to libssl public APIs to the APL.
 
 **Engine:** See `QUIC_ENGINE`.
 
+**Event Leader:** The QSO which is is the top-level QSO in a hierarchy of QSOs,
+and which is responsible for event processing for all QSOs in that hierarchy.
+This may be a QLSO or QCSO. See [the server API
+design](server/quic-server-api.md).
+
 **FC:** Flow control. Comprises TXFC and RXFC.
 
 **FIFD:** Frame-in-flight dispatcher. Ties together the CFQ and TXPIM to handle
@@ -143,17 +148,35 @@ Initial packets. It is only used temporarily.
 
 **Port:** See `QUIC_PORT`.
 
+**Port Leader:** The QSO which is responsible for servicing a given UDP socket.
+This may be a QCSO or a QLSO. See [the server API design](server/quic-server-api.md).
+
 **PTO:** Probe timeout. See RFC 9000.
 
 **QC:** See `QUIC_CONNECTION`.
 
 **QCSO:** QUIC Connection SSL Object. This is an SSL object created using
-`SSL_new` using a QUIC method.
+`SSL_new` using a QUIC method, or by a QLSO.
 
 **QCTX**: QUIC Context. This is a utility object defined within the QUIC APL
 which helps to unwrap a SSL object pointer (a QCSO or QSSO) into the relevant
 structure pointers such as `QUIC_CONNECTION` or `QUIC_XSO`.
 
+**QL:** See `QUIC_LISTENER`.
+
+**QLSO:** QUIC Listener SSL Object. An object created to represent a socket
+which can accept one or more incoming QUIC connections and/or make multiple
+outgoing QUIC connections. Parent of zero or more QCSOs.
+
+**QUIC_LISTENER:** QUIC listener. This is the APL object representing a QUIC
+listener (QLSO) in the APL.
+
+**QP:** See `QUIC_PORT`.
+
+**QUIC_PORT:** Internal object owning the network socket BIO which services a
+QLSO. This is the QUIC core object corresponding to the APL's `QUIC_LISTENER`
+object (a QLSO). Owns zero more `QUIC_CHANNEL` instances.
+
 **QRL:** QUIC record layer. Refers collectively to the QRX and QTX.
 
 **QRX:** QUIC Record Layer RX. Receives incoming datagrams and decrypts the
@@ -165,7 +188,7 @@ processing by upper layers.
 **QSM:** QUIC Streams Mapper. Manages internal `QUIC_STREAM` objects and maps
 IDs to those objects. Allows iteration of active streams.
 
-**QSO:** QUIC SSL Object. May be a QCSO or a QSSO.
+**QSO:** QUIC SSL Object. May be a QLSO, QCSO or QSSO.
 
 **QSSO:** QUIC Stream SSL Object. This is an SSL object which is subsidiary to a
 given QCSO, obtained using (for example) `SSL_new_stream` or