doc/manpages/gnutls_record_set_max_size.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_record_set_max_size" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_record_set_max_size \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "ssize_t gnutls_record_set_max_size(gnutls_session_t " session ", size_t " size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "size_t size" 12
  13 is the new size
  14 .SH "DESCRIPTION"
  15 This function sets the maximum record packet size in this
  16 connection.  This property can only be set to clients.  The server
  17 may choose not to accept the requested size.
  18
  19 Acceptable values are 512(=2^9), 1024(=2^10), 2048(=2^11) and
  20 4096(=2^12).  The requested record size does get in effect
  21 immediately only while sending data. The receive part will take
  22 effect after a successful handshake.
  23
  24 This function uses a TLS extension called 'max record size'.  Not
  25 all TLS implementations use or even understand this extension.
  26 .SH "RETURNS"
  27 On success, \fBGNUTLS_E_SUCCESS\fP (zero) is returned,
  28 otherwise an error code is returned.
  29 .SH "REPORTING BUGS"
  30 Report bugs to <bug-gnutls@gnu.org>.
  31 GnuTLS home page: http://www.gnu.org/software/gnutls/
  32 General help using GNU software: http://www.gnu.org/gethelp/
  33 .SH COPYRIGHT
  34 Copyright \(co 2008 Free Software Foundation.
  35 .br
  36 Copying and distribution of this file, with or without modification,
  37 are permitted in any medium without royalty provided the copyright
  38 notice and this notice are preserved.
  39 .SH "SEE ALSO"
  40 The full documentation for
  41 .B gnutls
  42 is maintained as a Texinfo manual.  If the
  43 .B info
  44 and
  45 .B gnutls
  46 programs are properly installed at your site, the command
  47 .IP
  48 .B info gnutls
  49 .PP
  50 should give you access to the complete manual.