xref: /freebsd/crypto/openssl/doc/man3/DTLS_get_data_mtu.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1e71b7053SJung-uk Kim=pod
2e71b7053SJung-uk Kim
3e71b7053SJung-uk Kim=head1 NAME
4e71b7053SJung-uk Kim
5e71b7053SJung-uk KimDTLS_get_data_mtu - Get maximum data payload size
6e71b7053SJung-uk Kim
7e71b7053SJung-uk Kim=head1 SYNOPSIS
8e71b7053SJung-uk Kim
9e71b7053SJung-uk Kim #include <openssl/ssl.h>
10e71b7053SJung-uk Kim
11e71b7053SJung-uk Kim size_t DTLS_get_data_mtu(const SSL *ssl);
12e71b7053SJung-uk Kim
13e71b7053SJung-uk Kim=head1 DESCRIPTION
14e71b7053SJung-uk Kim
15e71b7053SJung-uk KimThis function obtains the maximum data payload size for the established
16e71b7053SJung-uk KimDTLS connection B<ssl>, based on the DTLS record MTU and the overhead
17e71b7053SJung-uk Kimof the DTLS record header, encryption and authentication currently in use.
18e71b7053SJung-uk Kim
19e71b7053SJung-uk Kim=head1 RETURN VALUES
20e71b7053SJung-uk Kim
21e71b7053SJung-uk KimReturns the maximum data payload size on success, or 0 on failure.
22e71b7053SJung-uk Kim
23e71b7053SJung-uk Kim=head1 HISTORY
24e71b7053SJung-uk Kim
256935a639SJung-uk KimThe DTLS_get_data_mtu() function was added in OpenSSL 1.1.1.
26e71b7053SJung-uk Kim
27e71b7053SJung-uk Kim=head1 COPYRIGHT
28e71b7053SJung-uk Kim
29e71b7053SJung-uk KimCopyright 2016 The OpenSSL Project Authors. All Rights Reserved.
30e71b7053SJung-uk Kim
31*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
32e71b7053SJung-uk Kimthis file except in compliance with the License.  You can obtain a copy
33e71b7053SJung-uk Kimin the file LICENSE in the source distribution or at
34e71b7053SJung-uk KimL<https://www.openssl.org/source/license.html>.
35e71b7053SJung-uk Kim
36e71b7053SJung-uk Kim=cut
37