From 6259978aef726402104ab0950b8f460bf3d27331 Mon Sep 17 00:00:00 2001 From: David Woodhouse Date: Fri, 29 Jun 2012 22:08:24 +0100 Subject: [PATCH] Fix documentation for gnutls_dtls_set_mtu() It *isn't* the interface MTU, it's the transport MTU. Signed-off-by: Nikos Mavrogiannopoulos --- lib/gnutls_dtls.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/gnutls_dtls.c b/lib/gnutls_dtls.c index e798b27cc..bd3c6371d 100644 --- a/lib/gnutls_dtls.c +++ b/lib/gnutls_dtls.c @@ -570,10 +570,13 @@ void gnutls_dtls_set_timeouts (gnutls_session_t session, unsigned int retrans_ti /** * gnutls_dtls_set_mtu: * @session: is a #gnutls_session_t structure. - * @mtu: The maximum transfer unit of the interface + * @mtu: The maximum transfer unit of the transport * - * This function will set the maximum transfer unit of the interface - * that DTLS packets are expected to leave from. + * This function will set the maximum transfer unit of the transport + * that DTLS packets are sent over. Note that this should exclude + * the IP (or IPv6) and UDP headers. So for DTLS over IPv6 on an + * Ethenet device with MTU 1500, the DTLS MTU set with this function + * would be 1500 - 40 (IPV6 header) - 8 (UDP header) = 1452. * * Since: 3.0 **/ -- 2.11.4.GIT