doc/manpages/gnutls_session_set_data.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_session_set_data" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_session_set_data \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_session_set_data(gnutls_session_t " session ", const void * " session_data ", size_t " session_data_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "const void * session_data" 12
  13 is a pointer to space to hold the session.
  14 .IP "size_t session_data_size" 12
  15 is the session's size
  16 .SH "DESCRIPTION"
  17 Sets all session parameters, in order to resume a previously
  18 established session.  The session data given must be the one
  19 returned by \fBgnutls_session_get_data()\fP.  This function should be
  20 called before \fBgnutls_handshake()\fP.
  21
  22 Keep in mind that session resuming is advisory. The server may
  23 choose not to resume the session, thus a full handshake will be
  24 performed.
  25 .SH "RETURNS"
  26 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise
  27 an error code is returned.
  28 .SH "REPORTING BUGS"
  29 Report bugs to <bug-gnutls@gnu.org>.
  30 GnuTLS home page: http://www.gnu.org/software/gnutls/
  31 General help using GNU software: http://www.gnu.org/gethelp/
  32 .SH COPYRIGHT
  33 Copyright \(co 2008 Free Software Foundation.
  34 .br
  35 Copying and distribution of this file, with or without modification,
  36 are permitted in any medium without royalty provided the copyright
  37 notice and this notice are preserved.
  38 .SH "SEE ALSO"
  39 The full documentation for
  40 .B gnutls
  41 is maintained as a Texinfo manual.  If the
  42 .B info
  43 and
  44 .B gnutls
  45 programs are properly installed at your site, the command
  46 .IP
  47 .B info gnutls
  48 .PP
  49 should give you access to the complete manual.