QUIC LCIDM: Correct documentation
authorHugo Landau <hlandau@openssl.org>
Wed, 8 Nov 2023 16:57:41 +0000 (16:57 +0000)
committerHugo Landau <hlandau@openssl.org>
Wed, 6 Dec 2023 10:40:11 +0000 (10:40 +0000)
Reviewed-by: Neil Horman <nhorman@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22673)

include/internal/quic_lcidm.h

index e39f3647175d5509c514eb8d7fe511cde4f7851a..e01ac80f9e7d735104d4953fe2e76f1da9439b26 100644 (file)
@@ -34,7 +34,7 @@
  * LCIDs fall into three categories:
  *
  *   1. A client's Initial ODCID                       (1)
- *   2. A server's Initial SCID                        (1)
+ *   2. Our local Initial SCID                         (1)
  *   3. A CID issued via a NEW_CONNECTION_ID frame     (n)
  *   4. A server's Retry SCID                          (0..1)
  *
  * ODCID. There is never more than one of these, and no sequence number is
  * associated with this temporary LCID.
  *
- * (2) is created when a server responds to a new connection request, and is
- * generated by the server as the preferred DCID for traffic directed towards
- * it. A client should switch to using this as soon as it receives a valid
- * packet from the server. This LCID has a sequence number of 0.
+ * (2) is created by a client when it begins connecting, or by a server when it
+ * responds to a new connection request. In the latter case, it is generated by
+ * the server as the preferred DCID for traffic directed towards it. A client
+ * should switch to using this as a RCID as soon as it receives a valid packet
+ * from the server. This LCID has a sequence number of 0.
  *
  * (3) is created when we issue a NEW_CONNECTION_ID frame. Arbitrarily many of
  * these can exist.