doc/man3/SSL_get_all_async_fds.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_waiting_for_async,
   6 SSL_get_all_async_fds,
   7 SSL_get_changed_async_fds
   8 - manage asynchronous operations
   9
  10 =head1 SYNOPSIS
  11
  12 =for comment multiple includes
  13
  14  #include <openssl/async.h>
  15  #include <openssl/ssl.h>
  16
  17  int SSL_waiting_for_async(SSL *s);
  18  int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fd, size_t *numfds);
  19  int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd, size_t *numaddfds,
  20                                OSSL_ASYNC_FD *delfd, size_t *numdelfds);
  21
  22 =head1 DESCRIPTION
  23
  24 SSL_waiting_for_async() determines whether an SSL connection is currently
  25 waiting for asynchronous operations to complete (see the SSL_MODE_ASYNC mode in
  26 L<SSL_CTX_set_mode(3)>).
  27
  28 SSL_get_all_async_fds() returns a list of file descriptor which can be used in a
  29 call to select() or poll() to determine whether the current asynchronous
  30 operation has completed or not. A completed operation will result in data
  31 appearing as "read ready" on the file descriptor (no actual data should be read
  32 from the file descriptor). This function should only be called if the SSL object
  33 is currently waiting for asynchronous work to complete (i.e.
  34 SSL_ERROR_WANT_ASYNC has been received - see L<SSL_get_error(3)>). Typically the
  35 list will only contain one file descriptor. However if multiple asynchronous
  36 capable engines are in use then more than one is possible. The number of file
  37 descriptors returned is stored in B<*numfds> and the file descriptors themselves
  38 are in B<*fds>. The B<fds> parameter may be NULL in which case no file
  39 descriptors are returned but B<*numfds> is still populated. It is the callers
  40 responsibility to ensure sufficient memory is allocated at B<*fds> so typically
  41 this function is called twice (once with a NULL B<fds> parameter and once
  42 without).
  43
  44 SSL_get_changed_async_fds() returns a list of the asynchronous file descriptors
  45 that have been added and a list that have been deleted since the last
  46 SSL_ERROR_WANT_ASYNC was received (or since the SSL object was created if no
  47 SSL_ERROR_WANT_ASYNC has been received). Similar to SSL_get_all_async_fds() it
  48 is the callers responsibility to ensure that B<*addfd> and B<*delfd> have
  49 sufficient memory allocated, although they may be NULL. The number of added fds
  50 and the number of deleted fds are stored in B<*numaddfds> and B<*numdelfds>
  51 respectively.
  52
  53 =head1 RETURN VALUES
  54
  55 SSL_waiting_for_async() will return 1 if the current SSL operation is waiting
  56 for an async operation to complete and 0 otherwise.
  57
  58 SSL_get_all_async_fds() and SSL_get_changed_async_fds() return 1 on success or
  59 0 on error.
  60
  61 =head1 NOTES
  62
  63 On Windows platforms the openssl/async.h header is dependent on some
  64 of the types customarily made available by including windows.h. The
  65 application developer is likely to require control over when the latter
  66 is included, commonly as one of the first included headers. Therefore
  67 it is defined as an application developer's responsibility to include
  68 windows.h prior to async.h.
  69
  70 =head1 SEE ALSO
  71
  72 L<SSL_get_error(3)>, L<SSL_CTX_set_mode(3)>
  73
  74 =head1 HISTORY
  75
  76 SSL_waiting_for_async(), SSL_get_all_async_fds() and SSL_get_changed_async_fds()
  77 were first added to OpenSSL 1.1.0.
  78
  79 =head1 COPYRIGHT
  80
  81 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  82
  83 Licensed under the OpenSSL license (the "License").  You may not use
  84 this file except in compliance with the License.  You can obtain a copy
  85 in the file LICENSE in the source distribution or at
  86 L<https://www.openssl.org/source/license.html>.
  87
  88 =cut