mirror of
https://github.com/openssl/openssl.git
synced 2024-12-03 05:41:46 +08:00
fc5ecaddd0
While stereotyped repetitions are frowned upon in literature, they serve a useful purpose in manual pages, because it is easier for the user to find certain information if it is always presented in the same way. For that reason, this commit harmonizes the varying formulations in the HISTORY section about which functions, flags, etc. were added in which OpenSSL version. It also attempts to make the pod files more grep friendly by avoiding to insert line breaks between the symbol names and the corresponding version number in which they were introduced (wherever possible). Some punctuation and typographical errors were fixed on the way. Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7854)
37 lines
899 B
Plaintext
37 lines
899 B
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
DTLS_get_data_mtu - Get maximum data payload size
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
size_t DTLS_get_data_mtu(const SSL *ssl);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This function obtains the maximum data payload size for the established
|
|
DTLS connection B<ssl>, based on the DTLS record MTU and the overhead
|
|
of the DTLS record header, encryption and authentication currently in use.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
Returns the maximum data payload size on success, or 0 on failure.
|
|
|
|
=head1 HISTORY
|
|
|
|
The DTLS_get_data_mtu() function was added in OpenSSL 1.1.1.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|