doc/manpages/gnutls_record_send.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_record_send" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_record_send \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "ssize_t gnutls_record_send(gnutls_session_t " session ", const void * " data ", size_t " sizeofdata ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_session_t session" 12
  11 is a \fBgnutls_session_t\fP structure.
  12 .IP "const void * data" 12
  13 contains the data to send
  14 .IP "size_t sizeofdata" 12
  15 is the length of the data
  16 .SH "DESCRIPTION"
  17 This function has the similar semantics with \fBsend()\fP.  The only
  18 difference is that it accepts a GnuTLS session, and uses different
  19 error codes.
  20
  21 Note that if the send buffer is full, \fBsend()\fP will block this
  22 function.  See the \fBsend()\fP documentation for full information.  You
  23 can replace the default push function by using
  24 \fBgnutls_transport_set_ptr2()\fP with a call to \fBsend()\fP with a
  25 MSG_DONTWAIT flag if blocking is a problem.
  26
  27 If the EINTR is returned by the internal push function (the
  28 default is \fBsend()\fP} then \fBGNUTLS_E_INTERRUPTED\fP will be returned. If
  29 \fBGNUTLS_E_INTERRUPTED\fP or \fBGNUTLS_E_AGAIN\fP is returned, you must
  30 call this function again, with the same parameters; alternatively
  31 you could provide a \fBNULL\fP pointer for data, and 0 for
  32 size. cf. \fBgnutls_record_get_direction()\fP.
  33 .SH "RETURNS"
  34 the number of bytes sent, or a negative error code.  The
  35 number of bytes sent might be less than \fIsizeofdata\fP.  The maximum
  36 number of bytes this function can send in a single call depends
  37 on the negotiated maximum record size.
  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.