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