Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_handshake_set_max_packet_length.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_handshake_set_max_packet_length" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_handshake_set_max_packet_length \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "void gnutls_handshake_set_max_packet_length(gnutls_session_t " session ", size_t " max ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a \fBgnutls_session_t\fP structure.
12 .IP "size_t max" 12
13 is the maximum number.
14 .SH "DESCRIPTION"
15 This function will set the maximum size of all handshake messages.
16 Handshakes over this size are rejected with
17 \fBGNUTLS_E_HANDSHAKE_TOO_LARGE\fP error code.  The default value is
18 48kb which is typically large enough.  Set this to 0 if you do not
19 want to set an upper limit.
20
21 The reason for restricting the handshake message sizes are to
22 limit Denial of Service attacks.
23 .SH "REPORTING BUGS"
24 Report bugs to <bug-gnutls@gnu.org>.
25 GnuTLS home page: http://www.gnu.org/software/gnutls/
26 General help using GNU software: http://www.gnu.org/gethelp/
27 .SH COPYRIGHT
28 Copyright \(co 2008 Free Software Foundation.
29 .br
30 Copying and distribution of this file, with or without modification,
31 are permitted in any medium without royalty provided the copyright
32 notice and this notice are preserved.
33 .SH "SEE ALSO"
34 The full documentation for
35 .B gnutls
36 is maintained as a Texinfo manual.  If the
37 .B info
38 and
39 .B gnutls
40 programs are properly installed at your site, the command
41 .IP
42 .B info gnutls
43 .PP
44 should give you access to the complete manual.