doc/manpages/gnutls_session_get_id.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_session_get_id" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_session_get_id \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_session_get_id(gnutls_session_t " session ", void * " session_id ", size_t * " session_id_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "void * session_id" 12
  13 is a pointer to space to hold the session id.
  14 .IP "size_t * session_id_size" 12
  15 is the session id's size, or it will be set by the function.
  16 .SH "DESCRIPTION"
  17 Returns the current session id. This can be used if you want to
  18 check if the next session you tried to resume was actually
  19 resumed.  This is because resumed sessions have the same sessionID
  20 with the original session.
  21
  22 Session id is some data set by the server, that identify the
  23 current session.  In TLS 1.0 and SSL 3.0 session id is always less
  24 than 32 bytes.
  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.