QUIC API: Rename want_net_read and want_net_write

[thirdparty/openssl.git] / doc / man3 / SSL_get_rpoll_descriptor.pod

diff --git a/doc/man3/SSL_get_rpoll_descriptor.pod b/doc/man3/SSL_get_rpoll_descriptor.pod
index 62378576f0c81ecc72de84fd292f03db6a6712b7..475aac6a44ddeb23ddc3ed95ad3fa1f3503d2347 100644 (file)
--- a/doc/man3/SSL_get_rpoll_descriptor.pod
+++ b/doc/man3/SSL_get_rpoll_descriptor.pod
@@ -2,8 +2,8 @@
 
 =head1 NAME
 
-SSL_get_rpoll_descriptor, SSL_get_wpoll_descriptor, SSL_want_net_read,
-SSL_want_net_write - obtain information which can be used to determine when
+SSL_get_rpoll_descriptor, SSL_get_wpoll_descriptor, SSL_net_read_desired,
+SSL_net_write_desired - obtain information which can be used to determine when
 network I/O can be performed
 
 =head1 SYNOPSIS
@@ -12,8 +12,8 @@ network I/O can be performed
 
  int SSL_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
  int SSL_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
- int SSL_want_net_read(SSL *s);
- int SSL_want_net_write(SSL *s);
+ int SSL_net_read_desired(SSL *s);
+ int SSL_net_write_desired(SSL *s);
 
 =head1 DESCRIPTION
 
@@ -25,13 +25,13 @@ object in nonblocking mode can determine when it should call SSL_tick().
 On success, these functions output poll descriptors. For more information on
 poll descriptors, see L<BIO_get_rpoll_descriptor(3)>.
 
-The functions SSL_want_net_read() and SSL_want_net_write() return 1 or 0
+The functions SSL_net_read_desired() and SSL_net_write_desired() return 1 or 0
 depending on whether the SSL object is currently interested in receiving data
 from the network and/or writing data to the network respectively.
 If an SSL object is not interested in reading data from the network at the
-current time, SSL_want_net_read() will return 0; likewise, if an SSL object is
+current time, SSL_net_read_desired() will return 0; likewise, if an SSL object is
 not interested in writing data to the network at the current time,
-SSL_want_net_write() will return 0.
+SSL_net_write_desired() will return 0.
 
 The intention is that an application using QUIC in nonblocking mode can use
 these calls, in conjunction with L<SSL_get_tick_timeout(3)> to wait for network
@@ -49,21 +49,21 @@ SSL_get_tick_timeout(3) (if any) expires
 
 =item *
 
-If the last call to SSL_want_net_read() returned 1, SSL_tick() should be called
+If the last call to SSL_net_read_desired() returned 1, SSL_tick() should be called
 whenever the poll descriptor output by SSL_get_rpoll_descriptor() becomes
 readable.
 
 =item *
 
-If the last call to SSL_want_net_write() returned 1, SSL_tick() should be called
+If the last call to SSL_net_write_desired() returned 1, SSL_tick() should be called
 whenever the poll descriptor output by SSL_get_wpoll_descriptor() becomes
 writable.
 
 =back
 
-The return values of the SSL_want_net_read() and SSL_want_net_write() functions
+The return values of the SSL_net_read_desired() and SSL_net_write_desired() functions
 may change in response to any call to the SSL object other than
-SSL_want_net_read(), SSL_want_net_write(), SSL_get_rpoll_descriptor(),
+SSL_net_read_desired(), SSL_net_write_desired(), SSL_get_rpoll_descriptor(),
 SSL_get_wpoll_descriptor() and SSL_get_tick_timeout().
 
 These functions are not supported on non-QUIC SSL objects.
@@ -78,8 +78,8 @@ L<SSL_tick(3)>, L<SSL_get_tick_timeout(3)>, L<ssl(7)>
 
 =head1 HISTORY
 
-The SSL_get_rpoll_descriptor(), SSL_get_wpoll_descriptor(), SSL_want_net_read()
-and SSL_want_net_write() functions were added in OpenSSL 3.2.
+The SSL_get_rpoll_descriptor(), SSL_get_wpoll_descriptor(), SSL_net_read_desired()
+and SSL_net_write_desired() functions were added in OpenSSL 3.2.
 
 =head1 COPYRIGHT