| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | DTLS_get_data_mtu - Get maximum data payload size
|
|---|
| 6 |
|
|---|
| 7 | =head1 SYNOPSIS
|
|---|
| 8 |
|
|---|
| 9 | #include <openssl/ssl.h>
|
|---|
| 10 |
|
|---|
| 11 | size_t DTLS_get_data_mtu(const SSL *ssl);
|
|---|
| 12 |
|
|---|
| 13 | =head1 DESCRIPTION
|
|---|
| 14 |
|
|---|
| 15 | This function obtains the maximum data payload size for the established
|
|---|
| 16 | DTLS connection B<ssl>, based on the DTLS record MTU and the overhead
|
|---|
| 17 | of the DTLS record header, encryption and authentication currently in use.
|
|---|
| 18 |
|
|---|
| 19 | =head1 RETURN VALUES
|
|---|
| 20 |
|
|---|
| 21 | Returns the maximum data payload size on success, or 0 on failure.
|
|---|
| 22 |
|
|---|
| 23 | =head1 HISTORY
|
|---|
| 24 |
|
|---|
| 25 | The DTLS_get_data_mtu() function was added in OpenSSL 1.1.1.
|
|---|
| 26 |
|
|---|
| 27 | =head1 COPYRIGHT
|
|---|
| 28 |
|
|---|
| 29 | Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 30 |
|
|---|
| 31 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 32 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 33 | in the file LICENSE in the source distribution or at
|
|---|
| 34 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 35 |
|
|---|
| 36 | =cut
|
|---|
