Latest update.
This commit is contained in:
+29
-2
@@ -2,12 +2,13 @@
|
||||
|
||||
=head1 NAME
|
||||
|
||||
SSL_write_ex, SSL_write - write bytes to a TLS/SSL connection
|
||||
SSL_write_ex, SSL_write, SSL_sendfile - write bytes to a TLS/SSL connection
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
#include <openssl/ssl.h>
|
||||
|
||||
ossl_ssize_t SSL_sendfile(SSL *s, int fd, off_t offset, size_t size, int flags);
|
||||
int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written);
|
||||
int SSL_write(SSL *ssl, const void *buf, int num);
|
||||
|
||||
@@ -17,6 +18,14 @@ SSL_write_ex() and SSL_write() write B<num> bytes from the buffer B<buf> into
|
||||
the specified B<ssl> connection. On success SSL_write_ex() will store the number
|
||||
of bytes written in B<*written>.
|
||||
|
||||
SSL_sendfile() writes B<size> bytes from offset B<offset> in the file
|
||||
descriptor B<fd> to the specified SSL connection B<s>. This function provides
|
||||
efficient zero-copy semantics. SSL_sendfile() is available only when
|
||||
Kernel TLS is enabled, which can be checked by calling BIO_get_ktls_send().
|
||||
It is provided here to allow users to maintain the same interface.
|
||||
The meaning of B<flags> is platform dependent.
|
||||
Currently, under Linux it is ignored.
|
||||
|
||||
=head1 NOTES
|
||||
|
||||
In the paragraphs below a "write function" is defined as one of either
|
||||
@@ -104,17 +113,35 @@ You should instead call SSL_get_error() to find out if it's retryable.
|
||||
|
||||
=back
|
||||
|
||||
For SSL_sendfile(), the following return values can occur:
|
||||
|
||||
=over 4
|
||||
|
||||
=item Z<>>= 0
|
||||
|
||||
The write operation was successful, the return value is the number
|
||||
of bytes of the file written to the TLS/SSL connection.
|
||||
|
||||
=item E<lt> 0
|
||||
|
||||
The write operation was not successful, because either the connection was
|
||||
closed, an error occured or action must be taken by the calling process.
|
||||
Call SSL_get_error() with the return value to find out the reason.
|
||||
|
||||
=back
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<SSL_get_error(3)>, L<SSL_read_ex(3)>, L<SSL_read(3)>
|
||||
L<SSL_CTX_set_mode(3)>, L<SSL_CTX_new(3)>,
|
||||
L<SSL_connect(3)>, L<SSL_accept(3)>
|
||||
L<SSL_set_connect_state(3)>,
|
||||
L<SSL_set_connect_state(3)>, L<BIO_ctrl(3)>,
|
||||
L<ssl(7)>, L<bio(7)>
|
||||
|
||||
=head1 HISTORY
|
||||
|
||||
The SSL_write_ex() function was added in OpenSSL 1.1.1.
|
||||
The SSL_sendfile() function was added in OpenSSL 3.0.0.
|
||||
|
||||
=head1 COPYRIGHT
|
||||
|
||||
|
||||
Reference in New Issue
Block a user