xref: /freebsd/secure/lib/libcrypto/man/man3/DTLS_get_data_mtu.3 (revision b5daf675efc746611c7cfcd1fa474b8905064c4b)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "DTLS_GET_DATA_MTU 3ossl"
DTLS_GET_DATA_MTU 3ossl 2025-07-01 3.5.1 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
DTLS_get_data_mtu - Get maximum data payload size
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& size_t DTLS_get_data_mtu(const SSL *ssl); .Ve
DESCRIPTION
Header "DESCRIPTION" This function obtains the maximum data payload size for the established DTLS connection ssl, based on the DTLS record MTU and the overhead of the DTLS record header, encryption and authentication currently in use.
"RETURN VALUES"
Header "RETURN VALUES" Returns the maximum data payload size on success, or 0 on failure.
HISTORY
Header "HISTORY" The DTLS_get_data_mtu() function was added in OpenSSL 1.1.1.
COPYRIGHT
Header "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 <https://www.openssl.org/source/license.html>.