Blame doc/manpages/gnutls_dtls_set_data_mtu.3

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