doc/ssl/SSL_read.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_read - read bytes from a TLS/SSL connection.
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  int SSL_read(SSL *ssl, char *buf, int num);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_read() tries to read B<num> bytes from the specified B<ssl> into the
  16 buffer B<buf>.
  17
  18 =head1 NOTES
  19
  20 If necessary, SSL_read() will negotiate a TLS/SSL session, if
  21 not already explicitly performed by SSL_connect() or SSL_accept(). If the
  22 peer requests a re-negotiation, it will be performed transparently during
  23 the SSL_read() operation. The behaviour of SSL_read() depends on the
  24 underlying BIO.
  25
  26 If the underlying BIO is B<blocking>, SSL_read() will only return, once the
  27 read operation has been finished or an error occurred.
  28
  29 If the underlying BIO is B<non-blocking>, SSL_read() will also return
  30 when the underlying BIO could not satisfy the needs of SSL_read()
  31 to continue the operation. In this case a call to SSL_get_error() with the
  32 return value of SSL_read() will yield B<SSL_ERROR_WANT_READ> or
  33 B<SSL_ERROR_WANT_WRITE>. As at any time a re-negotiation is possible, a
  34 call to SSL_read() can also cause write operations! The calling process
  35 then must repeat the call after taking appropriate action to satisfy the
  36 needs of SSL_read(). The action depends on the underlying BIO. When using a
  37 non-blocking socket, nothing is to be done, but select() can be used to check
  38 for the required condition. When using a buffering BIO, like a BIO pair, data
  39 must be written into or retrieved out of the BIO before being able to continue.
  40
  41 =head1 WARNING
  42
  43 When an SSL_read() operation has to be repeated because of
  44 B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
  45 with the same arguments.
  46
  47 =head1 RETURN VALUES
  48
  49 The following return values can occur:
  50
  51 =over 4
  52
  53 =item E<gt>0
  54
  55 The read operation was successful; the return value is the number of
  56 bytes actually read from the TLS/SSL connection.
  57
  58 =item 0
  59
  60 The read operation was not successful, probably because no data was
  61 available. Call SSL_get_error() with the return value B<ret> to find out,
  62 whether an error occurred.
  63
  64 =item E<lt>0
  65
  66 The read operation was not successful, because either an error occurred
  67 or action must be taken by the calling process. Call SSL_get_error() with the
  68 return value B<ret> to find out the reason.
  69
  70 =back
  71
  72 =head1 SEE ALSO
  73
  74 L<SSL_get_error(3)|SSL_get_error(3)>, L<SSL_write(3)|SSL_write(3)>,
  75 L<ssl(3)|ssl(3)>, L<bio(3)|bio(3)>
  76
  77 =cut