Index for Section 3

Alphabetical listing for S

Bottom of page

SSL_rstate_string(3)
NAME
  SSL_rstate_string, SSL_rstate_string_long - Get textual description of
  state of an SSL object during read operation

SYNOPSIS
  #include <openssl/ssl.h>

  char *SSL_rstate_string(
	  SSL *ssl );

  char *SSL_rstate_string_long(
	  SSL *ssl );

DESCRIPTION
  The SSL_rstate_string() function returns a 2 letter string indicating the
  current read state of the SSL object ssl.

  The SSL_rstate_string_long() function returns a string indicating the
  current read state of the SSL object ssl.

NOTES
  When performing a read operation, the SSL/TLS engine must parse the record,
  consisting of header and body. When working in a blocking environment,
  SSL_rstate_string[_long]() should always return ``RD''/"read done." This
  function is seldom needed.

RETURN VALUES
  The SSL_rstate_string() and SSL_rstate_string_long() functions can return
  the following values:

  RH (read header)
	  The header of the record is being evaluated.

  RB (read body)
	  The body of the record is being evaluated.

  RD (read done)
	  The record has been completely processed.

  unknown The read state is unknown. This should never happen.

SEE ALSO
  Functions: ssl(3)

Index for Section 3

Alphabetical listing for S

Top of page