doc/manpages/gnutls_ia_recv.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_ia_recv" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_ia_recv \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/extra.h>
   7 .sp
   8 .BI "ssize_t gnutls_ia_recv(gnutls_session_t " session ", char * " data ", size_t " sizeofdata ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "char * data" 12
  13 the buffer that the data will be read into, must hold >= 12 bytes.
  14 .IP "size_t sizeofdata" 12
  15 the number of requested bytes, must be >= 12.
  16 .SH "DESCRIPTION"
  17 Receive TLS/IA data.  This function has the similar semantics with
  18 \fBrecv()\fP.  The only difference is that it accepts a GnuTLS session,
  19 and uses different error codes.
  20
  21 If the server attempt to finish an application phase, this function
  22 will return \fBGNUTLS_E_WARNING_IA_IPHF_RECEIVED\fP or
  23 \fBGNUTLS_E_WARNING_IA_FPHF_RECEIVED\fP.  The caller should then invoke
  24 \fBgnutls_ia_verify_endphase()\fP, and if it runs the client side, also
  25 send an endphase message of its own using gnutls_ia_endphase_send.
  26
  27 If EINTR is returned by the internal push function (the default is
  28 \fIcode\fP{\fBrecv()\fP}) then GNUTLS_E_INTERRUPTED will be returned.  If
  29 GNUTLS_E_INTERRUPTED or GNUTLS_E_AGAIN is returned, you must call
  30 this function again, with the same parameters; alternatively you
  31 could provide a NULL pointer for data, and 0 for size.
  32 .SH "RETURNS"
  33 The number of bytes received.  A negative error code is
  34 returned in case of an error.  The
  35 \fBGNUTLS_E_WARNING_IA_IPHF_RECEIVED\fP and
  36 \fBGNUTLS_E_WARNING_IA_FPHF_RECEIVED\fP errors are returned when an
  37 application phase finished message has been sent by the server.
  38 .SH "REPORTING BUGS"
  39 Report bugs to <bug-gnutls@gnu.org>.
  40 GnuTLS home page: http://www.gnu.org/software/gnutls/
  41 General help using GNU software: http://www.gnu.org/gethelp/
  42 .SH COPYRIGHT
  43 Copyright \(co 2008 Free Software Foundation.
  44 .br
  45 Copying and distribution of this file, with or without modification,
  46 are permitted in any medium without royalty provided the copyright
  47 notice and this notice are preserved.
  48 .SH "SEE ALSO"
  49 The full documentation for
  50 .B gnutls
  51 is maintained as a Texinfo manual.  If the
  52 .B info
  53 and
  54 .B gnutls
  55 programs are properly installed at your site, the command
  56 .IP
  57 .B info gnutls
  58 .PP
  59 should give you access to the complete manual.