QUIC DEMUX, QRX: Add deprecation notices for future handling

Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from #22674)
openssl · Dec 21, 2023 · 08c7cae · 08c7cae
1 parent 52dfe6f
commit 08c7cae
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/include/internal/quic_demux.h b/include/internal/quic_demux.h
@@ -243,6 +243,9 @@ int ossl_quic_demux_set_mtu(QUIC_DEMUX *demux, unsigned int mtu);
  * Only one handler can be set for a given connection ID. If a handler is
  * already set for the given connection ID, returns 0.
  *
+ * TODO(QUIC SERVER): DEPRECATED in favour of explicit routing by QUIC_PORT with
+ * reference to QUIC_LCIDM. To be removed.
+ *
  * Returns 1 on success or 0 on failure.
  */
 int ossl_quic_demux_register(QUIC_DEMUX *demux,
@@ -254,6 +257,9 @@ int ossl_quic_demux_register(QUIC_DEMUX *demux,
  * Unregisters any datagram handler callback set for the given connection ID.
  * Fails if no handler is registered for the given connection ID.
  *
+ * TODO(QUIC SERVER): DEPRECATED in favour of explicit routing by QUIC_PORT with
+ * reference to QUIC_LCIDM. To be removed.
+ *
  * Returns 1 on success or 0 on failure.
  */
 int ossl_quic_demux_unregister(QUIC_DEMUX *demux,
@@ -263,6 +269,9 @@ int ossl_quic_demux_unregister(QUIC_DEMUX *demux,
  * Unregisters any datagram handler callback from all connection IDs it is used
  * for. cb and cb_arg must both match the values passed to
  * ossl_quic_demux_register.
+ *
+ * TODO(QUIC SERVER): DEPRECATED in favour of explicit routing by QUIC_PORT with
+ * reference to QUIC_LCIDM. To be removed.
  */
 void ossl_quic_demux_unregister_by_cb(QUIC_DEMUX *demux,
                                       ossl_quic_demux_cb_fn *cb,
@@ -277,6 +286,11 @@ void ossl_quic_demux_unregister_by_cb(QUIC_DEMUX *demux,
  * The handler is responsible for ensuring that ossl_quic_demux_reinject_urxe or
  * ossl_quic_demux_release_urxe is called on the passed packet at some point in
  * the future, which may or may not be before the handler returns.
+ *
+ * TODO(QUIC SERVER): In the future all RX handling will go via this function
+ * and the QUIC_PORT will be responsible for routing. DEMUX will then handle
+ * URXE memory management and datagram DCID parsing only. The MVP LCID routing
+ * functionality of the DEMUX will be removed in favour of LCIDM.
  */
 void ossl_quic_demux_set_default_handler(QUIC_DEMUX *demux,
                                          ossl_quic_demux_cb_fn *cb,

diff --git a/include/internal/quic_record_rx.h b/include/internal/quic_record_rx.h
@@ -79,6 +79,9 @@ void ossl_qrx_set_msg_callback_arg(OSSL_QRX *qrx,
  * input to this function. This function fails if the DCID is already
  * registered.
  *
+ * TODO(QUIC SERVER): DEPRECATED in favour of explicit routing by QUIC_PORT with
+ * reference to QUIC_LCIDM. To be removed.
+ *
  * Returns 1 on success or 0 on error.
  */
 int ossl_qrx_add_dst_conn_id(OSSL_QRX *qrx,
@@ -89,6 +92,9 @@ int ossl_qrx_add_dst_conn_id(OSSL_QRX *qrx,
  * is unregistered from the demuxer. Fails if the DCID is not registered with
  * the demuxer.
  *
+ * TODO(QUIC SERVER): DEPRECATED in favour of explicit routing by QUIC_PORT with
+ * reference to QUIC_LCIDM. To be removed.
+ *
  * Returns 1 on success or 0 on error.
  */
 int ossl_qrx_remove_dst_conn_id(OSSL_QRX *qrx,