]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc/man3/SSL_poll.pod: mention SSL_POLL_EVENT_{EL,IC} in SYNOPSIS
authorEugene Syromiatnikov <esyr@openssl.org>
Tue, 19 Aug 2025 13:27:39 +0000 (15:27 +0200)
committerNeil Horman <nhorman@openssl.org>
Fri, 29 Aug 2025 13:34:31 +0000 (09:34 -0400)
While the constants are present since the initial commit 2a5ee0a08d2c "QUIC:
Add polling API", they weren't initially documented in c9b0df2250e2 "QUIC:
Add manpage for SSL_poll" (probably due to absence of the QUIC server
mode support at the time), and mentioned for the first time in b20f55702100
"QUIC: Update SSL_poll documentation", but without the accompanying update
of the SYNOPSIS section.  Rescind the omission by updating it as well.

Complements: b20f55702100 "QUIC: Update SSL_poll documentation"
Signed-off-by: Eugene Syromiatnikov <esyr@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Paul Yang <paulyang.inf@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/28303)

(cherry picked from commit b930ea87dfc49195a5572cb2f699545d5777dee0)

doc/man3/SSL_poll.pod

index 87a1e42b17200d518d53c94f929ee57656ea8355..6047bd6750f8f6aefa7fe1f754ace806e436ce2e 100644 (file)
@@ -5,12 +5,14 @@
 SSL_poll,
 SSL_POLL_EVENT_NONE,
 SSL_POLL_EVENT_F,
+SSL_POLL_EVENT_EL,
 SSL_POLL_EVENT_EC,
 SSL_POLL_EVENT_ECD,
 SSL_POLL_EVENT_ER,
 SSL_POLL_EVENT_EW,
 SSL_POLL_EVENT_R,
 SSL_POLL_EVENT_W,
+SSL_POLL_EVENT_IC,
 SSL_POLL_EVENT_ISB,
 SSL_POLL_EVENT_ISU,
 SSL_POLL_EVENT_OSB,
@@ -35,27 +37,29 @@ SSL_POLL_FLAG_NO_HANDLE_EVENTS
  #define SSL_POLL_EVENT_NONE        0
 
  #define SSL_POLL_EVENT_F           /* F   (Failure) */
+ #define SSL_POLL_EVENT_EL          /* EL  (Exception on Listener) */
  #define SSL_POLL_EVENT_EC          /* EC  (Exception on Conn) */
  #define SSL_POLL_EVENT_ECD         /* ECD (Exception on Conn Drained) */
  #define SSL_POLL_EVENT_ER          /* ER  (Exception on Read) */
  #define SSL_POLL_EVENT_EW          /* EW  (Exception on Write) */
  #define SSL_POLL_EVENT_R           /* R   (Readable) */
  #define SSL_POLL_EVENT_W           /* W   (Writable) */
+ #define SSL_POLL_EVENT_IC          /* IC  (Incoming Connection) */
  #define SSL_POLL_EVENT_ISB         /* ISB (Incoming Stream: Bidi) */
  #define SSL_POLL_EVENT_ISU         /* ISU (Incoming Stream: Uni) */
  #define SSL_POLL_EVENT_OSB         /* OSB (Outgoing Stream: Bidi) */
  #define SSL_POLL_EVENT_OSU         /* OSU (Outgoing Stream: Uni) */
 
- #define SSL_POLL_EVENT_RW          /* R   | W         */
- #define SSL_POLL_EVENT_RE          /* R   | ER        */
- #define SSL_POLL_EVENT_WE          /* W   | EW        */
- #define SSL_POLL_EVENT_RWE         /* RE  | WE        */
- #define SSL_POLL_EVENT_E           /* EC  | ER  | EW  */
- #define SSL_POLL_EVENT_IS          /* ISB | ISU       */
- #define SSL_POLL_EVENT_ISE         /* IS  | EC        */
- #define SSL_POLL_EVENT_I           /* IS              */
- #define SSL_POLL_EVENT_OS          /* OSB | OSU       */
- #define SSL_POLL_EVENT_OSE         /* OS  | EC        */
+ #define SSL_POLL_EVENT_RW          /* R   | W               */
+ #define SSL_POLL_EVENT_RE          /* R   | ER              */
+ #define SSL_POLL_EVENT_WE          /* W   | EW              */
+ #define SSL_POLL_EVENT_RWE         /* RE  | WE              */
+ #define SSL_POLL_EVENT_E           /* EL  | EC  | ER  | EW  */
+ #define SSL_POLL_EVENT_IS          /* ISB | ISU             */
+ #define SSL_POLL_EVENT_ISE         /* IS  | EC              */
+ #define SSL_POLL_EVENT_I           /* IS                    */
+ #define SSL_POLL_EVENT_OS          /* OSB | OSU             */
+ #define SSL_POLL_EVENT_OSE         /* OS  | EC              */
 
  typedef struct ssl_poll_item_st {
      BIO_POLL_DESCRIPTOR desc;