|
Packit |
aea12f |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit |
aea12f |
.TH "gnutls_dtls_set_data_mtu" 3 "3.6.8" "gnutls" "gnutls"
|
|
Packit |
aea12f |
.SH NAME
|
|
Packit |
aea12f |
gnutls_dtls_set_data_mtu \- API function
|
|
Packit |
aea12f |
.SH SYNOPSIS
|
|
Packit |
aea12f |
.B #include <gnutls/dtls.h>
|
|
Packit |
aea12f |
.sp
|
|
Packit |
aea12f |
.BI "int gnutls_dtls_set_data_mtu(gnutls_session_t " session ", unsigned int " mtu ");"
|
|
Packit |
aea12f |
.SH ARGUMENTS
|
|
Packit |
aea12f |
.IP "gnutls_session_t session" 12
|
|
Packit |
aea12f |
is a \fBgnutls_session_t\fP type.
|
|
Packit |
aea12f |
.IP "unsigned int mtu" 12
|
|
Packit |
aea12f |
The maximum unencrypted transfer unit of the session
|
|
Packit |
aea12f |
.SH "DESCRIPTION"
|
|
Packit |
aea12f |
This function will set the maximum size of the *unencrypted* records
|
|
Packit |
aea12f |
which will be sent over a DTLS session. It is equivalent to calculating
|
|
Packit |
aea12f |
the DTLS packet overhead with the current encryption parameters, and
|
|
Packit |
aea12f |
calling \fBgnutls_dtls_set_mtu()\fP with that value. In particular, this means
|
|
Packit |
aea12f |
that you may need to call this function again after any negotiation or
|
|
Packit |
aea12f |
renegotiation, in order to ensure that the MTU is still sufficient to
|
|
Packit |
aea12f |
account for the new protocol overhead.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
In most cases you only need to call \fBgnutls_dtls_set_mtu()\fP with
|
|
Packit |
aea12f |
the maximum MTU of your transport layer.
|
|
Packit |
aea12f |
.SH "RETURNS"
|
|
Packit |
aea12f |
\fBGNUTLS_E_SUCCESS\fP (0) on success, or a negative error code.
|
|
Packit |
aea12f |
.SH "SINCE"
|
|
Packit |
aea12f |
3.1
|
|
Packit |
aea12f |
.SH "REPORTING BUGS"
|
|
Packit |
aea12f |
Report bugs to <bugs@gnutls.org>.
|
|
Packit |
aea12f |
.br
|
|
Packit |
aea12f |
Home page: https://www.gnutls.org
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
.SH COPYRIGHT
|
|
Packit |
aea12f |
Copyright \(co 2001-2019 Free Software Foundation, Inc., and others.
|
|
Packit |
aea12f |
.br
|
|
Packit |
aea12f |
Copying and distribution of this file, with or without modification,
|
|
Packit |
aea12f |
are permitted in any medium without royalty provided the copyright
|
|
Packit |
aea12f |
notice and this notice are preserved.
|
|
Packit |
aea12f |
.SH "SEE ALSO"
|
|
Packit |
aea12f |
The full documentation for
|
|
Packit |
aea12f |
.B gnutls
|
|
Packit |
aea12f |
is maintained as a Texinfo manual.
|
|
Packit |
aea12f |
If the /usr/share/doc/gnutls/
|
|
Packit |
aea12f |
directory does not contain the HTML form visit
|
|
Packit |
aea12f |
.B
|
|
Packit |
aea12f |
.IP https://www.gnutls.org/manual/
|
|
Packit |
aea12f |
.PP
|